Create Reverse Orders

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:

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:

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

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:

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:

integer

optional

City ID.

Example:

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:

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:

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:

string

optional

Unique identifier for the waybill.

Example:

"50e06bb5-2ea7-480d-9e98-961076cf87d7"

cost

integer

optional

Cost associated with the waybill.

Example:

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\""
    }
}