custom_data | object (Custom Data) Key-value pair of custom data. See the |
order_type | string (Order Type) Default: "PURCHASE_ORDER" Type of the order |
order_number required | string (Order Number) <= 64 characters Freeform text that can be anything the user wants, but must be unique. |
description | string (Description) |
Array of objects (References) Default: [] | |
start_date | string <date> (Start Date) |
expiration_date | string <date> (Expiration Date) |
name | string (Name) Name of the purchase order |
supplier_created_releases_allowed | boolean (Supplier Created Releases Allowed) Default: false Whether or not the supplier can create releases |
object (Shipping Requirements) Shipping requirements | |
tags | Array of strings (Tags) Default: [] List of tags ids or slugs to be associated with the Order |
object (OrderSupplier) Another entity/company that is involved. IS NOT specific to any realm, meaning it does not reference any realm-specific ID values. Use this when you want multiple tenants to see the same data about a party. | |
object (OrderStop) | |
object (OrderStop) | |
Array of UpdateEntireOrderItem (object) or CreateOrderItem (object) (Items) |
Successful Response
custom_data | object (Custom Data) Key-value pair of custom data. See the |
order_number required | string (Order Number) <= 64 characters Freeform text that can be anything the user wants, but must be unique. |
required | object (OrderStop) |
name | string (Name) Name of order |
object (OrderStop) | |
description | string (Description) |
source | string (CreatedBySource)
|
source_system_id | string (Source System Id) <= 64 characters Deprecated This field is |
start_date | string <date> (Start Date)
|
expiration_date | string <date> (Expiration Date)
|
Array of objects (References) Default: [] | |
object (Shipping Requirements) Shipping requirements | |
id required | string (Id) Unique identifier for the Order |
order_type | string (Order Type) Default: "PURCHASE_ORDER" Type of the order |
status required | string (PurchaseOrderStatus) Status of the Purchase Order |
Array of objects (Items) Default: [] Items on the Order | |
supplier_created_releases_allowed | boolean (Supplier Created Releases Allowed) Default: false Whether or not the supplier can create releases |
object (Supplier) Supplier for the Purchase Order | |
Array of any (Releases) Default: [] List of Releases associated with the Order | |
released_from_release_id | string (Released From Release Id) ID of this order's parent Release, if exists |
created_from_order_id | string (Created From Order Id) ID of this Order's parent Order, if exists |
cancelled_at | string <date-time> (Cancelled At) ISO 8601 date/time of when this Order was cancelled. See the date/time format documentation. |
created_at required | string <date-time> (Created At) ISO 8601 date/time of when this Order was created. See the date/time format documentation. |
updated_at required | string <date-time> (Updated At) ISO 8601 date/time of when this Order was last updated. See the date/time format documentation. |
Array of objects (Tags) Default: [] List of tags associated with the Order | |
archived | boolean (Archived) Default: false |
Validation Error
{- "custom_data": "{\"abc\": \"any value\", \"def\": \"any value\"}",
- "order_type": "PURCHASE_ORDER",
- "order_number": "string",
- "description": "string",
- "references": [ ],
- "start_date": "2019-08-24",
- "expiration_date": "2019-08-24",
- "name": "string",
- "supplier_created_releases_allowed": false,
- "shipping_requirements": {
- "bill_to": {
- "account_number": "string",
- "billing_id": "string",
- "payment_term": "PREPAID",
- "billing_company_name": "string",
- "billing_address": {
- "country": "US",
- "line_1": "string",
- "line_2": "string",
- "line_3": "string",
- "locality": "string",
- "postal_code": "string",
- "region": "TX",
- "urbanization": "string",
- "residential": false,
- "geolocation": {
- "latitude": -90,
- "longitude": -180
}
}, - "contact": {
- "email": "user@example.com",
- "phone_number": "string"
}
}
}, - "tags": [ ],
- "supplier": {
- "name": "string",
- "address": {
- "country": "US",
- "line_1": "string",
- "line_2": "string",
- "line_3": "string",
- "locality": "string",
- "postal_code": "string",
- "region": "TX",
- "urbanization": "string",
- "residential": false,
- "geolocation": {
- "latitude": -90,
- "longitude": -180
}
}, - "identification_codes": [ ],
- "phone_number": "string",
- "email": "user@example.com",
- "supplier_id": "string"
}, - "ship_to": {
- "country": "US",
- "line_1": "string",
- "line_2": "string",
- "line_3": "string",
- "locality": "string",
- "postal_code": "string",
- "region": "TX",
- "urbanization": "string",
- "residential": false,
- "geolocation": {
- "latitude": -90,
- "longitude": -180
}, - "custom_data": "{\"abc\": \"any value\", \"def\": \"any value\"}",
- "timezone": "America/Chicago",
- "location_number": "PA-1",
- "company_name": "string",
- "references": [ ],
- "shipping_requirements": {
- "plan_window": {
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z"
}
}
}, - "ship_from": {
- "country": "US",
- "line_1": "string",
- "line_2": "string",
- "line_3": "string",
- "locality": "string",
- "postal_code": "string",
- "region": "TX",
- "urbanization": "string",
- "residential": false,
- "geolocation": {
- "latitude": -90,
- "longitude": -180
}, - "custom_data": "{\"abc\": \"any value\", \"def\": \"any value\"}",
- "timezone": "America/Chicago",
- "location_number": "PA-1",
- "company_name": "string",
- "references": [ ],
- "shipping_requirements": {
- "plan_window": {
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z"
}
}
}, - "items": [
- {
- "custom_data": "{\"abc\": \"any value\", \"def\": \"any value\"}",
- "description": "string",
- "references": [ ],
- "shipping_requirements": {
- "description": "string",
- "identifying_marks": [ ],
- "references": [ ],
- "tare_weight": {
- "unit": "KG",
- "value": "string"
}, - "dimensions": {
- "unit": "CM",
- "length": "string",
- "height": "string",
- "width": "string"
}, - "volume": {
- "unit": "CU_FT",
- "value": "string"
}, - "customer_reference_number": "string",
- "hazmat": {
- "identification_number": "string",
- "hazard_class": "string",
- "packing_group": "I",
- "proper_shipping_name": "string",
- "packing_instructions": "string",
- "technical_name": "string",
- "hazard_subsidiary_class": "string",
- "emergency_contact": {
- "system_id": "string",
- "contact_type": "ACCOUNT_REP",
- "company_name": "string",
- "person_name": "string",
- "email": "user@example.com",
- "phone": "string",
- "fax": "string"
}, - "signatory": {
- "system_id": "string",
- "contact_type": "ACCOUNT_REP",
- "company_name": "string",
- "person_name": "string",
- "email": "user@example.com",
- "phone": "string",
- "fax": "string"
}
}, - "temperature": {
- "unit": "C",
- "minimum": "string",
- "maximum": "string"
}, - "product_id": "string",
- "freight_class": "50",
- "nmfc_item_code": "string",
- "nmfc_sub_code": "string",
- "country_of_manufacture": "MX",
- "stackable": false,
- "piece_type": "BAG",
- "total_pieces": 0,
- "value_per_piece": {
- "value": "string",
- "currency_code": "USD"
}, - "gross_weight": {
- "unit": "KG",
- "value": "string"
}, - "quantity": 0,
- "packaging_type": "BAG",
- "handling_unit_id": "string",
- "combined_handling_unit_info": {
- "quantity": 0,
- "packaging_type": "BAG",
- "freight_class": "50",
- "dimensions": {
- "unit": "CM",
- "length": "string",
- "height": "string",
- "width": "string"
}, - "weight": {
- "unit": "KG",
- "value": "string"
}
}
}, - "amount": {
- "value": "string",
- "unit": "KG"
}, - "id": "string"
}
]
}
{- "custom_data": "{\"abc\": \"any value\", \"def\": \"any value\"}",
- "order_number": "string",
- "ship_to": {
- "country": "US",
- "line_1": "string",
- "line_2": "string",
- "line_3": "string",
- "locality": "string",
- "postal_code": "string",
- "region": "TX",
- "urbanization": "string",
- "residential": false,
- "geolocation": {
- "latitude": -90,
- "longitude": -180
}, - "custom_data": "{\"abc\": \"any value\", \"def\": \"any value\"}",
- "timezone": "America/Chicago",
- "location_number": "PA-1",
- "company_name": "string",
- "references": [ ],
- "shipping_requirements": {
- "plan_window": {
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z"
}
}
}, - "name": "string",
- "ship_from": {
- "country": "US",
- "line_1": "string",
- "line_2": "string",
- "line_3": "string",
- "locality": "string",
- "postal_code": "string",
- "region": "TX",
- "urbanization": "string",
- "residential": false,
- "geolocation": {
- "latitude": -90,
- "longitude": -180
}, - "custom_data": "{\"abc\": \"any value\", \"def\": \"any value\"}",
- "timezone": "America/Chicago",
- "location_number": "PA-1",
- "company_name": "string",
- "references": [ ],
- "shipping_requirements": {
- "plan_window": {
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z"
}
}
}, - "description": "string",
- "source": "SHIPWELL_WEB",
- "source_system_id": "string",
- "start_date": "2019-08-24",
- "expiration_date": "2019-08-24",
- "references": [ ],
- "shipping_requirements": {
- "bill_to": {
- "account_number": "string",
- "billing_id": "string",
- "payment_term": "PREPAID",
- "billing_company_name": "string",
- "billing_address": {
- "country": "US",
- "line_1": "string",
- "line_2": "string",
- "line_3": "string",
- "locality": "string",
- "postal_code": "string",
- "region": "TX",
- "urbanization": "string",
- "residential": false,
- "geolocation": {
- "latitude": -90,
- "longitude": -180
}
}, - "contact": {
- "email": "user@example.com",
- "phone_number": "string"
}
}
}, - "id": "string",
- "order_type": "PURCHASE_ORDER",
- "status": "NOT_READY",
- "items": [ ],
- "supplier_created_releases_allowed": false,
- "supplier": {
- "name": "string",
- "address": {
- "country": "US",
- "line_1": "string",
- "line_2": "string",
- "line_3": "string",
- "locality": "string",
- "postal_code": "string",
- "region": "TX",
- "urbanization": "string",
- "residential": false,
- "geolocation": {
- "latitude": -90,
- "longitude": -180
}
}, - "identification_codes": [ ],
- "phone_number": "string",
- "email": "user@example.com",
- "supplier_id": "string"
}, - "releases": [ ],
- "released_from_release_id": "string",
- "created_from_order_id": "string",
- "cancelled_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "tags": [ ],
- "archived": false
}