Refresh promotions on an order

Request

Re-calculates promotion discounts, removes promotions that are no longer valid, and adds eligible promotions where AutoApply=true (up to limit of 100)

Security

OAuth2(Required scopes: FullAccessOrderAdminShopper)

Path

directionstring(OrderDirection)required

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

Enum:"Incoming""Outgoing""All"

orderIDstringrequired

ID of the order.

curl -i -X POST \
  'https://api.ordercloud.io/v1/orders/{direction}/{orderID}/refreshpromotions' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Re-calculates promotion discounts, removes promotions that are no longer valid, and adds eligible promotions where AutoApply=true (up to limit of 100)

Bodyapplication/json

PromosAddedArray of objects(AddedPromo)

Promotions that were auto-applied.

Example:

[
  {
    "LineItemID": "",
    "Amount": 0,
    "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": {}
  }
]

PromosRemovedArray of objects(RemovedPromo)

Promotions that were removed due to ineligibility or other reasons.

Example:

[
  {
    "ErrorCode": "",
    "Reason": "",
    "LineItemID": "",
    "Amount": 0,
    "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": {}
  }
]

Response

{
  "PromosAdded": [
    { … }
  ],
  "PromosRemoved": [
    { … }
  ]
}