Zid Docs
Merchant APIApp APIThemes
Merchant APIApp APIThemes
Help Center
Slack
  1. Reverse Orders
  • Start Here ๐Ÿš€
  • Overview to Zid Apps
  • Authorization
  • Responses
  • Webhooks
  • Rate Limiting
  • APIs
    • Orders
      • Update Order by ID
      • Get Order Credit Notes
      • Get Order by ID
      • List of Orders
    • Reverse Orders
      • Reverse Order Reasons
        GET
      • Create Reverse Orders
        POST
      • Create Reverse Orders Waybill
        POST
      • Add Reverse Order Reasons
        POST
    • Carts
      • Get Abandoned Cart Details
      • List Abandoned Carts
    • Products
      • Managing Products
        • Get a Product by ID
        • Retrieve a list of products
        • Create a new product
        • Update an existing product.
        • Bulk update of products using their IDs or SKUs
        • Delete a product.
        • Product Setting
      • Digital Vouchers
        • Product Vouchers
        • Order Voucher
        • Add Product Voucher
        • Import Vouchers
        • Export Vouchers
        • Update Product Voucher
        • Remove Product Voucher
      • Product Categories
        • Get Single Category Details
        • Get all categories
        • Create Store Category
        • Update a Store Category
        • Add a product to a certain category
        • Publish/Unpublish a Category
        • Detach Category from All Products
        • Remove Category from Product
      • Product Badge
        • Product Badge
      • Product Attributes
        • Get Product Attributes
        • Get Product Attributes
        • Retrieve a product attribute
        • Add a New Product Attribute
        • Add a New Product Attribute
        • Update a product attribute
        • Delete a product attribute
      • Product Attribute Presets
        • Get attribute presets
        • Create Attribute Preset
        • Update Attribute Preset
        • Delete an attribute preset
      • Product Customizations
        • Add Product Variants
        • Insert Custom Options to a Product
        • Insert Custom User-Input Fields to a Product
      • Product Manual Sorting
        • Set Custom Product Order
        • Reset the manual sorting of all products
      • Product Images
        • Get List of images of a product.
        • Add an image to a product
        • Update a product Image Order
        • Delete a product image
      • Product Notifications
        • Availability Notification Stats
        • Availability Notifications Settings
        • List Availability Notifications
        • Add Availability Notification
        • Save Availability Notifications Settings
        • Manually Send Availability Notification Email
        • Export Availability Notifications
      • Product Import
        • Email All Products to Store Owner
        • Import Products via CSV or xlsx File
      • Product Stock (Multi-Inventory)
        • Get Product Stock by ID
        • List Product Stocks
        • Add Product Stock
        • Update Single Product Stock
        • Bulk Update Product Stocks
      • Product Questions & Answers
        • Get Question
        • Get Answer
        • Get All Questions
        • List Question Answers
        • Create Question
        • Create Answer
        • Update Question
        • Update Answer
        • Delete Question
        • Delete Answer
      • Product Reviews
        • List Reviews
        • New Reviews Total
      • Digital Products
        • Create Downloadable Product
        • Generate an Upload URL
        • Upload File to S3
        • Create Product Downloadables
        • Get Product Downloadables
        • Delete Product Downloadables
        • Get Store Downloadables
        • Create Store Downloadables
        • Delete Store Downloadables
    • Inventories
      • Get Store Location by ID
      • List Store Locations
      • Add a New Location
      • Update a Location by ID
      • Update Products Stock by Location ID
    • Shipping
      • List Store Delivery Options
      • Add Shipping Option
    • Marketing
      • Gift Cards
        • Get Store Settings
        • Add gift card to the cart
        • Update Store Settings
        • Upload gift card designs
        • Remove gift card from the cart
      • Coupons
        • Create a New Coupon
        • List Coupons
        • Get Coupon Details
        • Update Coupon
        • Delete Coupon
      • Bundle Offers
        • Retrieve all Bundle Offers
      • Loyalty Program
        • Loyalty Program Points per Order
        • Store Loyalty Status
        • Info Page
        • Loyalty Program Activation
        • Loyalty Status
        • Set Points Expiration
        • Cashback Rule Method Update
        • Cashback Rule Method Update Status
        • Add Points Redemption Method
        • Update Points Redemption Method
        • Delete Points Redemption Method
        • Toggle Redemption Method Status
        • Show Loyalty Points Info for Specific Customer
        • Customer Profile
        • List Data
        • Customer Points History
        • Info Page - Managers
        • Update Info Page
        • Adjust Customer Points
    • Customers
      • List of Customers
      • Get Customer by ID
    • Store Settings
      • ๐Ÿ“„ User Roles and Permissions
      • Get Manager's Profile
      • Get VAT Settings
      • List of Payment Method
    • Countries and Cities
      • Retrieve Store Operating Countries
      • Retrieve Cities by Country ID
      • Countries List
    • Webhook
      • List of Webhooks
      • Create a Webhook
      • Delete a Webhook by OriginalId
      • Delete a Webhook by Subscriber
  • Store Events
    • Order
    • Product
    • Abandoned Cart
    • Customer
    • Product Category
  1. Reverse Orders

