OrderDocuments

Get Order Documents

get/v1/OrderDocuments

Request

  • Base URL: https://api.channeladvisor.com
  • URL: https://api.channeladvisor.com/v1/OrderDocuments
  • Auth: OAuth 2 (authorization code, authorization URL https://api.channeladvisor.com/oauth2/authorize, token URL https://api.channeladvisor.com/oauth2/token; implicit, authorization URL https://api.channeladvisor.com/oauth2/authorize, scopes: orders, inventory) and HTTP bearer

Query parameters

$topnumber

Show only the first n items

$skipnumber

Skip the first n items

$filterstring

Filter items by property values

$countboolean

Include count of items

$orderbystring[]

Order items by property values

$selectstring[]

Select properties to be returned

$expandstring[]

Expand related entities

Response

Retrieved collection

@odata.countnumber nullable
@odata.nextLinkstring nullable

Example response

{
  "value": [
    {
      "DocumentKey": "string (identifier)",
      "OrderID": 0,
      "ProfileID": 0,
      "CreateDateUtc": "0001-01-01T00:00:00.0000000+00:00",
      "DocumentType": "Unknown",
      "MimeType": "string",
      "DocumentSource": "Unknown",
      "Content": "string",
      "Metadata": [
        {
          "@odata.type": "ChannelAdvisor.RestApi.V1.Models.OrderDocumentMetadata"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.