List order promotions

Request

Security

OAuth2(Required scopes: FullAccessOrderAdminShopperOrderReader)

Path

directionstring(OrderDirection)required

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

Enum:"Incoming""Outgoing""All"

orderIDstringrequired

ID of the order.

Query

searchstring

Word or phrase to search for.

searchOnArray of strings

Comma-delimited list of fields to search on.

Items Enum:"ID""Name""Code""Description""FinePrint""EligibleExpression""ValueExpression"

sortByArray of strings

Comma-delimited list of fields to sort by.

Items Enum:"Name""ID""Code""DateApplied""StartDate""ExpirationDate""EligibleExpression""ValueExpression""CanCombine""AutoApply"

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}/{orderID}/promotions?search=string&searchOn=ID&sortBy=Name&page=1&pageSize=20&filters=' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

ItemsArray of objects(OrderPromotion)

Example:

[
  {
    "Amount": 0,
    "LineItemID": "",
    "AmountOverridden": false,
    "DateApplied": "2018-01-01T00:00:00-06:00",
    "ID": "",
    "LineItemLevel": false,
    "Code": "",
    "Name": "",
    "RedemptionLimit": 0,
    "RedemptionLimitPerUser": 0,
    "RedemptionCount": 0,
    "QuantityLimitPerOrder": 0,
    "ItemLimitPerOrder": 0,
    "ItemSortBy": "",
    "Description": "",
    "FinePrint": "",
    "StartDate": "2018-01-01T00:00:00-06:00",
    "ExpirationDate": "2018-01-01T00:00:00-06:00",
    "EligibleExpression": "",
    "ValueExpression": "",
    "CanCombine": false,
    "AllowAllBuyers": false,
    "OwnerID": "",
    "AutoApply": false,
    "Active": false,
    "UseIntegration": false,
    "Priority": 0,
    "xp": {}
  }
]

Metaobject(Meta)

Response

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