Update order schemas

This section contains the schemas for the Update order API.

Request body schema for order

Name	Type	Required	Description
authority_to_leave	string	true	whether or not the order can be left unattended at the delivery address, options are Yes or No
cash_on_delivery_amount	number	false	Used by some carriers, such as NinjaVan, to indicate amount to be received on delivery for cash on delivery orders.
courier_type	string	false	The service level for the order. For a complete list of service level strings, see the Service levels section in the Developer Guide. If you want to specify the courier in the request, use courier_allocation instead. You must specify either courier_allocation or courier_type. If omitted or invalid, an enabled carrier that matches the default service level is allocated instead. The default service level is standard and can be configured by Shippit on request.
courier_allocation	string	false	You must specify either courier_allocation or courier_type. For a complete list of carrier reference strings, see the Carriers section in the Developer Guide. If omitted or invalid, an enabled carrier that matches the default service level is allocated instead. The default service level is standard, and can be configured by Shippit on request. If tracking_only is set to true, then courier_allocation is required.
receiver_contact_number	string	false	conditional – number of the person receiving the order, may be different than the user who purchased the order. Mandatory for International orders.
receiver_name	string	false	name of the person receiving the order if different than the user who purchased the order
receiver_language_code	string	false	Two-letter ISO 639-1 language code of the recipient. Used to determine the language of tracking notifications and other communications. Defaults to EN
retailer_invoice	string or number	false	Merchant invoice number - the customer-facing sales order reference of the order. This is what the recipient sees on the shipping label, packing slip, customs declaration, receipt, etc. This attribute accepts numeric values, but it’s recommended that you pass this in as a string where possible.
retailer_reference	string	false	Merchant reference id - if the merchant uses a separate internal reference id for the order, it can be placed here.
product_currency	string	false	Three letter ISO 4217 currency code that applies to the order, which is sent to the carrier and presented on the customs invoice. Defaults to AUD
suppress_communications	boolean	false	if true, all notifications are suppressed for this specific order
features	[string]	false	Some carriers provide add-on services or features that you can indicate in the order. These services are identified by a unique string, and are dependent on the carrier. To request these services, add the appropriate string in this field. For example, white_glove, or identity_on_delivery.
description	string	false	Goods description for the order. May appear in labels for international orders. If not provided, defaults to the goods type setting from the international shipping settings of the merchant account. Description is mandatory for international orders when validate is set to true.
duties	number	false	The duty amount for an order. This is displayed on the commercial invoice for international orders to calculate the invoice total. Duties are not returned by Shippit. When not provided, no duties amount is displayed on the commercial invoice. eg: 12.90
tax_amount	number	false	The tax amount for an order. This is displayed on the commercial invoice for international orders to calculate the invoice total. When not provided, no tax amount is displayed separately on the commercial invoice. eg: 2.39
customs_clearance_attributes	Array, see table	false	Represents customs clearance parameters for international orders.
delivery_company	string	false	Company name for the delivery
delivery_address	string	true	Delivery address for the order
delivery_suburb	string	true	Delivery suburb for the order
delivery_state	string	true	Delivery state for the order. Australian States valid options are NSW, QLD, ACT, WA, NT, SA, VIC, TAS
delivery_postcode	string	true	Delivery postcode for the order
delivery_country_code	string	false	Two letter country code
delivery_timezone	string	false	Time zone for the delivery
delivery_instructions	string	false	Special delivery instructions for the order, limited to 55 characters
user_attributes	Array, see table	true	Represents the customer details attached to the order.
parcel_attributes	Array, see table	true	An array of parcel specifications to be included in the order. There is a maximum of 1000 parcels per request. Each item can be used to specify the qty, dimensions, and other information about the products being shipped, and the parcel used to ship it. If the Allocate each item in an order to a separate carton setting is enabled in the Shippit administration page, then each item is assigned a separate parcel according to the dimensions given. Otherwise, Shippit may combine multiple items into a single parcel. If the product_attributes field is present, then product information is specified in entries there, separate from the parcel information. In which case each parcel entry represents a single parcel.
product_attributes	Array, see table	false	an array of product details. If this is present, each item in parcel_attributes represents a separate parcel, while each line in product_attributes represents a product line item. There is a maximum of 1000 parcels per request.

Request schema for customs_clearance_attributes

