We have a brand new Developer Portal!

This page will be expiring soon; be sure to bookmark the new link.
Take me there

Create appeasement

Creates an appeasement for customer order.

Request
header Parameters
required
object

x-site-context value

Request Body schema: application/json
orderNumber
required
string

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

appeasementType
string

Appeasement at order level

object

Order customer model

userID
required
string

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

source
required
string

Identifies the system by which the request was initiated

Array of objects

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

Array of objects

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

Responses
200

Appeasement Completed

400

Bad Request

404

Not Found

500

Internal Server Error

post/order/appeasement
Request samples
application/json
{
  • "orderNumber": "123",
  • "appeasementType": "refund",
  • "customer": {
    },
  • "userID": "12",
  • "source": "SFSC",
  • "appeasements": [
    ],
  • "items": [
    ]
}
Response samples
application/json
{
  • "responseCode": "SUCCESS",
  • "responseMessage": "API Operation successfully completed",
  • "responseData": {
    }
}