List orders

curl --request GET \
  --url https://api.parceltracer.com/v1/external/orders/ \
  --header 'X-Api-Key: <api-key>'

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    [
      {
        "order_id": "11",
        "reference_id": "",
        "is_exchange": "false",
        "workflow": "STANDARD",
        "tracking_link": "https://prod.parceltracer.app/tracking/xxxxx-yyyyyyy",
        "is_critical": "false",
        "merchant_location": 1,
        "cod": [
          [
            "USD",
            "20.00"
          ]
        ],
        "number_of_packages": 1,
        "description": "",
        "notes": "",
        "return_reason": "",
        "delivery_state": "CREATED",
        "payment_state": "UNPAID",
        "merchant_invoice": "null",
        "customer": {
          "id": 6635,
          "name": "Joe",
          "phone_number": "+9613123456",
          "secondary_phone_number": "",
          "email": "[email protected]"
        },
        "customer_location": {
          "id": 6635,
          "area": {
            "id": 1,
            "name_en": "Aaiyat",
            "name_ar": "عيات",
            "lat": 34.53534,
            "long": 36.19682,
            "district": "Akkar",
            "maps_link": "http://maps.google.com/maps?q=34.53534,36.19682"
          },
          "directions": ""
        }
      },
      {
        "order_id": "17",
        "reference_id": "",
        "is_exchange": "false",
        "workflow": "STANDARD",
        "tracking_link": "https://prod.parceltracer.app/tracking/xxxxx-yyyyyyy",
        "is_critical": "false",
        "merchant_location": 1,
        "cod": [
          [
            "USD",
            "20.00"
          ]
        ],
        "number_of_packages": 1,
        "description": "",
        "notes": "",
        "return_reason": "",
        "delivery_state": "CREATED",
        "payment_state": "UNPAID",
        "merchant_invoice": "null",
        "customer": {
          "id": 6635,
          "name": "Sara",
          "phone_number": "+9613853335",
          "secondary_phone_number": "",
          "email": ""
        },
        "customer_location": {
          "id": 6635,
          "area": {
            "id": 2,
            "name_en": "El Hamra",
            "name_ar": "حمرا",
            "lat": 33.89631,
            "long": 35.48196,
            "district": "Beirut",
            "maps_link": "http://maps.google.com/maps?q=33.89631,35.48196"
          },
          "directions": ""
        }
      }
    ]
  ]
}

GET

orders

List orders

curl --request GET \
  --url https://api.parceltracer.com/v1/external/orders/ \
  --header 'X-Api-Key: <api-key>'

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    [
      {
        "order_id": "11",
        "reference_id": "",
        "is_exchange": "false",
        "workflow": "STANDARD",
        "tracking_link": "https://prod.parceltracer.app/tracking/xxxxx-yyyyyyy",
        "is_critical": "false",
        "merchant_location": 1,
        "cod": [
          [
            "USD",
            "20.00"
          ]
        ],
        "number_of_packages": 1,
        "description": "",
        "notes": "",
        "return_reason": "",
        "delivery_state": "CREATED",
        "payment_state": "UNPAID",
        "merchant_invoice": "null",
        "customer": {
          "id": 6635,
          "name": "Joe",
          "phone_number": "+9613123456",
          "secondary_phone_number": "",
          "email": "[email protected]"
        },
        "customer_location": {
          "id": 6635,
          "area": {
            "id": 1,
            "name_en": "Aaiyat",
            "name_ar": "عيات",
            "lat": 34.53534,
            "long": 36.19682,
            "district": "Akkar",
            "maps_link": "http://maps.google.com/maps?q=34.53534,36.19682"
          },
          "directions": ""
        }
      },
      {
        "order_id": "17",
        "reference_id": "",
        "is_exchange": "false",
        "workflow": "STANDARD",
        "tracking_link": "https://prod.parceltracer.app/tracking/xxxxx-yyyyyyy",
        "is_critical": "false",
        "merchant_location": 1,
        "cod": [
          [
            "USD",
            "20.00"
          ]
        ],
        "number_of_packages": 1,
        "description": "",
        "notes": "",
        "return_reason": "",
        "delivery_state": "CREATED",
        "payment_state": "UNPAID",
        "merchant_invoice": "null",
        "customer": {
          "id": 6635,
          "name": "Sara",
          "phone_number": "+9613853335",
          "secondary_phone_number": "",
          "email": ""
        },
        "customer_location": {
          "id": 6635,
          "area": {
            "id": 2,
            "name_en": "El Hamra",
            "name_ar": "حمرا",
            "lat": 33.89631,
            "long": 35.48196,
            "district": "Beirut",
            "maps_link": "http://maps.google.com/maps?q=33.89631,35.48196"
          },
          "directions": ""
        }
      }
    ]
  ]
}