Name	Type	Required	Description
tax_id_type	string	false	The Shippier’s tax id type which is passed to a carrier for the purpose of customs clearance. Valid values include: - EORI - IOSS - LVG - OSR - VOEC - VAT/GST - FTZ - DAN - TAN - DTF - EIN - SSN - DUN - FED - STA - CNP - GBVAT - NZ IRD
tax_id_country_code	string	false	The issuing country of the tax id number in in ISO 3166 Alpha-2 format. eg. GB for Great Britain
tax_id_number	string	false	The tax id number that is declared against this order.
incoterm	string	false	A universal term of trade that defines the responsibility and obligations with the transport of goods. Most commonly used to indicate the responsible party for payment of duties and taxes. Valid values include: - DDU - DDP - EXW - FCA - CPT - CFR - CIP - CIF - DAF - DAT - DAP - DPU - DES - DEQ - FAS - FOB
export_reason	string	false	A term used to indicate the reason for export of dutiable goods. Selected options can affect how your shipment is cleared and how much tax is imposed on your shipment during customs clearance. Example values: - Permanent - Temporary - Return For Repair - Used Exhibition Goods To Origin - Intercompany Use - Commercial Purpose Or Sale - Personal Belongings or Personal Use - Sample - Gift - Return To Origin - Warranty Replacement - Diplomatic Goods - Defence Material
recipient_id	string	false	A free text field to provide a identification number for a recipient. For example, a citizen identification number or passport number which is required for customs clearance for some international destinations. eg: PA1992991
receiver_freight_charge_amount	number	false	The amount charged to the receiver for freight services. This represents the cost that the receiver is responsible for paying as part of the freight or shipping charges.

Request schema for user_attributes

Name	Type	Required	Description
email	string	true	The customer’s email address. Must match regular expression as defined in https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address
first_name	string	true	The customer’s first name. If last_name is not provided, then it is used as the customer’s full name.
last_name	string	false	The customer’s last name
mobile	string	false	Mobile number of the user who purchased the order. This could be different to the person receiving the order.

Request schema for parcel_attributes

Name	Type	Required	Description
package_type	string	false	Set to pallet if the package is a pallet, otherwise leave this field out. You can’t mix pallets with other types of parcels within an order.
weight	number	false	Weight of the parcel in kilos.
depth	number	false	Depth of the parcel in metres
length	number	false	Length of the parcel in metres
width	number	false	Width of the parcel in metres.
label_number	string	false	Parcel number in the carrier system. This is used when the order is a tracking order, to match the parcel number in a carrier against the parcel recorded in shippit.
qty	number	false	conditional – The number of parcels specified by the entry. There is a maximum of 1000 parcels per quote request. Should not be present if a product_attributes key is present in the request. If Allocate each item in an order to a separate carton is enabled in Shippit, a separate parcel is generated for each product listed.

Request schema for product_attributes

Name	Type	Required	Description
title	string	false	conditional – Title or description of the product. Mandatory for international orders with specific couriers.
packed	integer	false	The number of products packed; used in partial orders, or otherwise when the number of products in the parcel is less than the total in the order. If not present, set to product quantity. If this is present, at least 1 item should have packed greater than 0. For international orders, all items should have packed greater than 0.
sku	string	false	conditional – Stock Keeping Unit (SKU) code of the product, for stock keeping purposes. Mandatory on international orders with specific couriers.
product_line_id	string	false	Product line associated with product. Like SKU, this is also for stock keeping purposes, and can be used when SKU would not be enough (e.g. an order containing multiple lines with the same SKU)
origin_country_code	string	false	Two-letter country code (ISO 3166-1 Alpha-2) for the product’s origin country. This is used in customs tracking for International shipments. Defaults to the home country of the Merchant.
location	string	false	Location of the product
dangerous_goods_code	string	false	This is the DG code required when making dangerous goods declarations. Before you can declare orders as having dangerous goods, you must first request for dangerous goods to enabled for your account. Contact Shippit Support or your account manager to have this enabled. DG surcharges are often charged on the weight of the order, so it is recommended to split your order into multiple orders if your order contains either: - both dangerous and non-dangerous goods, or - more than one dangerous goods code
dangerous_goods_text	string	false	Additional information related to dangerous goods being shipped
dangerous_goods_class	string	false	This is the DG class when making dangerous goods declarations.
tariff_code	string	false	Tariff or HS code for international orders declarations
mid_code	string	false	Manufacturer identification code (MID) used for customs declarations. This code identifies the manufacturer of the product and is required for some international shipments, particularly to the United States.
quantity	integer	false	The number of products
price	number	false	Unit price of each product line item. Used in the packing slip and customs declarations. Required for transit protection.

Response schema for order

