Returns order consignments

GET /orders/{orderId}/consignments

Headers

X-Application-Name string

Path parameters

orderId integer(int64) Required

Order identifier

Query parameters

client_id string Required

Client identifier

Responses

200

OK
Hide response attributes Show response attributes object
- data object
  
  Hide data attributes Show data attributes object
  
  id integer
  
  order_id integer
  
  labels_raw string
  
  labels_type string
  
  parcel_count integer
  
  type string
- result object
  
  Hide result attributes Show result attributes object
  
  code integer(int)
  
  status string

GET /orders/{orderId}/consignments

curl \
 -X GET https://mpapi.proxy.omnicado.com/v1/orders/89591350/consignments?client_id=yourClientId&client_id=api_token_value \
 -H "X-Application-Name: myApplicationName"

Response examples (200)

{
  "data": {
    "id": 1234,
    "order_id": 223424231402,
    "labels_raw": "JVBERi0xLjMNCiXi48/TDQoNCjEgMCBvYmoNCjw8DvUGFnZXMgMyAwIFINCj...MjcxNA0KJSVFT0YNCg==",
    "labels_type": "pdf",
    "parcel_count": 3,
    "type": "online"
  },
  "result": {
    "code": 200,
    "status": "OK"
  }
}

Response examples (200)

{
  "data": {
    "id": 1234,
    "order_id": 223424231402,
    "labels_raw": "JVBERi0xLjMNCiXi48/TDQoNCjEgMCBvYmoNCjw8DvUGFnZXMgMyAwIFINCj...MjcxNA0KJSVFT0YNCg==",
    "labels_type": "pdf",
    "parcel_count": 3,
    "type": "online"
  },
  "result": {
    "code": 200,
    "status": "OK"
  }
}