Models
Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.
2019-01-15 12:12:10A collection in key/value format. Must be flat, with no nested arrays. Keys must be strings, and values must be strings, numbers, booleans, or null.
When the collection is empty, the API returns an empty array ([]) rather than an
empty object. Treat both as "no entries" when parsing.
Current payment status for the order. Defaults to Captured.
CapturedPossible values: Available options are ship, noship, download, or future. Defaults to ship.
shipPossible values: Either success or error.
Describes the result. Always present when an error occurs.
Time taken to process the request.
0.1524 secondsEither success or error.
Describes the result. Always present when an error occurs.
Time taken to process the request.
0.1524 secondsTotal number of records matching the filters, regardless of paging.
128Number of records returned in this response.
50The offset applied to this request.
0The limit applied to this request, after any reduction to the maximum.
50Customer or shipping address details. A first and last name combination or a company name must be entered to be a valid order.
AveryChen1200 Campus DriveStreet address 3. Not available for customer addresses.
Street address 3. Not available for customer addresses.
SpringfieldState or region.
ILZIP or postal code.
62704Country code or full country name.
US555-555-5555If an order has a custom return address, it is entered here. This can be set by a rule, or when the order is inserted through the API.
Return address title.
AcmeShipping name.
Doug JonesAcme Manufacturing817 E Maple LnKnoxvilleState or region.
IL62704Country code or full country name.
USSpring SaleCode used for the discount. Optional.
SPRING10The discount amount. Discounts should be stored as positive numbers.
5There is a 2,000 character max for all notes, including date and username metadata, so keep note content under 1,800 characters to avoid data loss.
Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.
2019-01-15 12:12:10Name of the person who wrote the note.
Doug JonesCustomer asked us to leave this by the back door.An entry in the order's history. History is append-only, and an order holds a maximum of 250 entries.
What wrote this entry.
APIOrder UpdatedDate and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.
2019-01-15 12:12:10ODU Campus Hoodie0Example: 191Example: 21.2Item SKU or product code.
ODU-HOOD-NVY-LAvailable options are ship, noship, download, or future. Defaults to ship.
shipPossible values: Further details about the type of item. Freeform text.
ApparelFulfillment method responsible for this item, when one applies.
Order Desk's internal ID number for the order item. Read-only.
1670028ODU Campus Hoodie0Example: 191Example: 21.2Item SKU or product code.
ODU-HOOD-NVY-LAvailable options are ship, noship, download, or future. Defaults to ship.
shipPossible values: Further details about the type of item. Freeform text.
ApparelFulfillment method responsible for this item, when one applies.
If an id field is passed the item will be updated. Otherwise it will be added.
1670028ODU Campus Hoodie0Example: 191Example: 21.2Item SKU or product code.
ODU-HOOD-NVY-LAvailable options are ship, noship, download, or future. Defaults to ship.
shipPossible values: Further details about the type of item. Freeform text.
ApparelFulfillment method responsible for this item, when one applies.
Carrier-assigned tracking number. Use n/a if no tracking number is applicable.
1Z999AA10123456784Carrier code such as USPS or FedEx, when available.
UPSShipping service name, such as First Class International.
UPS GroundFinal shipment weight.
2.4Your cost to send the shipment.
9.5Current shipment status, used by the EasyPost webhook.
If omitted, Order Desk attempts to determine it from the tracking number format and carrier code.
Carrier-assigned tracking number. Use n/a if no tracking number is applicable.
1Z999AA10123456784Carrier code such as USPS or FedEx, when available.
UPSShipping service name, such as First Class International.
UPS GroundFinal shipment weight.
2.4Your cost to send the shipment.
9.5Current shipment status, used by the EasyPost webhook.
If omitted, Order Desk attempts to determine it from the tracking number format and carrier code.
Order Desk's internal ID for the order this shipment belongs to.
925086Carrier-assigned tracking number. Use n/a if no tracking number is applicable.
1Z999AA10123456784Carrier code such as USPS or FedEx, when available.
UPSShipping service name, such as First Class International.
UPS GroundFinal shipment weight.
2.4Your cost to send the shipment.
9.5Current shipment status, used by the EasyPost webhook.
If omitted, Order Desk attempts to determine it from the tracking number format and carrier code.
4482192508611Carrier-assigned tracking number. Use n/a if no tracking number is applicable.
1Z999AA10123456784Carrier code such as USPS or FedEx, when available.
UPSShipping service name, such as First Class International.
UPS GroundFinal shipment weight.
2.4Your cost to send the shipment.
9.5Current shipment status, used by the EasyPost webhook.
If omitted, Order Desk attempts to determine it from the tracking number format and carrier code.
Format of the stored label, when one exists.
Stored shipping label, when one exists.
Whether the label has been printed.
Shipment ID in the originating cart, when known.
Shipment ID at the label provider, when known.
Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.
2019-01-15 12:12:10Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.
2019-01-15 12:12:10Order fields common to both reads and writes.
Your original order ID. If blank, Order Desk's internal ID will be used.
6487172454Name of the order source, cart, or marketplace. If the source is not recognized or
is not entered, this defaults to Order Desk.
Order DeskExample: FoxyCartavery.chen@example.comName of the selected shipping method.
UPS Ground9.50.52.15Credit card expiration in MM/YYYY format.
02/2026Pattern: ^\d{2}/\d{4}$Gateway transaction ID in <gateway_name>: <transaction_id> format.
Authorize.net Transaction ID: 2221864944Visa, MasterCard, PayPal, etc.
VisaCurrent payment status for the order. Defaults to Captured.
CapturedPossible values: Amount charged at the processor. This is decremented when refunds are made, and
defaults to order_total.
21.17Amount refunded on the order from within Order Desk.
0Customer ID from the originating system.
5487542Customer's IP address.
Once the order has been sent for fulfillment, the fulfillment method name is entered here.
Internal ID of the fulfillment service, when available.
ID of the folder containing the order. New orders default to the first folder when this is omitted. Omitting it on an update leaves the order in its current folder. See the Folders guide.
21654Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.
2019-01-15 12:12:10Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.
2019-01-15 12:12:10AveryChen1200 Campus DriveStreet address 3. Not available for customer addresses.
Street address 3. Not available for customer addresses.
SpringfieldState or region.
ILZIP or postal code.
62704Country code or full country name.
US555-555-5555AveryChen1200 Campus DriveStreet address 3. Not available for customer addresses.
Street address 3. Not available for customer addresses.
SpringfieldState or region.
ILZIP or postal code.
62704Country code or full country name.
US555-555-5555Return address title.
AcmeShipping name.
Doug JonesAcme Manufacturing817 E Maple LnKnoxvilleState or region.
IL62704Country code or full country name.
USSpring SaleCode used for the discount. Optional.
SPRING10The discount amount. Discounts should be stored as positive numbers.
5Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.
2019-01-15 12:12:10Name of the person who wrote the note.
Doug JonesCustomer asked us to leave this by the back door.Order fields common to both reads and writes.
Order Desk's internal ID number. Returned as a string, even though it is always numeric. Read-only.
925086Your original order ID. If blank, Order Desk's internal ID will be used.
6487172454Name of the order source, cart, or marketplace. If the source is not recognized or
is not entered, this defaults to Order Desk.
Order DeskExample: FoxyCartavery.chen@example.comName of the selected shipping method.
UPS Ground9.50.52.15Credit card expiration in MM/YYYY format.
02/2026Pattern: ^\d{2}/\d{4}$Gateway transaction ID in <gateway_name>: <transaction_id> format.
Authorize.net Transaction ID: 2221864944Visa, MasterCard, PayPal, etc.
VisaCurrent payment status for the order. Defaults to Captured.
CapturedPossible values: Amount charged at the processor. This is decremented when refunds are made, and
defaults to order_total.
21.17Amount refunded on the order from within Order Desk.
0Customer ID from the originating system.
5487542Customer's IP address.
Once the order has been sent for fulfillment, the fulfillment method name is entered here.
Internal ID of the fulfillment service, when available.
ID of the folder containing the order. New orders default to the first folder when this is omitted. Omitting it on an update leaves the order in its current folder. See the Folders guide.
21654Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.
2019-01-15 12:12:10Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.
2019-01-15 12:12:10AveryChen1200 Campus DriveStreet address 3. Not available for customer addresses.
Street address 3. Not available for customer addresses.
SpringfieldState or region.
ILZIP or postal code.
62704Country code or full country name.
US555-555-5555AveryChen1200 Campus DriveStreet address 3. Not available for customer addresses.
Street address 3. Not available for customer addresses.
SpringfieldState or region.
ILZIP or postal code.
62704Country code or full country name.
US555-555-5555Return address title.
AcmeShipping name.
Doug JonesAcme Manufacturing817 E Maple LnKnoxvilleState or region.
IL62704Country code or full country name.
USSpring SaleCode used for the discount. Optional.
SPRING10The discount amount. Discounts should be stored as positive numbers.
5Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.
2019-01-15 12:12:10Name of the person who wrote the note.
Doug JonesCustomer asked us to leave this by the back door.Obfuscated credit card number. This is the field returned in responses. Use
cc_number when writing.
xxxxxxxxxxxx4242Total number of all items in the order. Read-only.
3Total weight of all items in the order. Read-only.
3.6Total price of all items in the order. Read-only.
57Total value of all discounts, stored as a positive number. Read-only.
5Calculated price of the entire order. Read-only.
63.65Number of orders matching this email address. Returned as a string, even though it is always numeric. Read-only.
3The folder the order was in before its most recent move. Returned as a string. Read-only.
21654Not in use.
Not in use.
Order Desk's internal ID number for the order item. Read-only.
1670028ODU Campus Hoodie0Example: 191Example: 21.2Item SKU or product code.
ODU-HOOD-NVY-LAvailable options are ship, noship, download, or future. Defaults to ship.
shipPossible values: Further details about the type of item. Freeform text.
ApparelFulfillment method responsible for this item, when one applies.
4482192508611Carrier-assigned tracking number. Use n/a if no tracking number is applicable.
1Z999AA10123456784Carrier code such as USPS or FedEx, when available.
UPSShipping service name, such as First Class International.
UPS GroundFinal shipment weight.
2.4Your cost to send the shipment.
9.5Current shipment status, used by the EasyPost webhook.
If omitted, Order Desk attempts to determine it from the tracking number format and carrier code.
Format of the stored label, when one exists.
Stored shipping label, when one exists.
Whether the label has been printed.
Shipment ID in the originating cart, when known.
Shipment ID at the label provider, when known.
Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.
2019-01-15 12:12:10Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.
2019-01-15 12:12:10What wrote this entry.
APIOrder UpdatedDate and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.
2019-01-15 12:12:10Order fields common to both reads and writes.
Obfuscated credit card number. Enter only the last four digits. Returned as
cc_number_masked.
4242Your original order ID. If blank, Order Desk's internal ID will be used.
6487172454Name of the order source, cart, or marketplace. If the source is not recognized or
is not entered, this defaults to Order Desk.
Order DeskExample: FoxyCartavery.chen@example.comName of the selected shipping method.
UPS Ground9.50.52.15Credit card expiration in MM/YYYY format.
02/2026Pattern: ^\d{2}/\d{4}$Gateway transaction ID in <gateway_name>: <transaction_id> format.
Authorize.net Transaction ID: 2221864944Visa, MasterCard, PayPal, etc.
VisaCurrent payment status for the order. Defaults to Captured.
CapturedPossible values: Amount charged at the processor. This is decremented when refunds are made, and
defaults to order_total.
21.17Amount refunded on the order from within Order Desk.
0Customer ID from the originating system.
5487542Customer's IP address.
Once the order has been sent for fulfillment, the fulfillment method name is entered here.
Internal ID of the fulfillment service, when available.
ID of the folder containing the order. New orders default to the first folder when this is omitted. Omitting it on an update leaves the order in its current folder. See the Folders guide.
21654Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.
2019-01-15 12:12:10Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.
2019-01-15 12:12:10AveryChen1200 Campus DriveStreet address 3. Not available for customer addresses.
Street address 3. Not available for customer addresses.
SpringfieldState or region.
ILZIP or postal code.
62704Country code or full country name.
US555-555-5555AveryChen1200 Campus DriveStreet address 3. Not available for customer addresses.
Street address 3. Not available for customer addresses.
SpringfieldState or region.
ILZIP or postal code.
62704Country code or full country name.
US555-555-5555Return address title.
AcmeShipping name.
Doug JonesAcme Manufacturing817 E Maple LnKnoxvilleState or region.
IL62704Country code or full country name.
USSpring SaleCode used for the discount. Optional.
SPRING10The discount amount. Discounts should be stored as positive numbers.
5Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.
2019-01-15 12:12:10Name of the person who wrote the note.
Doug JonesCustomer asked us to leave this by the back door.If an id field is passed the item will be updated. Otherwise it will be added.
1670028ODU Campus Hoodie0Example: 191Example: 21.2Item SKU or product code.
ODU-HOOD-NVY-LAvailable options are ship, noship, download, or future. Defaults to ship.
shipPossible values: Further details about the type of item. Freeform text.
ApparelFulfillment method responsible for this item, when one applies.
Order fields common to both reads and writes.
Obfuscated credit card number. Enter only the last four digits. Returned as
cc_number_masked.
4242Your original order ID. If blank, Order Desk's internal ID will be used.
6487172454Name of the order source, cart, or marketplace. If the source is not recognized or
is not entered, this defaults to Order Desk.
Order DeskExample: FoxyCartavery.chen@example.comName of the selected shipping method.
UPS Ground9.50.52.15Credit card expiration in MM/YYYY format.
02/2026Pattern: ^\d{2}/\d{4}$Gateway transaction ID in <gateway_name>: <transaction_id> format.
Authorize.net Transaction ID: 2221864944Visa, MasterCard, PayPal, etc.
VisaCurrent payment status for the order. Defaults to Captured.
CapturedPossible values: Amount charged at the processor. This is decremented when refunds are made, and
defaults to order_total.
21.17Amount refunded on the order from within Order Desk.
0Customer ID from the originating system.
5487542Customer's IP address.
Once the order has been sent for fulfillment, the fulfillment method name is entered here.
Internal ID of the fulfillment service, when available.
ID of the folder containing the order. New orders default to the first folder when this is omitted. Omitting it on an update leaves the order in its current folder. See the Folders guide.
21654Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.
2019-01-15 12:12:10Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.
2019-01-15 12:12:10AveryChen1200 Campus DriveStreet address 3. Not available for customer addresses.
Street address 3. Not available for customer addresses.
SpringfieldState or region.
ILZIP or postal code.
62704Country code or full country name.
US555-555-5555AveryChen1200 Campus DriveStreet address 3. Not available for customer addresses.
Street address 3. Not available for customer addresses.
SpringfieldState or region.
ILZIP or postal code.
62704Country code or full country name.
US555-555-5555Return address title.
AcmeShipping name.
Doug JonesAcme Manufacturing817 E Maple LnKnoxvilleState or region.
IL62704Country code or full country name.
USSpring SaleCode used for the discount. Optional.
SPRING10The discount amount. Discounts should be stored as positive numbers.
5Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.
2019-01-15 12:12:10Name of the person who wrote the note.
Doug JonesCustomer asked us to leave this by the back door.If an id field is passed the item will be updated. Otherwise it will be added.
1670028ODU Campus Hoodie0Example: 191Example: 21.2Item SKU or product code.
ODU-HOOD-NVY-LAvailable options are ship, noship, download, or future. Defaults to ship.
shipPossible values: Further details about the type of item. Freeform text.
ApparelFulfillment method responsible for this item, when one applies.
ODU Campus HoodieProduct's unique SKU. This is how Order Desk matches an order line to an inventory record, so it must match the code that your orders arrive with.
ODU-HOOD-NVY-L19Item cost in decimal format.
7.25The shipping weight of the item.
1.2The number of available units.
52The SKU used by the manufacturer. This can be used as print_sku.
GT5000Warehouse or fulfillment method responsible for the item.
Main WarehouseThe name of the last system to update the item's details. Setting this allows those
updates to be excluded later using the update_source_not search parameter.
Warehouse Sync100009ODU Campus HoodieProduct's unique SKU. This is how Order Desk matches an order line to an inventory record, so it must match the code that your orders arrive with.
ODU-HOOD-NVY-L19Item cost in decimal format.
7.25The shipping weight of the item.
1.2The number of available units.
52The SKU used by the manufacturer. This can be used as print_sku.
GT5000Warehouse or fulfillment method responsible for the item.
Main WarehouseThe name of the last system to update the item's details. Setting this allows those
updates to be excluded later using the update_source_not search parameter.
Warehouse SyncDate and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.
2019-01-15 12:12:10Date and time in YYYY-MM-DD HH:MM:SS format. UTC unless otherwise stated.
2019-01-15 12:12:10ODU Campus HoodieProduct's unique SKU. This is how Order Desk matches an order line to an inventory record, so it must match the code that your orders arrive with.
ODU-HOOD-NVY-L19Item cost in decimal format.
7.25The shipping weight of the item.
1.2The number of available units.
52The SKU used by the manufacturer. This can be used as print_sku.
GT5000Warehouse or fulfillment method responsible for the item.
Main WarehouseThe name of the last system to update the item's details. Setting this allows those
updates to be excluded later using the update_source_not search parameter.
Warehouse SyncEach inventory item must include an id field so the correct record can be
properly updated.
100009ODU Campus HoodieProduct's unique SKU. This is how Order Desk matches an order line to an inventory record, so it must match the code that your orders arrive with.
ODU-HOOD-NVY-L19Item cost in decimal format.
7.25The shipping weight of the item.
1.2The number of available units.
52The SKU used by the manufacturer. This can be used as print_sku.
GT5000Warehouse or fulfillment method responsible for the item.
Main WarehouseThe name of the last system to update the item's details. Setting this allows those
updates to be excluded later using the update_source_not search parameter.
Warehouse SyncAn array of Order Desk's internal order IDs.
[29491,29490]The folder ID to which the orders should be moved.
21655The name of the folder to which the orders should be moved. It must match exactly.
PreparedThe store's configuration as set in the Order Desk interface. These settings are read-only through the API. New settings are added over time, so this list should be treated as indicative rather than exhaustive.
The Order Desk application version this store runs on.
Locale used for formatting, such as en_US.
The store's timezone. The _local date filters are relative to this.
Two-letter country code for the store.
Address customer-facing mail is sent from.
Address store notifications are sent to.
Whether addresses are re-capitalized on import. 1 or 0.
Whether phone numbers are reformatted on import. 1 or 0.
PHP date format used for full dates in the interface.
PHP date format used for dates without a time.
How often summary reports are sent.
Period the dashboard reports on, such as daily.
The public URL of the storefront.
Custom CSS applied to the Order Desk interface.
Whether to flag orders shipping to a PO box.
Whether to flag orders whose shipping and customer addresses differ.
Whether to flag orders shipping to a different country.
Whether countries render as codes or full names.
Display name for the all orders view.
The store's API key. The whole response should be treated as sensitive.
SMTP port, when outbound mail is configured.
SMTP host, when outbound mail is configured.
SMTP username, when outbound mail is configured.
SMTP password, when outbound mail is configured.
SMTP encryption mode, when outbound mail is configured.
Extra headers added to outbound mail.
Whether incoming orders decrement inventory automatically.
Whether unknown SKUs create inventory records automatically.
How many orders the interface shows per page.
Quantity above which an order is flagged for review. 0 disables this check.
Maximum characters per address field. 0 means there is no limit.
Legacy duplicate of the normalize_capitalization setting.
11Order Desk UniversityThe Order Desk application version this store runs on.
Locale used for formatting, such as en_US.
The store's timezone. The _local date filters are relative to this.
Two-letter country code for the store.
Address customer-facing mail is sent from.
Address store notifications are sent to.
Whether addresses are re-capitalized on import. 1 or 0.
Whether phone numbers are reformatted on import. 1 or 0.
PHP date format used for full dates in the interface.
PHP date format used for dates without a time.
How often summary reports are sent.
Period the dashboard reports on, such as daily.
The public URL of the storefront.
Custom CSS applied to the Order Desk interface.
Whether to flag orders shipping to a PO box.
Whether to flag orders whose shipping and customer addresses differ.
Whether to flag orders shipping to a different country.
Whether countries render as codes or full names.
Display name for the all orders view.
The store's API key. The whole response should be treated as sensitive.
SMTP port, when outbound mail is configured.
SMTP host, when outbound mail is configured.
SMTP username, when outbound mail is configured.
SMTP password, when outbound mail is configured.
SMTP encryption mode, when outbound mail is configured.
Extra headers added to outbound mail.
Whether incoming orders decrement inventory automatically.
Whether unknown SKUs create inventory records automatically.
How many orders the interface shows per page.
Quantity above which an order is flagged for review. 0 disables this check.
Maximum characters per address field. 0 means there is no limit.
Legacy duplicate of the normalize_capitalization setting.
Last updated
Was this helpful?