Name	Type	Required	Description
authority_to_leave	string	true	whether or not the order can be left unattended at the delivery address, options are Yes or No
cash_on_delivery_amount	number	false	Used by some carriers, such as NinjaVan, to indicate amount to be received on delivery for cash on delivery orders.
courier_type	string	false	The service level for the order. For a complete list of service level strings, see the Service levels section in the Developer Guide. If you want to specify the courier in the request, use courier_allocation instead. You must specify either courier_allocation or courier_type. If omitted or invalid, an enabled carrier that matches the default service level is allocated instead. The default service level is standard and can be configured by Shippit on request.
courier_allocation	string	false	You must specify either courier_allocation or courier_type. For a complete list of carrier reference strings, see the Carriers section in the Developer Guide. If omitted or invalid, an enabled carrier that matches the default service level is allocated instead. The default service level is standard, and can be configured by Shippit on request. If tracking_only is set to true, then courier_allocation is required.
receiver_contact_number	string	false	conditional – number of the person receiving the order, may be different than the user who purchased the order. Mandatory for International orders.
receiver_name	string	false	name of the person receiving the order if different than the user who purchased the order
receiver_language_code	string	false	Two-letter ISO 639-1 language code of the recipient. Used to determine the language of tracking notifications and other communications. Defaults to EN
retailer_invoice	string or number	false	Merchant invoice number - the customer-facing sales order reference of the order. This is what the recipient sees on the shipping label, packing slip, customs declaration, receipt, etc. This attribute accepts numeric values, but it’s recommended that you pass this in as a string where possible.
retailer_reference	string	false	Merchant reference id - if the merchant uses a separate internal reference id for the order, it can be placed here.
product_currency	string	false	Three letter ISO 4217 currency code that applies to the order, which is sent to the carrier and presented on the customs invoice. Defaults to AUD
tracking_only	boolean	false	Whether the Order being passed is a tracking order or not. A tracking order is an order where the courier was allocated outside of Shippit, but was loaded into Shippit to take advantage of tracking and notifications. If this is present and set to true, this order is a tracking order. If it is set to true, courier_allocation must be present.
suppress_communications	boolean	false	if true, all notifications are suppressed for this specific order
features	[string]	false	Some carriers provide add-on services or features that you can indicate in the order. These services are identified by a unique string, and are dependent on the carrier. To request these services, add the appropriate string in this field. For example, white_glove, or identity_on_delivery.
description	string	false	Goods description for the order. May appear in labels for international orders. If not provided, defaults to the goods type setting from the international shipping settings of the merchant account. Description is mandatory for international orders when validate is set to true.
duties	number	false	The duty amount for an order. This is displayed on the commercial invoice for international orders to calculate the invoice total. Duties are not returned by Shippit. When not provided, no duties amount is displayed on the commercial invoice. eg: 12.90
tax_amount	number	false	The tax amount for an order. This is displayed on the commercial invoice for international orders to calculate the invoice total. When not provided, no tax amount is displayed separately on the commercial invoice. eg: 2.39
customs_clearance_attributes	Array, see table	false	Represents customs clearance parameters for international orders.
return	boolean	false	Whether the order being passed is a return order or not. This method of processing returns is no longer recommended. See returns for more information.
pickup_at	string	false	The start of the pickup window for OnDemand orders in the format YYYY-MM-DDTHH:mm:ss+HH:mm
pickup_deadline_at	string	false	The end of the pickup window for OnDemand orders in the format YYYY-MM-DDTHH:mm:ss+HH:mm
dropoff_at	string	false	The start of the drop off window for OnDemand orders in the format YYYY-MM-DDTHH:mm:ss+HH:mm
dropoff_deadline_at	string	false	The end of the drop off window for OnDemand orders in the format YYYY-MM-DDTHH:mm:ss+HH:mm
delivery_company	string	false	Company name for the delivery
delivery_address	string	true	Delivery address for the order
delivery_suburb	string	true	Delivery suburb for the order
delivery_state	string	true	Delivery state for the order. Australian States valid options are NSW, QLD, ACT, WA, NT, SA, VIC, TAS
delivery_postcode	string	true	Delivery postcode for the order
delivery_country_code	string	false	Two letter country code
delivery_timezone	string	false	Time zone for the delivery
delivery_instructions	string	false	Special delivery instructions for the order, limited to 55 characters
state	string	false	The state of the order
user_attributes	Array, see table	false	Represents the customer details attached to the order.
parcel_attributes	Array, see table	true	An array of parcel specifications to be included in the order. There is a maximum of 1000 parcels per request. Each item can be used to specify the qty, dimensions, and other information about the products being shipped, and the parcel used to ship it. If the Allocate each item in an order to a separate carton setting is enabled in the Shippit administration page, then each item is assigned a separate parcel according to the dimensions given. Otherwise, Shippit may combine multiple items into a single parcel. If the product_attributes field is present, then product information is specified in entries there, separate from the parcel information. In which case each parcel entry represents a single parcel.
product_attributes	Array, see table	false	an array of product details. If this is present, each item in parcel_attributes represents a separate parcel, while each line in product_attributes represents a product line item. There is a maximum of 1000 parcels per request.

