Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.
- Getting Started
- APIs
- Orders
- Reverse Orders
- Abandoned Carts
- Products
- Inventories
- Shipping
- Marketing
- Gift Cards
- Coupons
- Bundle Offers
- Loyalty Program
- Calculate Loyalty Points for Order
- Retrieve Store Loyalty Status
- Activate Loyalty Program
- Retrieve Loyalty Program Status
- Set Points Expiration Rules
- Update Cashback Rule
- Update Cashback Rule Status
- Create Points Redemption Method
- Update Points Redemption Method
- Delete Points Redemption Method
- Update Redemption Method Status
- Retrieve Customer Loyalty Summary
- List Loyalty Data
- List Customer Points History
- Retrieve Manager Loyalty Info Page
- Update Loyalty Info Page
- Adjust Customer Points
- Customers
- Store Settings
- Countries and Cities
- Webhook
- Orders
- Store Events
Update return products
Developing
PUT
https://api.zid.sa/v1/managers/store/reverse-orders/products
⚠️ Important#
⚠️ Validation Rules & Business Logic#
received_quantity + not_received_quantity + damaged_quantity≤ reversed_quantityAt least one quantity must be greater than 0
🔄 Typical Workflow Position#
1.
2.
3.
4.
(this endpoint)5.
6.
Request
Header Params
Body Params application/jsonRequired
Example
{
"order_reverse_id": "64d0f002-0185-4fd1-94d2-e3a86be622c9",
"products": [
{
"id": "af9e0150-1c56-4a1b-87e9-846d6a0acf19",
"received_quantity": 0,
"not_received_quantity": 0,
"damaged_quantity": 1
}
]
}Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api.zid.sa/v1/managers/store/reverse-orders/products' \
--header 'Authorization: {{Autherization}}' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Accept-Language: en' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
"order_reverse_id": "64d0f002-0185-4fd1-94d2-e3a86be622c9",
"products": [
{
"id": "af9e0150-1c56-4a1b-87e9-846d6a0acf19",
"received_quantity": 0,
"not_received_quantity": 0,
"damaged_quantity": 1
}
]
}'Responses
🟢200OK
application/json
Body
Example
{
"status": "object",
"order_reverse": {
"id": "64d0f002-0185-4fd1-94d2-e3a86be622c9",
"store_id": "d297fb8b-c322-412e-a2f4-ffa96dc57022",
"order_id": 64086815,
"is_partial": 0,
"consignee_name": "Jane Smith",
"consignee_mobile": "+966500000005",
"consignee_city": {
"id": 1,
"country_id": 184,
"zone_id": 2879,
"name": "Riyadh",
"ar_name": "الرياض",
"code": null,
"status": 1,
"priority": 10,
"created_at": null,
"updated_at": "2021-05-26T13:04:05.000000Z",
"deleted_at": null,
"national_address_city_id": 3,
"governorate_ar_name": "امارة منطقة الرياض",
"governorate_en_name": "Riyadh Principality",
"region_id": 1,
"region_ar_name": "الرياض",
"region_en_name": "Riyadh",
"country": {
"id": 184,
"name": "Saudi Arabia",
"ar_name": "السعودية",
"country_code": "+966",
"iso_code_2": "SA",
"iso_code_3": "SAU",
"address_format": "",
"postcode_required": 0,
"status": 1,
"currency_code": "SAR",
"tax_percentage": null,
"is_supported_by_zid": 1,
"priority": 1,
"created_at": "2019-09-25T18:43:01.000000Z",
"updated_at": "2019-09-25T18:43:01.000000Z"
}
},
"consignee_address_1": "456 Commerce Avenue",
"consignee_address_2": "Suite 301",
"inventory_address_id": null,
"inventory_location_id": "8ee590fed02d4c509184f628bb8b115a",
"inventory": {
"deleted": null,
"id": "8ee590fed02d4c509184f628bb8b115a",
"created_at": "2023-09-21T10:11:10.135964Z",
"updated_at": "2025-10-13T14:55:15.609712Z",
"name": {
"ar": "الرياض - فرع عبد العزيز"
},
"type": "PHYSICAL",
"coordinates": {
"type": "Point",
"coordinates": [
46.66803359985352,
24.77208405941104
]
},
"is_default": 0,
"is_private": 0,
"is_enabled": 1,
"fulfillment_priority": 9,
"meta": null,
"city_id": 1,
"store_id": "d297fb8b-c322-412e-a2f4-ffa96dc57022",
"full_address": "6137 King Abdul Aziz Branch Rd, An Nafal, Riyadh 13312, Saudi Arabia",
"channels": [
"pos",
"catalog"
],
"district": "King Abdul Aziz",
"street": "نفال",
"short_address": null
},
"reason": [
{
"id": "ebcfd40a-7c2f-4ed4-b30f-3fd142388ad7",
"name": "Customer canceled"
}
],
"shipping_method": null,
"waybill": null,
"products": [
{
"id": "af9e0150-1c56-4a1b-87e9-846d6a0acf19",
"order_reverse_id": "64d0f002-0185-4fd1-94d2-e3a86be622c9",
"order_product_id": 110168319,
"product_uuid": "003140e29d8e462db823373407746871",
"quantity": 1,
"reversed_quantity": 1,
"received_quantity": 0,
"not_received_quantity": 0,
"damaged_quantity": 1,
"product": {
"id": "003140e29d8e462db823373407746871",
"structure": "standalone",
"store_id": 3,
"name": "طقم سفر للحواجب سوبرستار من بنفت",
"quantity": null,
"is_infinite": true,
"slug": "طقم-سفر-للحواجب-سوبرستار-من-بنفت",
"sku": "Z.217795.169603646831188",
"price": "199.5600",
"sale_price": null,
"parent_id": null,
"is_published": 1,
"is_draft": 0,
"old_id": null,
"upc": null,
"rating": null,
"revision": 1,
"product_class_id": null,
"display_order": 32766,
"has_been_modified": 1,
"created_at": "2025-04-03T00:11:39.826154Z",
"updated_at": "2026-02-02T14:07:49.155764Z",
"deleted": null,
"popularity_order": null,
"cost": "0.0000",
"weight": null,
"popularity_points": 26,
"requires_shipping": 1,
"weight_display_unit": "kg",
"is_taxable": true,
"purchase_restrictions": {
"max_quantity_per_cart": null,
"min_quantity_per_cart": null,
"sale_price_period_end": null,
"availability_period_end": null,
"sale_price_period_start": null,
"availability_period_start": null
},
"meta": [],
"short_description": null,
"badge": null,
"related_products_settings": "AUTO_GENERATED",
"related_products_title": null,
"barcode": null,
"product_class": null
},
"product_class": null,
"order_product": {
"id": 110168319,
"order_id": 64086815,
"reseller_meta": null,
"product_id": 0,
"product_uuid": "003140e29d8e462db823373407746871",
"sku": "Z.217795.169603646831188",
"name": "طقم سفر للحواجب سوبرستار من بنفت",
"custom_fields": null,
"model": "",
"quantity": 1,
"requires_shipping": 1,
"weight": null,
"cost": 0,
"price": "199.55999896568000",
"additions_price": "0.00000000000000",
"total": "199.55999896568000",
"net_price": "173.53043388320000",
"net_sale_price": null,
"net_additions_price": "0.00000000000000",
"gross_sale_price": null,
"gross_additions_price": "0.00000000000000",
"gross_price": "199.55999896568000",
"tax_percentage": "0.15000000000000",
"tax_amount": "26.02956508248000",
"is_taxable": true,
"is_discounted": false,
"meta": null,
"reward": 0,
"created_at": "2026-01-28T16:52:59.000000Z",
"updated_at": "2026-01-28T16:52:59.000000Z",
"deleted_at": null,
"external_product_id": null,
"is_external_product": false,
"net_unit_price": "173.53043388320000",
"gross_unit_price": "199.55999896568000",
"undiscounted_net_unit_price": "173.53",
"undiscounted_gross_unit_price": "199.56",
"undiscounted_net_total": "173.53",
"undiscounted_gross_total": "199.56",
"unit_discount_amount": "0.00000000000000",
"unit_discount_percentage": "0.00000000000000",
"subtotal_discounts": []
},
"created_at": "2026-01-31T13:04:20.000000Z",
"updated_at": "2026-02-02T14:13:04.000000Z"
}
],
"reverse_total": 199.56,
"refund_total": 0,
"refund": {
"id": "67534651-6ab3-415b-af61-d0a0ed103449",
"amount": "199.56",
"payment_method": "zid_bank_transfer",
"reference": null,
"notes": "Refund processed via bank transfer",
"receipt_link": "https://zid-platform.s3-accelerate.amazonaws.com/public/refunds/bank_transfer_receipts/kasYsnXTGE2Oxsp4dn86bE38HLvip5POwKF60soV.jpg",
"created_at": "2026-02-02T13:48:03.000000Z",
"updated_at": "2026-02-02T13:48:03.000000Z"
},
"available_refund_payment_methods": [
{
"name": "Bank Transfer",
"code": "zid_bank_transfer"
}
],
"shipment_status": null
},
"message": {
"type": "object",
"code": null,
"name": null,
"description": null
}
}🟠401Unauthorized
🔴500Internal Server error
🟠422Validation errors
Modified at 2026-02-02 14:14:40