Authorizations

X-Api-Key

string

header

required

Query Parameters

page

integer

A page number within the paginated result set.

page_size

integer

Number of results to return per page.

Response

200 - application/json

count

integer

required

Example:

123

results

object[]

required

Show child attributes

results.order_id

integer

required

Unique order identifier.

results.reference_id

string

required

Reference ID of the order, for internal tracking by the shop.

results.is_critical

boolean

required

Mark the order as critical for prioritized handling (subject to the delivery company load and availability)

results.is_exchange

boolean

required

('Require pickup of a return package upon delivery.\n', 'This option is only applicable when workflow is STANDARD')

results.workflow

enum<string>

required

Order workflow: STANDARD or RETURN.

STANDARD - STANDARD
RETURN - RETURN

Available options:

STANDARD,

RETURN

results.merchant_location

integer

required

("Unique identifier of the merchant's location.\n", 'This identifier should correspond to one of the pickup locations visible on the pickup locations page on Parcel Tracer.')

results.customer

object

required

Customer object for the order.

Show child attributes

results.customer.id

integer

required

results.customer.name

string

required

Maximum string length: 255

results.customer.phone_number

string

required

results.customer.secondary_phone_number

string

results.customer.email

string<email>

results.customer_location

object

required

Customer location for delivery or pickup.

Show child attributes

results.customer_location.id

integer

required

results.customer_location.area

object

required

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

Show child attributes

results.customer_location.area.id

integer

required

results.customer_location.area.code

string

required

results.customer_location.area.name_ar

string

default:""

Maximum string length: 200

results.customer_location.area.name_en

string

default:""

Maximum string length: 200

results.customer_location.area.district

enum<string>

Zahleh - Zahleh
Hasbaya - Hasbaya
Baalbek - Baalbek
Jezzine - Jezzine
Baabda - Baabda
Jbeil - Jbeil
Zgharta - Zgharta
Bint Jbeil - Bint Jbeil
Hermel - Hermel
Marjeyoun - Marjeyoun
Bsharri - Bsharri
Aley - Aley
Rashaya - Rashaya
Miniyeh-Danniyeh - Miniyeh-Danniyeh
Tripoli - Tripoli
Tyre - Tyre
Nabatieh - Nabatieh
Chouf - Chouf
Maatn - Maatn
Western Beqaa - Western Beqaa
Akkar - Akkar
Sidon - Sidon
Batroun - Batroun
Keserwan - Keserwan
Koura - Koura
Beirut - Beirut

Available options:

Zahleh,

Hasbaya,

Baalbek,

Jezzine,

Baabda,

Jbeil,

Zgharta,

Bint Jbeil,

Hermel,

Marjeyoun,

Bsharri,

Aley,

Rashaya,

Miniyeh-Danniyeh,

Tripoli,

Tyre,

Nabatieh,

Chouf,

Maatn,

Western Beqaa,

Akkar,

Sidon,

Batroun,

Keserwan,

Koura,

Beirut

results.customer_location.area.lat

string<decimal> | null

results.customer_location.area.long

string<decimal> | null

results.customer_location.area.maps_link

string | null

Maximum string length: 200

results.customer_location.directions

string

results.cod

string[][]

required

Total amount to be collected upon delivery (or upon return). Example: [['USD', '123.5']]

Required array length: 2 elements

results.number_of_packages

integer

required

('Number of packages in the order.\n', 'Should be greater than or equal to 1.')

results.description

string

required

Optional description of the order contents.

results.notes

string

required

Extra notes about the order, visible to delivery company, carriers and customers.

results.payment_state

enum<string>

required

Payment state of the order.

UNPAID - UNPAID
PENDING_PAYMENT_BY_DRIVER - PENDING_PAYMENT_BY_DRIVER
PAID_BY_DRIVER - PAID_BY_DRIVER
PENDING_PAYMENT_TO_MERCHANT - PENDING_PAYMENT_TO_MERCHANT
PAID_TO_MERCHANT - PAID_TO_MERCHANT

Available options:

UNPAID,

PENDING_PAYMENT_BY_DRIVER,

PAID_BY_DRIVER,

PENDING_PAYMENT_TO_MERCHANT,

PAID_TO_MERCHANT

results.delivery_fee

string[][]

Total amount charged for the delivery operation. Required only if workflow is STANDARD. Example: [['USD', '123.5']]

Required array length: 2 elements

results.return_reason

string

Applicable if the order is a return. Reason for the return.

string<uri> | null

Example:

"http://api.example.org/accounts/?page=4"

string<uri> | null

Example:

"http://api.example.org/accounts/?page=2"

Update customer location Create order

⌘I

Introduction

Models

Endpoints

List orders

Authorizations

Query Parameters

Response