Remove Order Promotion
The Remove Order Promotion API allows any previously applied promotion code to be removed from the order. It works just like the Add Order Promotion action, only relying on the Order ID and promotion code to perform the task.
The .json address above can be used to access the schema within Postman. An example use of the Remove Order Promotion API follows below, or view the schema or the sample Postman Collection.
The example case will remove the designated promotion from an order:
- Order ID 000000
- Promotion Code “exampleDiscount!”
Removing an order promotion only requires two parameters, and has no optional properties:
|orderID||integer||A unique identifier for the order. The minimum value is “1”.|
|promotionCode||string||The code of the particular discount promotion to be applied.|
The Full Request
This is the entire request that will remove a promotion from an order.
The returned response follows the same structure as the Get Order API, providing information about the order that the promotion was removed from.