PUT /sale-return-items/{id}.json

PUT /sale-return-items/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

application/json

Body Required

  • adjustmentReasonId integer(int32) | null

    Adjustment reason

  • createdAt string(date-time)

    Created at

  • externalId string | null

    External

  • id integer(int32)

    Id

  • merchantStatus string | null Required

    Merchant status

    Values are pending, approved, or rejected. Default value is approved.

  • price number Required

    Price

    Default value is 0.

  • purchaseItemId integer(int32) | null

    Purchase item

  • quantity integer(int32) Required

    Quantity

    Default value is 0.

  • quantityCancelled integer(int32) Required

    Quantity cancelled

    Default value is 0.

  • quantityRefunded integer(int32) Required

    Quantity refunded

    Default value is 0.

  • quantityWrittenOff integer(int32) Required

    Quantity written off

    Default value is 0.

  • saleItemId integer(int32) Required

    Sale item

  • saleReturnId integer(int32) Required

    Sale return

  • updatedAt string(date-time)

    Updated at

  • vendorStatus string | null Required

    Vendor status

    Values are pending, approved, or rejected. Default value is pending.

  • warehouseId integer(int32) Required

    Warehouse

PUT /sale-return-items/{id}.json
curl \
 --request PUT 'http://api.example.com/v1/sale-return-items/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"adjustmentReasonId":42,"createdAt":"2025-05-04T09:42:00Z","externalId":"string","id":42,"merchantStatus":"approved","price":0,"purchaseItemId":42,"quantity":0,"quantityCancelled":0,"quantityRefunded":0,"quantityWrittenOff":0,"saleItemId":42,"saleReturnId":42,"updatedAt":"2025-05-04T09:42:00Z","vendorStatus":"pending","warehouseId":42}'
Request examples
{
  "adjustmentReasonId": 42,
  "createdAt": "2025-05-04T09:42:00Z",
  "externalId": "string",
  "id": 42,
  "merchantStatus": "approved",
  "price": 0,
  "purchaseItemId": 42,
  "quantity": 0,
  "quantityCancelled": 0,
  "quantityRefunded": 0,
  "quantityWrittenOff": 0,
  "saleItemId": 42,
  "saleReturnId": 42,
  "updatedAt": "2025-05-04T09:42:00Z",
  "vendorStatus": "pending",
  "warehouseId": 42
}