Response schema for customs_clearance_attributes

Name	Type	Required	Description
tax_id_type	string	false	The Shippier’s tax id type which is passed to a carrier for the purpose of customs clearance. Valid values include: - EORI - IOSS - LVG - OSR - VOEC - VAT/GST - FTZ - DAN - TAN - DTF - EIN - SSN - DUN - FED - STA - CNP - GBVAT - NZ IRD
tax_id_country_code	string	false	The issuing country of the tax id number in in ISO 3166 Alpha-2 format. eg. GB for Great Britain
tax_id_number	string	false	The tax id number that is declared against this order.
incoterm	string	false	A universal term of trade that defines the responsibility and obligations with the transport of goods. Most commonly used to indicate the responsible party for payment of duties and taxes. Valid values include: - DDU - DDP - EXW - FCA - CPT - CFR - CIP - CIF - DAF - DAT - DAP - DPU - DES - DEQ - FAS - FOB
export_reason	string	false	A term used to indicate the reason for export of dutiable goods. Selected options can affect how your shipment is cleared and how much tax is imposed on your shipment during customs clearance. Example values: - Permanent - Temporary - Return For Repair - Used Exhibition Goods To Origin - Intercompany Use - Commercial Purpose Or Sale - Personal Belongings or Personal Use - Sample - Gift - Return To Origin - Warranty Replacement - Diplomatic Goods - Defence Material
recipient_id	string	false	A free text field to provide a identification number for a recipient. For example, a citizen identification number or passport number which is required for customs clearance for some international destinations. eg: PA1992991
receiver_freight_charge_amount	number	false	The amount charged to the receiver for freight services. This represents the cost that the receiver is responsible for paying as part of the freight or shipping charges.

Response schema for user_attributes

Name	Type	Required	Description
email	string	true	The customer’s email address. Must match regular expression as defined in https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address
first_name	string	true	The customer’s first name. If last_name is not provided, then it is used as the customer’s full name.
last_name	string	false	The customer’s last name
mobile	string	false	Mobile number of the user who purchased the order. This could be different to the person receiving the order.

Response schema for parcel_attributes

Name	Type	Required	Description
package_type	string	false	Set to pallet if the package is a pallet, otherwise leave this field out. You can’t mix pallets with other types of parcels within an order.
weight	number	false	Weight of the parcel in kilos.
depth	number	false	Depth of the parcel in metres
length	number	false	Length of the parcel in metres
width	number	false	Width of the parcel in metres.
label_number	string	false	Parcel number in the carrier system. This is used when the order is a tracking order, to match the parcel number in a carrier against the parcel recorded in shippit.
qty	number	false	conditional – The number of parcels specified by the entry. There is a maximum of 1000 parcels per quote request. Should not be present if a product_attributes key is present in the request. If Allocate each item in an order to a separate carton is enabled in Shippit, a separate parcel is generated for each product listed.

Response schema for product_attributes

Name	Type	Required	Description
title	string	false	conditional – Title or description of the product. Mandatory for international orders with specific couriers.
packed	integer	false	The number of products packed; used in partial orders, or otherwise when the number of products in the parcel is less than the total in the order. If not present, set to product quantity. If this is present, at least 1 item should have packed greater than 0. For international orders, all items should have packed greater than 0.
sku	string	false	conditional – Stock Keeping Unit (SKU) code of the product, for stock keeping purposes. Mandatory on international orders with specific couriers.
product_line_id	string	false	Product line associated with product. Like SKU, this is also for stock keeping purposes, and can be used when SKU would not be enough (e.g. an order containing multiple lines with the same SKU)
origin_country_code	string	false	Two-letter country code (ISO 3166-1 Alpha-2) for the product’s origin country. This is used in customs tracking for International shipments. Defaults to the home country of the Merchant.
location	string	false	Location of the product
dangerous_goods_code	string	false	This is the DG code required when making dangerous goods declarations. Before you can declare orders as having dangerous goods, you must first request for dangerous goods to enabled for your account. Contact Shippit Support or your account manager to have this enabled. DG surcharges are often charged on the weight of the order, so it is recommended to split your order into multiple orders if your order contains either: - both dangerous and non-dangerous goods, or - more than one dangerous goods code
dangerous_goods_text	string	false	Additional information related to dangerous goods being shipped
dangerous_goods_class	string	false	This is the DG class when making dangerous goods declarations.
tariff_code	string	false	Tariff or HS code for international orders declarations
mid_code	string	false	Manufacturer identification code (MID) used for customs declarations. This code identifies the manufacturer of the product and is required for some international shipments, particularly to the United States.
quantity	integer	false	The number of products
price	number	false	Unit price of each product line item. Used in the packing slip and customs declarations. Required for transit protection.