Orders

Orders represent a business transaction between two parties. They typically consist of a collection of line items, a payment method, tax and shipping information, etc. The platform defines various "actions" that can be performed against orders, such as Submit, Approve, Ship, etc. These actions transform the state of the order and often trigger external events such as financial transactions.

Operations

List orders

Request

Security

OAuth2(Required scopes: FullAccessOrderAdminOrderReader)

Path

directionstring(OrderDirection)required

Direction of the order, from the current user's perspective.

Enum:"Incoming""Outgoing""All"

Query

buyerIDstring

ID of the buyer.

supplierIDstring

ID of the supplier.

fromstring

Lower bound of date range that the order was created.

tostring

Upper bound of date range that the order was created.

searchstring

Word or phrase to search for.

searchOnArray of strings

Comma-delimited list of fields to search on.

Items Enum:"ID""FromCompanyID""ToCompanyID""Comments"

searchTypestring(SearchType)

Type of search to perform.

Default:"AnyTerm"

Enum:"AnyTerm""AllTermsAnyField""AllTermsSameField""ExactPhrase""ExactPhrasePrefix"

sortByArray of strings

Comma-delimited list of fields to sort by.

Items Enum:"DateSubmitted""DateCreated""ID""FromCompanyID""ToCompanyID""FromUserID""Status""DateApproved""DateDeclined""DateCanceled"

pageinteger

Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

Default:1

pageSizeinteger, <= 100

Number of results to return per page.

Default:20

filtersobject

An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

curl -i -X GET \
  'https://api.ordercloud.io/v1/orders/{direction}?buyerID=string&supplierID=string&from=string&to=string&search=string&searchOn=ID&searchType=AnyTerm&sortBy=DateSubmitted&page=1&pageSize=20&filters=' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

ItemsArray of objects(Order)

Example:

[
  {
    "ID": "",
    "FromUser": { … },
    "FromCompanyID": "",
    "ToCompanyID": "",
    "FromUserID": "",
    "BillingAddressID": "",
    "BillingAddress": { … },
    "ShippingAddressID": "",
    "Comments": "",
    "LineItemCount": 0,
    "Status": "Unsubmitted",
    "DateCreated": "2018-01-01T00:00:00-06:00",
    "DateSubmitted": "2018-01-01T00:00:00-06:00",
    "DateApproved": "2018-01-01T00:00:00-06:00",
    "DateDeclined": "2018-01-01T00:00:00-06:00",
    "DateCanceled": "2018-01-01T00:00:00-06:00",
    "DateCompleted": "2018-01-01T00:00:00-06:00",
    "LastUpdated": "2018-01-01T00:00:00-06:00",
    "Subtotal": 0,
    "ShippingCost": 0,
    "TaxCost": 0,
    "Gratuity": 0,
    "Fees": 0,
    "BaseDiscount": 0,
    "PromotionDiscount": 0,
    "Currency": "",
    "Total": 0,
    "IsSubmitted": false,
    "SubscriptionID": "",
    "xp": {}
  }
]

Metaobject(Meta)

Response

{
  "Items": [
    { … }
  ],
  "Meta": {
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}