--- updatedAt: 2026-05-26T21:16:03.000Z agentTools: projectIndex: https://developer.finaleinventory.com/llms.txt --- # Get order collection Returns the order collection # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "REST API", "version": "1.0.0" }, "servers": [ { "url": "https://app.finaleinventory.com/{accountPathComponent}/api", "description": "Production server", "variables": { "accountPathComponent": { "default": "account" } } } ], "security": [ { "basicAuth": [] } ], "tags": [ { "name": "Order" } ], "components": { "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } }, "schemas": { "orderCollection": { "type": "object", "properties": { "actionUrlCancel": { "type": "array", "description": "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": { "type": "array", "description": "POST to this URL with an empty body to change status to `ORDER_COMPLETED`. Orders in the completed state can not be modified." }, "actionUrlEdit": { "type": "array", "description": "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": { "type": "array", "description": "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": { "type": "array", "description": "The unique identifier for the batch the order belongs to." }, "connectionRelationUrlList": { "type": "array" }, "contactMechList": { "type": "array", "description": "List of contact mechanisms as defined under [resource patterns](/reference/resource-patterns)." }, "contentList": { "type": "array" }, "createdDate": { "type": "array", "description": "Timestamp object was created. Set automatically by the server. Read only." }, "defaultCarrierAccount": { "type": "array" }, "defaultLabelPurchaseConnectionUrl": { "type": "array" }, "defaultPackageType": { "type": "array" }, "defaultService": { "type": "array" }, "destinationFacilityUrl": { "type": "array", "description": "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": { "type": "array", "description": "Fulfillment service used for delivery (e.g. Freight or Shipstation). Limited to 250 Unicode characters" }, "incoterm": { "type": "array", "description": "International commercial term for the order, identified with the three letter code (e.g. EXW, FOB or DDP). Optional. Read and write." }, "insuredValueOption": { "type": "array" }, "invoiceUrlList": { "type": "array" }, "lastUpdatedDate": { "type": "array", "description": "Timestamp object was last modified. Set automatically by the server. Read only." }, "orderAdjustmentList": { "type": "array", "description": "Undocumented." }, "orderAssocList": { "type": "array" }, "orderCancellationReasonId": { "type": "array" }, "orderDate": { "type": "array" }, "orderHistoryListUrl": { "type": "array", "description": "Undocumented." }, "orderId": { "type": "array", "description": "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": { "type": "array", "description": "\nArray representing the items in the order, each having one or more of the following fields: \n * __itemDescription__ String of up to 255 characters corresponding to the item note field in the user interface.\n * __productUrl__ Reference to the product for this item.\n * __normalizedPackingString__ Packing for the item (see [resource patterns](/reference/resource-patterns) for description of this data type).\n * __quantity__ Floating point value.\n * __unitListPrice__ Floating point value for list price of product at time item was created. Applicable only to sales.\n * __unitPrice__ Floating point value for price of product used for this order.\n * __reservedDatetime__ Date item was reserved or null if not reserved. Read only. Applicable only to sales.\n * __reserveUrl__ POST to this URL with an empty body to reserve this item. Applicable only to sales.\n * __releaseUrl__ POST to this URL with an empty body to remove reservation for this item. Applicable only to sales.\n\nThe 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.\n\nThe subtotal for an order item is not part of the API, but is defined to the be quantity value multiplied by the unitPrice value.\n\nThe orderItemList fields is not returned when the entire collection of orders is requested. It is only available when requesting individual orders.\n\nExample:\n\n [ {productUrl:\"/demo/api/product/123\", quantity:4, itemDescription:\"Send red boxes.\", unitPrice: 4.2},\n {productUrl:\"/demo/api/product/123\", quantity:7, unitListPrice:12.4, unitPrice: 6.2},\n {productUrl:\"/demo/api/product/KJKLA\", quantity:9, normalizedPackingString:\"12 cs 6/2\"} ]\n\n\n " }, "orderItemListTotal": { "type": "array" }, "orderRoleList": { "type": "array", "description": "\n\nArray 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. \n\nNote 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.\n\nCurrently the user interface only displays the first customer in the array for sales and the first supplier in the array for purchases.\n\nExample:\n\n orderRoleList: [ {roleTypeId:'CUSTOMER', partyId:'10002'} ]\n\n " }, "orderTypeId": { "type": "array", "description": "" }, "orderUrl": { "type": "array", "description": "The unique identifier for the order. Read only." }, "originFacilityUrl": { "type": "array", "description": "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": { "type": "array", "description": "Internal notes field from the user interface. Read and write." }, "processingFacilityUrl": { "type": "array", "description": "Reference to processing location. Must be a sublocation." }, "productPriceTypeId": { "type": "array", "description": "Price level to use for this order. Must match productPriceTypeId from the productUserPriceTypeList in the customization service" }, "publicNotes": { "type": "array", "description": "Notes to supplier/customer field from the user interface. Read and write." }, "quoteUrlList": { "type": "array" }, "reasonForExport": { "type": "array", "description": "Declared purpose of an international shipment for customs (e.g. SALE, GIFT or SAMPLE). Optional. Read and write." }, "receiveDate": { "type": "array", "description": "For Purchase and Transfer Orders: Estimated Receive Date" }, "recordConnectionUpdateList": { "type": "array" }, "referenceNumber": { "type": "array", "description": "Customer/supplier reference number. Limited to 60 Unicode characters." }, "requestedShippingServiceId": { "type": "array", "description": "Shipping service preferred by customer (e.g. Next day). Limited to 250 Unicode characters" }, "reserveAllUrl": { "type": "array", "description": "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": { "type": "array" }, "saleSourceId": { "type": "array", "description": "Originating channel of order (e.g. Manual or Shopify). Limited to 250 Unicode characters" }, "settlementTermId": { "type": "array", "description": "Settlement terms (e.g. COD or Net 15). Must match settlementTermId from the settlementTermList in the customization service" }, "shipDate": { "type": "array", "description": "For Sales and Transfers Orders: Estimated Ship Date" }, "shipmentUrlList": { "type": "array" }, "statusId": { "type": "array", "description": "One of the values `ORDER_EMBRYONIC`, `ORDER_CREATED`, `ORDER_LOCKED`, `ORDER_COMPLETED`, or `ORDER_CANCELLED`. Read only.\n\n`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." }, "tagUrlList": { "type": "array" }, "userFieldDataList": { "type": "array", "description": "\nArray of values for user defined fields on the Order. Each value in the array is an object with the keys __attrName__ and __attrValue__. The __attrName__ is the internal name of a user defined field as listed in the [customization service](/reference/get_customization). Other systems integrating with Finale can store information in the userFieldDataList. Other systems should prefix their __attrName__ with the string \"integration_\" to avoid conflicting with keys created by Finale. The __attrValue__ is the string representation of the value for this Order for the user defined field. The __attrName__ is limited to 60 Unicode characters and the __attrValue__ to 255. To make tracking and syncing changes to other systems, the field __attrValueLastUpdatedDate__ be set instead of the field __attrValue__. When __attrValue__ is not set and __attrValueLastUpdatedDate__ is set to true, then the server sets the value to same value as the __lastUpdatedDate__. This allows easy searching for entities that have been updated since the last time they were synced to an external system.\n\nExample:\n\n userFieldDataList:[ {attrName:'user_10000', attrValue:'7/2/2010'}, {attrName:'integration_10004', attrValue:'3/12/2011'} ]\n\n " }, "varianceUrlList": { "type": "array" } } } } }, "paths": { "/order": { "get": { "tags": [ "Order" ], "summary": "Get order collection", "description": "Returns the order collection", "responses": { "200": { "description": "The requested order collection", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/orderCollection" } } } } } } } } } ```