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

Create Appeasement

If an order requires appeasement for any reason, that progress should begin with the Create Order Appeasement. This will allow the merchant to confirm details about who is responsible for the appeasement, how much credit they will pay, and other important information.

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

The .json address above can be used to access the schema within Postman. An example use of the Order Appeasement API follows below, or view the schema or the sample Postman Collection.

Example

The example case creates an API call for an appeasement that has the following properties:

  • $2 refund paid by Manufacturer
  • From merchant’s catalog 0
  • User ID 123456

This guide will demonstrate how to put together each section of the request to build this appeasement.

Required Parameters

The minimum required parameters are those that apply to the refund that will be awarded, specifically the person who will be paying it and the amount the customer will receive:

ParameterTypeDescription
creditPayeeenumThe entity who will pay for the credit (KIBO, SHOPATRON, MANUFACTURER, or RETAILER).
creditAmountnumberThe amount to be credited.
creditDescriptionstringThe reason for the credit.
rectifyOrderbooleanShould the order be rectified? The default is “TRUE” so that even if this is not provided in the request, the parameter will be automatically set to the suggested best practice of rectification.

Optional Parameters

Other possible parameters can be provided to specify other details about the appeasement. These variables are:

ParameterTypeDescription
orderAppeasementIDintegerA unique identifier for the appeasement. This ID is set by OMS when created in the system, so it is best to treat it as read-only and not try to set this parameter. The minimum value is “1”.
orderIDintegerA unique identifier for the order. The minimum value is “1”. This ID is set by OMS when created in the system, so it is best to treat it as read-only and not try to set this parameter.
externalOrderIDstringA client-generated unique identifier for the order. This is also a read-only parameter utilized by OMS internally.
creditCreationTimestampstringThe creation time of the credit. Supports date-time format.
manufacturerIDintegerA unique identifier for a manufacturer. This is also a read-only parameter utilized by OMS internally.
catalogIDintegerThe catalog number for the manufacturer. This is also a read-only parameter utilized by OMS internally.
retailerIDintegerA unique identifier for a retailer. The minimum value is “0”.
emailConsumerbooleanIndicates whether the consumer should be emailed when the credit is created.
userIDintegerA unique identifier for a user. The minimum value is “0”.
needToRectifybooleanWhether rectification is appropriate for the order. This is a ready-only parameter, so do not attempt to set it – use rectifyOrder instead.
rectifyAmountnumber The amount to charge or refund for the order to be financially settled .

The Full Request

This is the entire request that will create an appeasement. It is clearly lists the example’s key characteristics, with additional parameters defined where necessary.

This example is a simple refund that is not tied to a particular order, but it may be a good idea to specify an Order ID or External Order ID. Later, this will allow the appeasement to be searched for by its associated order.

{
    "creditPayee": "MANUFACTURER",
    "creditAmount": 2,
    "creditDescription": "No Inventory",
    "catalogID": 0,
    "emailConsumer":true,
    "userID":123456
}

The returned response follows the same structure as the Get Appeasement API, providing information about the appeasement that was created.