URL Expired

The URL for this request expired after 30 days.

``200 The requested order collection

object

actionUrlCancel

array

POST to this URL with an empty body to change status to ORDER_CANCELLED. This action also marks all shipments associated with the order as cancelled. Orders in the cancelled state can not be modified.

actionUrlComplete

array

POST to this URL with an empty body to change status to ORDER_COMPLETED. Orders in the completed state can not be modified.

actionUrlEdit

array

POST to this URL with an empty body to change status to ORDER_CREATED which corresponds to the status of editable in the user interface.

actionUrlLock

array

POST to this URL with an empty body to change status to ORDER_LOCKED. The order status must currently be ORDER_CREATED to change the status to locked. Orders in the completed state can not be modified.

batchUrl

array

The unique identifier for the batch the order belongs to.

connectionRelationUrlList

array

contactMechList

array

List of contact mechanisms as defined under resource patterns.

contentList

array

createdDate

array

Timestamp object was created. Set automatically by the server. Read only.

defaultCarrierAccount

array

defaultLabelPurchaseConnectionUrl

array

defaultPackageType

array

defaultService

array

destinationFacilityUrl

array

Reference to destination location. Must not be a sublocation. May be null which corresponds to the value "Multiple / unspecified" in the user interface. Applicable only to purchases.

fulfillmentId

array

Fulfillment service used for delivery (e.g. Freight or Shipstation). Limited to 250 Unicode characters

insuredValueOption

array

invoiceUrlList

array

lastUpdatedDate

array

Timestamp object was last modified. Set automatically by the server. Read only.

orderAdjustmentList

array

Undocumented.

orderAssocList

array

orderCancellationReasonId

array

orderDate

array

orderHistoryListUrl

array

Undocumented.

orderId

array

The unique ID for the order. Can be set when the order is first created, and after that is read only. Limited to 20 ASCII characters.

orderItemList

array

Array representing the items in the order, each having one or more of the following fields:

• itemDescription String of up to 255 characters corresponding to the item note field in the user interface.
• productUrl Reference to the product for this item.
• normalizedPackingString Packing for the item (see resource patterns for description of this data type).
• quantity Floating point value.
• unitListPrice Floating point value for list price of product at time item was created. Applicable only to sales.
• unitPrice Floating point value for price of product used for this order.
• reservedDatetime Date item was reserved or null if not reserved. Read only. Applicable only to sales.
• reserveUrl POST to this URL with an empty body to reserve this item. Applicable only to sales.
• releaseUrl POST to this URL with an empty body to remove reservation for this item. Applicable only to sales.

The order of the items in the array is significant and represents the order they are displayed in the user interface. Order items with no productUrl and no quantity are not displayed and from the standpoint of the user interface no longer exist.

The subtotal for an order item is not part of the API, but is defined to the be quantity value multiplied by the unitPrice value.

The orderItemList fields is not returned when the entire collection of orders is requested. It is only available when requesting individual orders.

Example:

  [ {productUrl:"/demo/api/product/123", quantity:4, itemDescription:"Send red boxes.", unitPrice: 4.2},\
    {productUrl:"/demo/api/product/123", quantity:7, unitListPrice:12.4, unitPrice: 6.2},\
    {productUrl:"/demo/api/product/KJKLA", quantity:9, normalizedPackingString:"12 cs 6/2"} ]

orderItemListTotal

array

orderRoleList

array

Array of relations between the order and party groups containing the customer for sales and supplier for purchases. Party groups represent people or organizations. Each value in the array an object with the keys roleTypeId and partyId. The roleTypeId must be SUPPLIER or CUSTOMER. The partyId must refer to an existing party group in the system.

Note that this is an unusual part of the API because the reference between entities is sent by id instead of URL. In the future, it is likely this reference will be changed to a partyUrl and the partyId will be deprecated.

Currently the user interface only displays the first customer in the array for sales and the first supplier in the array for purchases.

Example:

  orderRoleList: [ {roleTypeId:'CUSTOMER', partyId:'10002'} ]

orderTypeId

array

orderUrl

array

The unique identifier for the order. Read only.

originFacilityUrl

array

Reference to origin location. Must not be a sublocation. May be null which corresponds to the value "Multiple / unspecified" in the user interface. Applicable only to sales.

privateNotes

array

Internal notes field from the user interface. Read and write.

processingFacilityUrl

array

Reference to processing location. Must be a sublocation.

productPriceTypeId

array

Price level to use for this order. Must match productPriceTypeId from the productUserPriceTypeList in the customization service

publicNotes

array

Notes to supplier/customer field from the user interface. Read and write.

quoteUrlList

array

receiveDate

array

For Purchase and Transfer Orders: Estimated Receive Date

recordConnectionUpdateList

array

referenceNumber

array

Customer/supplier reference number. Limited to 60 Unicode characters.

requestedShippingServiceId

array

Shipping service preferred by customer (e.g. Next day). Limited to 250 Unicode characters

reserveAllUrl

array

POST to this URL with an empty body to reserve all items on this order. This is equivalent to reserving each item individually using the item's reserveUrl, but is much faster and atomically reserves all items or fails. Applicable only to sales.

returnUrlList

array

saleSourceId

array

Originating channel of order (e.g. Manual or Shopify). Limited to 250 Unicode characters

settlementTermId

array

Settlement terms (e.g. COD or Net 15). Must match settlementTermId from the settlementTermList in the customization service

shipDate

array

For Sales and Transfers Orders: Estimated Ship Date

shipmentUrlList

array

statusId

array

One of the values ORDER_EMBRYONIC, ORDER_CREATED, ORDER_LOCKED, ORDER_COMPLETED, or ORDER_CANCELLED. Read only.

ORDER_EMBRYONIC is a special status that can only be set when the order is first created, and indicates the order should not appear in the user interface. The ORDER_EMBRYONIC status is used when quotes are first created before they have a corresponding visible order.

Examples of other URLs for order actions:

curl --request GET \
     --url https://app.finaleinventory.com/account/api/order \
     --header 'accept: application/json' \
     --header 'authorization: Basic ••••'