OMS DOCUMENTATIONRESOURCE CENTER

These guides provide examples for many tasks that a developer will need to be familiar with during implementation.

KIBO OMS DEVELOPMENT

Documentation

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.

Version2.0
Callhttps://integration.shopatron.com/api/v2/order/action/removePromotion
Supported FormatsJSON
HTTP MethodPOST
Schemahttps://integration.shopatron.com/api/v2/schema/order/action/removePromotion.json

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.

Example

The example case will remove the designated promotion from an order:

  • Order ID 000000
  • Promotion Code “exampleDiscount!”

Required Parameters

Removing an order promotion only requires two parameters, and has no optional properties:

ParameterTypeDescription
orderIDintegerA unique identifier for the order. The minimum value is “1”.
promotionCodestringThe 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.

{
  "orderID": 00000,
  "promotionCode": "exampleDiscount!"
}

The returned response follows the same structure as the Get Order API, providing information about the order that the promotion was removed from.