Create Reverse Orders

POST
v1/managers/store/reverse-orders
Reverse Orders
Creates an order reverse request.
๐Ÿ”‘Scopes
orders.read_write - Orders Read & Write

Request

Header Params
Authorization
stringย 
required
The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y
Access-Token
stringย 
required
An Access Token is a unique string that represents the authorization granted to a client (Partner application) by a user (Merchant or Store Manager) to access their protected resources. It is part of the OAuth 2.0 standard and is used to authenticate API requests on behalf of the user. Access Tokens have a limited lifespan and must be used within their validity period. Once expired, a new Access Token can be obtained using a Refresh Token. Access Tokens should be treated as sensitive information and must be kept secure to prevent unauthorized access to the user's data. If you do not have an Access-Token, but have the older alternative instead, i.e., the X-Manager-Token, then see the instructions here on how to obtain the Access-Token.
Example:
eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=
Accept-Language
stringย 
required
Language preference.
Default:
ar
Body Params application/json
order_id
integerย 
required
The ID of the order to reverse.
Example:
554348
consignee_name
stringย 
required
Name of the consignee.
Example:
"ุนู„ูŠ ุฃุญู…ุฏ"
consignee_mobile
stringย 
required
Mobile number of the consignee.
Example:
"966500000001"
consignee_city_id
integerย 
required
City ID of the consignee.
Example:
1
consignee_address_1
stringย 
required
Address line 1 of the consignee.
Example:
"ุดุงุฑุน ุงู„ู…ู„ูƒ ูู‡ุฏ"
consignee_address_2
stringย 
required
Address line 2 of the consignee.
Example:
"ุงู„ู…ุจู†ู‰ ุฑู‚ู… 101"
inventory_location_id
stringย 
required
Inventory location ID for multi-inventory stores.
Example:
" "
reason
array[string]
required
Reasons for reverse order.
Example
{
  "order_id": 554348,
  "consignee_name": "\"ุนู„ูŠ ุฃุญู…ุฏ\"",
  "consignee_mobile": "\"966500000001\"",
  "consignee_city_id": 1,
  "consignee_address_1": "\"ุดุงุฑุน ุงู„ู…ู„ูƒ ูู‡ุฏ\"",
  "consignee_address_2": "\"ุงู„ู…ุจู†ู‰ ุฑู‚ู… 101\"",
  "inventory_location_id": "\" \"",
  "reason": [
    "\"ุงู„ุณู„ุนุฉ ุชุงู„ูุฉ ุนู†ุฏ ุงู„ุชุณู„ูŠู…\""
  ]
}

Request 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 POST 'https://api.zid.sa/v1/managers/store/reverse-orders' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y' \
--header 'Access-Token: eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=' \
--header 'Accept-Language;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "order_id": 554348,
    "consignee_name": "\"ุนู„ูŠ ุฃุญู…ุฏ\"",
    "consignee_mobile": "\"966500000001\"",
    "consignee_city_id": 1,
    "consignee_address_1": "\"ุดุงุฑุน ุงู„ู…ู„ูƒ ูู‡ุฏ\"",
    "consignee_address_2": "\"ุงู„ู…ุจู†ู‰ ุฑู‚ู… 101\"",
    "inventory_location_id": "\" \"",
    "reason": [
        "\"ุงู„ุณู„ุนุฉ ุชุงู„ูุฉ ุนู†ุฏ ุงู„ุชุณู„ูŠู…\""
    ]
}'

Responses

