Create appeasement

Creates an appeasement for customer order.

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Body

application/json

Appeasement request details

orderNumber

string

required

It is required and used as a primary identifier to apply appeasement on an order.

userID

string

required

It is used as identifier of the user who initiates the appeasement request

source

string

required

Identifies the system by which the request was initiated

appeasementType

string

Appeasement at order level

customer

object

Order customer model

Show child attributes

appeasements

object[]

It represents the order-level appeasements. It is necessary to add at least one of the order-level or item-level appeasements.

Show child attributes

items

object[]

It represents the wrapper of item-level appeasements. It is necessary to add at least one of the order-level or item-level appeasements

Show child attributes

Response

200 - application/json

ServiceResponse Model

responseCode

enum<string>

ResponseCodes Model

Available options:

SUCCESS,

ERROR,

NOT_FOUND,

INVALID_REQUEST,

AMOUNT_EXCEEDS,

PAYMENT_NOT_FOUND,

PARTIAL_SUCCESS

responseMessage

string

responseData

object

OrderCreateAppeasementResponse Model

Show child attributes