Orders

GET {domain}/api/stores/{store_id}/orders/{external_id}

Get order

For authentication pass correct key in request header "x-shipping-access-token"

{
    "id": 10,
    "store": "store",
    "delivery_type": 1,
    "external_id": "BIG012345678987654324",
    "requested_tracking_number": "123456789",
    "response_tracking_number": "123456789",
    "service_level": "Standard",
    "shipper_account_id": "dc2764e9-00b0-4292-b67b-e594f068f165",
    "service_type": "dhl-global-mail-asia_gm_packet_standard",
    "sender_name": "Giorgi Nakeuri",
    "sender_phone": "599424945",
    "sender_email": "giorgi.nakeuri@gmail.com",
    "sender_address1": "Lagodekhi",
    "sender_address2": "Building 1",
    "sender_country": "Georgia",
    "sender_city": "Tbilisi",
    "sender_state": null,
    "sender_company": null,
    "sender_zip": "47400",
    "receiver_name": "Rui Lim",
    "receiver_phone": "0123456789",
    "receiver_email": "giorgi.nakeuri@gmail.com",
    "receiver_address1": "Melbourne",
    "receiver_address2": "Building 1",
    "receiver_country": "Georgia",
    "receiver_city": "Melbourne",
    "receiver_state": "Victoria",
    "receiver_zip": "59200",
    "item_description": "T-shirt",
    "quantity": 2,
    "weight": 100,
    "currency": "USD",
    "amount": 50,
    "synchronized": true,
    "error": false,
    "error_description": null,
    "exception": null,
    "tries": 1,
    "deleted": true,
    "created_date": "2021-05-21T11:47:16.537",
    "updated_date": "2021-05-21T11:47:16.537",
    "deleted_date": "2021-05-21T11:47:16.537",
    "file": {
        "handle": "630019662576",
        "downloaded": true,
        "error": false,
        "error_description": null,
        "exception": null,
        "tries": 1,
        "url": "https://singapore-shipping-bucket-dev.s3.amazonaws.com/JT/2021/05/21/d17b4f81-37ce-42ab-bcf5-e6981d256920.pdf"
    }
}
POST {domain}/api/stores/{store_id}/orders

Add order

For authentication pass correct key in request header "x-shipping-access-token"

delivery_type

int - not nullable. 1:JT, 2:Ninjavan, 3:CouriersPlease
external_id

string - not nullable
requested_tracking_number

string - nullable
service_level

string - nullable
shipper_account_id

string - nullable
service_type

string - nullable
sender_name

string - not nullable
sender_phone

string - not nullable
sender_email

string - not nullable
sender_address1

string - not nullable
sender_address2

string - nullable
sender_coutry

string - not nullable
sender_city

string - not nullable
sender_state

string - nullable
sender_company

string - nullable
sender_zip

string - not nullable
receiver_name

string - not nullable
receiver_phone

string - not nullable
receiver_email

string - not nullable
receiver_address1

string - not nullable
receiver_address2

string - nullable
receiver_country

string - not nullable
receiver_city

string - not nullable
receiver_state

string - nullable
receiver_zip

string - not nullable
item_description

string - not nullable
quantity

decimal - not nullable
weight

decimal - not nullable
currency

string - nullable
amount

decimal - nullable

 
{
    "delivery_type": 1,
    "external_id": "BIG012345678987654324",
    "requested_tracking_number": "123456789",
    "service_level": "Standard",
    "shipper_account_id": "dc2764e9-00b0-4292-b67b-e594f068f165",
    "service_type": "dhl-global-mail-asia_gm_packet_standard",
    "sender_name": "Giorgi Nakeuri",
    "sender_phone": "599424945",
    "sender_email": "giorgi.nakeuri@gmail.com",
    "sender_address1": "Lagodekhi",
    "sender_address2": "Building 1",
    "sender_country": "Georgia",
    "sender_city": "Tbilisi",
    "sender_state": null,
    "sender_company": null,
    "sender_zip": "47400",
    "receiver_name": "Rui Lim",
    "receiver_phone": "0123456789",
    "receiver_email": "giorgi.nakeuri@gmail.com",
    "receiver_address1": "Melbourne",
    "receiver_address2": "Building 1",
    "receiver_country": "Georgia",
    "receiver_city": "Melbourne",
    "receiver_state": "Victoria",
    "receiver_zip": "59200",
    "item_description": "T-shirt",
    "quantity": 2,
    "weight": 100,
    "currency": "USD",
    "amount": 50
}
                                    
{
    "id": 10,
    "store": "store",
    "delivery_type": 1,
    "external_id": "BIG012345678987654324",
    "requested_tracking_number": "123456789",
    "response_tracking_number": null,
    "service_level": "Standard",
    "shipper_account_id": "dc2764e9-00b0-4292-b67b-e594f068f165",
    "service_type": "dhl-global-mail-asia_gm_packet_standard",
    "sender_name": "Giorgi Nakeuri",
    "sender_phone": "599424945",
    "sender_email": "giorgi.nakeuri@gmail.com",
    "sender_address1": "Lagodekhi",
    "sender_address2": "Building 1",
    "sender_country": "Georgia",
    "sender_city": "Tbilisi",
    "sender_state": null,
    "sender_company": null,
    "sender_zip": "47400",
    "receiver_name": "Rui Lim",
    "receiver_phone": "0123456789",
    "receiver_email": "giorgi.nakeuri@gmail.com",
    "receiver_address1": "Melbourne",
    "receiver_address2": "Building 1",
    "receiver_country": "Georgia",
    "receiver_city": "Melbourne",
    "receiver_state": "Victoria",
    "receiver_zip": "59200",
    "item_description": "T-shirt",
    "quantity": 2,
    "weight": 100,
    "currency": "USD",
    "amount": 50,
    "synchronized": false,
    "error": false,
    "error_description": null,
    "exception": null,
    "tries": 0,
    "deleted": false,
    "created_date": "2021-05-21T11:47:16.537",
    "updated_date": "2021-05-21T11:47:16.537",
    "deleted_date": null,
    "file": null
}
DELETE {domain}/api/stores/{store_id}/orders/{external_id}

Delete order

For authentication pass correct key in request header "x-shipping-access-token"