๐ŸŸข200Returns a response confirming the creation of the reverse order and updates the order status to "reverse_in_progress".
application/json
Body
id
stringย 
optional
Unique identifier for the order reverse.
Example:
"0039bc75-472d-4c48-8c82-5e0a6e8eca14"
store_id
stringย 
optional
Identifier for the store associated with the order.
Example:
"724b67c5-2fca-4813-a4ab-2f77703b2f37"
order_id
integerย 
optional
ID of the original order being reversed.
Example:
1
consignee_name
stringย 
optional
Name of the consignee who placed the order.
Example:
"osama"
consignee_mobile
stringย 
optional
Mobile number of the consignee.
Example:
"966500000005"
consignee_city
objectย 
optional
Object containing details about the consignee's city:
id
integerย 
optional
City ID.
Example:
1
country
objectย 
optional
Object containing details about the country:
ar_name
stringย 
optional
en_name
stringย 
optional
name
stringย 
optional
Name of the city
Example:
"Riyadh"
priority
integerย 
optional
Priority level of the city.
consignee_address_1
stringย 
optional
Address lines of the consignee.
consignee_address_2
stringย 
optional
Address lines of the consignee.
inventory
objectย 
optional
Object containing details about the inventory:
id
stringย 
optional
Identifier for the inventory.
Example:
"5d1bee6c07e543c99a36849fdd6f5773"
country
objectย 
optional
Object containing details about the country where the inventory is located:
type
stringย 
optional
Type of inventory
Example:
"PHYSICAL"
coordinates
objectย 
optional
Geographic coordinates of the inventory location.
city_id
integerย 
optional
ID of the city where the inventory is located.
Example:
1
reason
array[string]
optional
Array containing reasons for reversing the order.
waybill
objectย 
optional
Object containing details about the waybill associated with the reverse order:
id
stringย 
optional
Unique identifier for the waybill.
Example:
"50e06bb5-2ea7-480d-9e98-961076cf87d7"
cost
integerย 
optional
Cost associated with the waybill.
Example:
10
label
stringย 
optional
URL to the label for the waybill.
Example:
"https:\\/\\/zidship.com\\/labels\\/50e06bb5-2ea7-480d-9e98-961076cf87d7"
status
stringย 
optional
Current status of the waybill.
courier
stringย 
optional
URL to the courier details for the waybill.
Example:
"https:\\/\\/zidship.com\\/labels\\/50e06bb5-2ea7-480d-9e98-961076cf87d7"
tracking_url
stringย 
optional
URL for tracking the waybill.
Example:
"https:\\/\\/zidship.com\\/track\\/24098837-reverse"
service_level
stringย 
optional
Service level for the waybill.
Example:
"reverse"
tracking_number
stringย 
optional
Tracking number associated with the waybill.
Example:
"290446207592"
Example
{
  "id": "\"0039bc75-472d-4c48-8c82-5e0a6e8eca14\"",
  "store_id": "\"724b67c5-2fca-4813-a4ab-2f77703b2f37\"",
  "order_id": 1,
  "consignee_name": "\"osama\"",
  "consignee_mobile": "\"966500000005\"",
  "consignee_city": {
    "id": 1,
    "country": {
      "id": 183,
      "name": "\"Saudi Arabia\""
    },
    "ar_name": "string",
    "en_name": "string",
    "name": "\"Riyadh\"",
    "priority": 0
  },
  "consignee_address_1": "string",
  "consignee_address_2": "string",
  "inventory": {
    "id": "\"5d1bee6c07e543c99a36849fdd6f5773\"",
    "country": {
      "id": 183,
      "name": {
        "ar": "string",
        "en": "string"
      }
    },
    "type": "\"PHYSICAL\"",
    "coordinates": {
      "type": "\"Point\"",
      "coordinates": [
        0
      ]
    },
    "city_id": 1
  },
  "reason": [
    " \"Does not match the description\""
  ],
  "waybill": {
    "id": "\"50e06bb5-2ea7-480d-9e98-961076cf87d7\"",
    "cost": 10,
    "label": "\"https:\\\\/\\\\/zidship.com\\\\/labels\\\\/50e06bb5-2ea7-480d-9e98-961076cf87d7\"",
    "status": "string",
    "courier": "\"https:\\\\/\\\\/zidship.com\\\\/labels\\\\/50e06bb5-2ea7-480d-9e98-961076cf87d7\"",
    "tracking_url": "\"https:\\\\/\\\\/zidship.com\\\\/track\\\\/24098837-reverse\"",
    "service_level": "\"reverse\"",
    "tracking_number": "\"290446207592\""
  }
}
Modified atย 2025-01-13 07:33:09
Previous
Reverse Order Reasons
Next
Create Reverse Orders Waybill
Built with