BigCommerce · Schema
Consignments
All the consignments of the order.
E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS
Properties
| Name | Type | Description |
|---|---|---|
| shipping | array | List of shipping consignments |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/Consignments",
"title": "Consignments",
"type": "object",
"properties": {
"shipping": {
"type": "array",
"description": "List of shipping consignments",
"items": {
"$ref": "#/components/schemas/ShippingConsignment"
}
}
},
"description": "All the consignments of the order.",
"x-examples": {
"example-1": {
"shipping": [
{
"lineItems": [
{
"id": 8
}
],
"shippingAddressId": 1,
"firstName": "first1",
"lastName": "last1",
"company": "company1",
"address1": "2802 Skyway Cir",
"address2": "Balcony",
"city": "Austin",
"stateOrProvince": "Texas",
"postalCode": "78704",
"country": "United States",
"countryCode": "US",
"email": "[email protected]",
"phone": "0410123452",
"itemsTotal": 1,
"itemsShipped": 0,
"shippingMethod": "Flat Rate",
"baseCost": 15.5,
"costExTax": 15.5,
"costIncTax": 16.7,
"costTax": 1.2,
"costTaxClassId": 2,
"baseHandlingCost": 0,
"handlingCostExTax": 0,
"handlingCostIncTax": 0,
"handlingCostTax": 0,
"handlingCostTaxClassId": 2,
"shippingZoneId": 1,
"shippingZoneName": "United States",
"customFields": [
{
"name": "special note",
"value": "super rare"
}
]
}
]
}
},
"x-internal": false
}