POST /sale-imports.json

application/json

Body Required

channelId integer(int32) | null

Channel
emailSent boolean | null Required

Email sent

Default value is false.
externalId string | null

External
payload object | null | array | boolean | integer | number | string

Payload

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
problem object | null | array | boolean | integer | number | string

Problem

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
read boolean | null Required

Read

Default value is true.
saleId integer(int32) | null

Sale
status string | null Required

Status

Values are success, error, or skipped. Default value is success.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- channelId integer(int32) | null
  
  Channel
- createdAt string(date-time)
  
  Created at
- emailSent boolean | null Required
  
  Email sent
  
  Default value is false.
- externalId string | null
  
  External
- id integer(int32)
  
  Id
- payload object | null | array | boolean | integer | number | string
  
  Payload
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
- problem object | null | array | boolean | integer | number | string
  
  Problem
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
- read boolean | null Required
  
  Read
  
  Default value is true.
- saleId integer(int32) | null
  
  Sale
- status string | null Required
  
  Status
  
  Values are success, error, or skipped. Default value is success.
- updatedAt string(date-time)
  
  Updated at

POST /sale-imports.json

curl \
 --request POST 'http://api.example.com/v1/sale-imports.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"channelId":42,"emailSent":false,"externalId":"string","payload":{},"problem":{},"read":true,"saleId":42,"status":"success"}'

Request examples

{
  "channelId": 42,
  "emailSent": false,
  "externalId": "string",
  "payload": {},
  "problem": {},
  "read": true,
  "saleId": 42,
  "status": "success"
}

Response examples (200)

{
  "channelId": 42,
  "createdAt": "2025-05-04T09:42:00Z",
  "emailSent": false,
  "externalId": "string",
  "id": 42,
  "payload": {},
  "problem": {},
  "read": true,
  "saleId": 42,
  "status": "success",
  "updatedAt": "2025-05-04T09:42:00Z"
}

POST /sale-imports.json

Body Required

payload object | null | array | boolean | integer | number | string

problem object | null | array | boolean | integer | number | string

Responses

payload object | null | array | boolean | integer | number | string

problem object | null | array | boolean | integer | number | string