Jetti

Jetti API Documentation

This is the documentation for version 1.0.0 of the API. Last update on Sep 8, 2021.

Base URL

http://api.example.com/v1

Accounting integration

Operations

POST: /accounting-integrations.json
GET: /accounting-integrations/{id}.json
PUT: /accounting-integrations/{id}.json
DELETE: /accounting-integrations/{id}.json

POST /accounting-integrations.json

Body

dropshipEndpoint string

Dropship endpoint
name Required / string

Name
replenishmentEndpoint string

Replenishment endpoint
saleEndpoint string

Sale endpoint

Responses

• 200 object

Successful response
- createdAt string(date-time)
  
  Created at
- dropshipEndpoint string
  
  Dropship endpoint
- id integer(int32)
  
  Id
- name Required / string
  
  Name
- replenishmentEndpoint string
  
  Replenishment endpoint
- saleEndpoint string
  
  Sale endpoint
- updatedAt string(date-time)
  
  Updated at

POST /accounting-integrations.json

curl \
 -X POST http://api.example.com/v1/accounting-integrations.json \
 -H "Content-Type: application/json" \
 -d '{"dropshipEndpoint":"string","name":"string","replenishmentEndpoint":"string","saleEndpoint":"string"}'

Request example

{
  "dropshipEndpoint": "string",
  "name": "string",
  "replenishmentEndpoint": "string",
  "saleEndpoint": "string"
}

Response example (200)

{
  "createdAt": "2022-05-04T09:42:00+00:00",
  "dropshipEndpoint": "string",
  "id": 42,
  "name": "string",
  "replenishmentEndpoint": "string",
  "saleEndpoint": "string",
  "updatedAt": "2022-05-04T09:42:00+00:00"
}

GET /accounting-integrations/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Responses

• 200 object

Successful response
- createdAt string(date-time)
  
  Created at
- dropshipEndpoint string
  
  Dropship endpoint
- id integer(int32)
  
  Id
- name Required / string
  
  Name
- replenishmentEndpoint string
  
  Replenishment endpoint
- saleEndpoint string
  
  Sale endpoint
- updatedAt string(date-time)
  
  Updated at

GET /accounting-integrations/{id}.json

curl \
 -X GET http://api.example.com/v1/accounting-integrations/{id}.json

Response example (200)

{
  "createdAt": "2022-05-04T09:42:00+00:00",
  "dropshipEndpoint": "string",
  "id": 42,
  "name": "string",
  "replenishmentEndpoint": "string",
  "saleEndpoint": "string",
  "updatedAt": "2022-05-04T09:42:00+00:00"
}

PUT /accounting-integrations/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Body

createdAt string(date-time)

Created at
dropshipEndpoint string

Dropship endpoint
id integer(int32)

Id
name Required / string

Name
replenishmentEndpoint string

Replenishment endpoint
saleEndpoint string

Sale endpoint
updatedAt string(date-time)

Updated at

PUT /accounting-integrations/{id}.json

curl \
 -X PUT http://api.example.com/v1/accounting-integrations/{id}.json \
 -H "Content-Type: application/json" \
 -d '{"createdAt":"2022-05-04T09:42:00+00:00","dropshipEndpoint":"string","id":42,"name":"string","replenishmentEndpoint":"string","saleEndpoint":"string","updatedAt":"2022-05-04T09:42:00+00:00"}'

Request example

{
  "createdAt": "2022-05-04T09:42:00+00:00",
  "dropshipEndpoint": "string",
  "id": 42,
  "name": "string",
  "replenishmentEndpoint": "string",
  "saleEndpoint": "string",
  "updatedAt": "2022-05-04T09:42:00+00:00"
}

DELETE /accounting-integrations/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

DELETE /accounting-integrations/{id}.json

curl \
 -X DELETE http://api.example.com/v1/accounting-integrations/{id}.json

Accounting payload

Operations

POST: /accounting-payloads.json
GET: /accounting-payloads/{id}.json
PUT: /accounting-payloads/{id}.json
DELETE: /accounting-payloads/{id}.json

POST /accounting-payloads.json

Body

accountingIntegrationId integer(int32)

Accounting integration
payload

Payload
purchaseInvoiceId integer(int32)

Purchase invoice
response

Response
saleInvoiceId integer(int32)

Sale invoice
source Required / string

Source

Values are quickbooks, xero, or custom.
status Required / string

Status

Values are success or error.

Responses

• 200 object

Successful response
- accountingIntegrationId integer(int32)
  
  Accounting integration
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- payload
  
  Payload
- purchaseInvoiceId integer(int32)
  
  Purchase invoice
- response
  
  Response
- saleInvoiceId integer(int32)
  
  Sale invoice
- source Required / string
  
  Source
  
  Values are quickbooks, xero, or custom.
- status Required / string
  
  Status
  
  Values are success or error.
- updatedAt string(date-time)
  
  Updated at

POST /accounting-payloads.json

curl \
 -X POST http://api.example.com/v1/accounting-payloads.json \
 -H "Content-Type: application/json" \
 -d '{"accountingIntegrationId":42,"payload":"string","purchaseInvoiceId":42,"response":"string","saleInvoiceId":42,"source":"quickbooks","status":"success"}'

Request example

{
  "accountingIntegrationId": 42,
  "payload": "string",
  "purchaseInvoiceId": 42,
  "response": "string",
  "saleInvoiceId": 42,
  "source": "quickbooks",
  "status": "success"
}

Response example (200)

{
  "accountingIntegrationId": 42,
  "createdAt": "2022-05-04T09:42:00+00:00",
  "id": 42,
  "payload": "string",
  "purchaseInvoiceId": 42,
  "response": "string",
  "saleInvoiceId": 42,
  "source": "quickbooks",
  "status": "success",
  "updatedAt": "2022-05-04T09:42:00+00:00"
}

GET /accounting-payloads/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Responses

• 200 object

Successful response
- accountingIntegrationId integer(int32)
  
  Accounting integration
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- payload
  
  Payload
- purchaseInvoiceId integer(int32)
  
  Purchase invoice
- response
  
  Response
- saleInvoiceId integer(int32)
  
  Sale invoice
- source Required / string
  
  Source
  
  Values are quickbooks, xero, or custom.
- status Required / string
  
  Status
  
  Values are success or error.
- updatedAt string(date-time)
  
  Updated at

GET /accounting-payloads/{id}.json

curl \
 -X GET http://api.example.com/v1/accounting-payloads/{id}.json

Response example (200)

{
  "accountingIntegrationId": 42,
  "createdAt": "2022-05-04T09:42:00+00:00",
  "id": 42,
  "payload": "string",
  "purchaseInvoiceId": 42,
  "response": "string",
  "saleInvoiceId": 42,
  "source": "quickbooks",
  "status": "success",
  "updatedAt": "2022-05-04T09:42:00+00:00"
}

PUT /accounting-payloads/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Body

accountingIntegrationId integer(int32)

Accounting integration
createdAt string(date-time)

Created at
id integer(int32)

Id
payload

Payload
purchaseInvoiceId integer(int32)

Purchase invoice
response

Response
saleInvoiceId integer(int32)

Sale invoice
source Required / string

Source

Values are quickbooks, xero, or custom.
status Required / string

Status

Values are success or error.
updatedAt string(date-time)

Updated at

PUT /accounting-payloads/{id}.json

curl \
 -X PUT http://api.example.com/v1/accounting-payloads/{id}.json \
 -H "Content-Type: application/json" \
 -d '{"accountingIntegrationId":42,"createdAt":"2022-05-04T09:42:00+00:00","id":42,"payload":"string","purchaseInvoiceId":42,"response":"string","saleInvoiceId":42,"source":"quickbooks","status":"success","updatedAt":"2022-05-04T09:42:00+00:00"}'

Request example

{
  "accountingIntegrationId": 42,
  "createdAt": "2022-05-04T09:42:00+00:00",
  "id": 42,
  "payload": "string",
  "purchaseInvoiceId": 42,
  "response": "string",
  "saleInvoiceId": 42,
  "source": "quickbooks",
  "status": "success",
  "updatedAt": "2022-05-04T09:42:00+00:00"
}

DELETE /accounting-payloads/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

DELETE /accounting-payloads/{id}.json

curl \
 -X DELETE http://api.example.com/v1/accounting-payloads/{id}.json

Address validation

Operations

POST: /address-validations.json
GET: /address-validations/{id}.json
PUT: /address-validations/{id}.json
DELETE: /address-validations/{id}.json

POST /address-validations.json

Body

channelId integer(int32)

Channel
payload

Payload
response

Response
saleId integer(int32)

Sale
source Required / string

Source

Values are other, custom, or shippo. Default value is other.

Responses

• 200 object

Successful response
- channelId integer(int32)
  
  Channel
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- payload
  
  Payload
- response
  
  Response
- saleId integer(int32)
  
  Sale
- source Required / string
  
  Source
  
  Values are other, custom, or shippo. Default value is other.
- updatedAt string(date-time)
  
  Updated at

POST /address-validations.json

curl \
 -X POST http://api.example.com/v1/address-validations.json \
 -H "Content-Type: application/json" \
 -d '{"channelId":42,"payload":"string","response":"string","saleId":42,"source":"other"}'

Request example

{
  "channelId": 42,
  "payload": "string",
  "response": "string",
  "saleId": 42,
  "source": "other"
}

Response example (200)

{
  "channelId": 42,
  "createdAt": "2022-05-04T09:42:00+00:00",
  "id": 42,
  "payload": "string",
  "response": "string",
  "saleId": 42,
  "source": "other",
  "updatedAt": "2022-05-04T09:42:00+00:00"
}

GET /address-validations/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Responses

• 200 object

Successful response
- channelId integer(int32)
  
  Channel
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- payload
  
  Payload
- response
  
  Response
- saleId integer(int32)
  
  Sale
- source Required / string
  
  Source
  
  Values are other, custom, or shippo. Default value is other.
- updatedAt string(date-time)
  
  Updated at

GET /address-validations/{id}.json

curl \
 -X GET http://api.example.com/v1/address-validations/{id}.json

Response example (200)

{
  "channelId": 42,
  "createdAt": "2022-05-04T09:42:00+00:00",
  "id": 42,
  "payload": "string",
  "response": "string",
  "saleId": 42,
  "source": "other",
  "updatedAt": "2022-05-04T09:42:00+00:00"
}

PUT /address-validations/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Body

channelId integer(int32)

Channel
createdAt string(date-time)

Created at
id integer(int32)

Id
payload

Payload
response

Response
saleId integer(int32)

Sale
source Required / string

Source

Values are other, custom, or shippo. Default value is other.
updatedAt string(date-time)

Updated at

PUT /address-validations/{id}.json

curl \
 -X PUT http://api.example.com/v1/address-validations/{id}.json \
 -H "Content-Type: application/json" \
 -d '{"channelId":42,"createdAt":"2022-05-04T09:42:00+00:00","id":42,"payload":"string","response":"string","saleId":42,"source":"other","updatedAt":"2022-05-04T09:42:00+00:00"}'

Request example

{
  "channelId": 42,
  "createdAt": "2022-05-04T09:42:00+00:00",
  "id": 42,
  "payload": "string",
  "response": "string",
  "saleId": 42,
  "source": "other",
  "updatedAt": "2022-05-04T09:42:00+00:00"
}

DELETE /address-validations/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

DELETE /address-validations/{id}.json

curl \
 -X DELETE http://api.example.com/v1/address-validations/{id}.json

Adjustment

Operations

POST: /adjustments.json
GET: /adjustments/{id}.json
PUT: /adjustments/{id}.json
DELETE: /adjustments/{id}.json

POST /adjustments.json

Body

adjustmentReasonId integer(int32)

Adjustment reason
automatedImport Required / boolean

Automated import
costPrice Required / number

Cost price

Default value is 0.
dataImportId integer(int32)

Data import
notes string

Notes
quantity Required / integer(int32)

Quantity
stockTakeItemId integer(int32)

Stock take item
userId integer(int32)

User
variantId Required / integer(int32)

Variant
warehouseId Required / integer(int32)

Warehouse
xeroId string

Xero

Responses

• 200 object

Successful response
- adjustmentReasonId integer(int32)
  
  Adjustment reason
- automatedImport Required / boolean
  
  Automated import
- costPrice Required / number
  
  Cost price
  
  Default value is 0.
- createdAt string(date-time)
  
  Created at
- dataImportId integer(int32)
  
  Data import
- id integer(int32)
  
  Id
- notes string
  
  Notes
- quantity Required / integer(int32)
  
  Quantity
- stockTakeItemId integer(int32)
  
  Stock take item
- updatedAt string(date-time)
  
  Updated at
- userId integer(int32)
  
  User
- variantId Required / integer(int32)
  
  Variant
- warehouseId Required / integer(int32)
  
  Warehouse
- xeroId string
  
  Xero

POST /adjustments.json

curl \
 -X POST http://api.example.com/v1/adjustments.json \
 -H "Content-Type: application/json" \
 -d '{"adjustmentReasonId":42,"automatedImport":true,"costPrice":42.0,"dataImportId":42,"notes":"string","quantity":42,"stockTakeItemId":42,"userId":42,"variantId":42,"warehouseId":42,"xeroId":"string"}'

Request example

{
  "adjustmentReasonId": 42,
  "automatedImport": true,
  "costPrice": 42.0,
  "dataImportId": 42,
  "notes": "string",
  "quantity": 42,
  "stockTakeItemId": 42,
  "userId": 42,
  "variantId": 42,
  "warehouseId": 42,
  "xeroId": "string"
}

Response example (200)

{
  "adjustmentReasonId": 42,
  "automatedImport": true,
  "costPrice": 42.0,
  "createdAt": "2022-05-04T09:42:00+00:00",
  "dataImportId": 42,
  "id": 42,
  "notes": "string",
  "quantity": 42,
  "stockTakeItemId": 42,
  "updatedAt": "2022-05-04T09:42:00+00:00",
  "userId": 42,
  "variantId": 42,
  "warehouseId": 42,
  "xeroId": "string"
}

GET /adjustments/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Responses

• 200 object

Successful response
- adjustmentReasonId integer(int32)
  
  Adjustment reason
- automatedImport Required / boolean
  
  Automated import
- costPrice Required / number
  
  Cost price
  
  Default value is 0.
- createdAt string(date-time)
  
  Created at
- dataImportId integer(int32)
  
  Data import
- id integer(int32)
  
  Id
- notes string
  
  Notes
- quantity Required / integer(int32)
  
  Quantity
- stockTakeItemId integer(int32)
  
  Stock take item
- updatedAt string(date-time)
  
  Updated at
- userId integer(int32)
  
  User
- variantId Required / integer(int32)
  
  Variant
- warehouseId Required / integer(int32)
  
  Warehouse
- xeroId string
  
  Xero

GET /adjustments/{id}.json

curl \
 -X GET http://api.example.com/v1/adjustments/{id}.json

Response example (200)

{
  "adjustmentReasonId": 42,
  "automatedImport": true,
  "costPrice": 42.0,
  "createdAt": "2022-05-04T09:42:00+00:00",
  "dataImportId": 42,
  "id": 42,
  "notes": "string",
  "quantity": 42,
  "stockTakeItemId": 42,
  "updatedAt": "2022-05-04T09:42:00+00:00",
  "userId": 42,
  "variantId": 42,
  "warehouseId": 42,
  "xeroId": "string"
}

PUT /adjustments/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Body

adjustmentReasonId integer(int32)

Adjustment reason
automatedImport Required / boolean

Automated import
costPrice Required / number

Cost price

Default value is 0.
createdAt string(date-time)

Created at
dataImportId integer(int32)

Data import
id integer(int32)

Id
notes string

Notes
quantity Required / integer(int32)

Quantity
stockTakeItemId integer(int32)

Stock take item
updatedAt string(date-time)

Updated at
userId integer(int32)

User
variantId Required / integer(int32)

Variant
warehouseId Required / integer(int32)

Warehouse
xeroId string

Xero

PUT /adjustments/{id}.json

curl \
 -X PUT http://api.example.com/v1/adjustments/{id}.json \
 -H "Content-Type: application/json" \
 -d '{"adjustmentReasonId":42,"automatedImport":true,"costPrice":42.0,"createdAt":"2022-05-04T09:42:00+00:00","dataImportId":42,"id":42,"notes":"string","quantity":42,"stockTakeItemId":42,"updatedAt":"2022-05-04T09:42:00+00:00","userId":42,"variantId":42,"warehouseId":42,"xeroId":"string"}'

Request example

{
  "adjustmentReasonId": 42,
  "automatedImport": true,
  "costPrice": 42.0,
  "createdAt": "2022-05-04T09:42:00+00:00",
  "dataImportId": 42,
  "id": 42,
  "notes": "string",
  "quantity": 42,
  "stockTakeItemId": 42,
  "updatedAt": "2022-05-04T09:42:00+00:00",
  "userId": 42,
  "variantId": 42,
  "warehouseId": 42,
  "xeroId": "string"
}

DELETE /adjustments/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

DELETE /adjustments/{id}.json

curl \
 -X DELETE http://api.example.com/v1/adjustments/{id}.json

Adjustment reason

Operations

POST: /adjustment-reasons.json
GET: /adjustment-reasons/{id}.json
PUT: /adjustment-reasons/{id}.json
DELETE: /adjustment-reasons/{id}.json

POST /adjustment-reasons.json

Body

code Required / string

Code
name Required / string

Name
showInReturnsPortal Required / boolean

Show in returns portal

Default value is true.

Responses

• 200 object

Successful response
- code Required / string
  
  Code
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- name Required / string
  
  Name
- showInReturnsPortal Required / boolean
  
  Show in returns portal
  
  Default value is true.
- updatedAt string(date-time)
  
  Updated at

POST /adjustment-reasons.json

curl \
 -X POST http://api.example.com/v1/adjustment-reasons.json \
 -H "Content-Type: application/json" \
 -d '{"code":"string","name":"string","showInReturnsPortal":true}'

Request example

{
  "code": "string",
  "name": "string",
  "showInReturnsPortal": true
}

Response example (200)

{
  "code": "string",
  "createdAt": "2022-05-04T09:42:00+00:00",
  "id": 42,
  "name": "string",
  "showInReturnsPortal": true,
  "updatedAt": "2022-05-04T09:42:00+00:00"
}

GET /adjustment-reasons/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Responses

• 200 object

Successful response
- code Required / string
  
  Code
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- name Required / string
  
  Name
- showInReturnsPortal Required / boolean
  
  Show in returns portal
  
  Default value is true.
- updatedAt string(date-time)
  
  Updated at

GET /adjustment-reasons/{id}.json

curl \
 -X GET http://api.example.com/v1/adjustment-reasons/{id}.json

Response example (200)

{
  "code": "string",
  "createdAt": "2022-05-04T09:42:00+00:00",
  "id": 42,
  "name": "string",
  "showInReturnsPortal": true,
  "updatedAt": "2022-05-04T09:42:00+00:00"
}

PUT /adjustment-reasons/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Body

code Required / string

Code
createdAt string(date-time)

Created at
id integer(int32)

Id
name Required / string

Name
showInReturnsPortal Required / boolean

Show in returns portal

Default value is true.
updatedAt string(date-time)

Updated at

PUT /adjustment-reasons/{id}.json

curl \
 -X PUT http://api.example.com/v1/adjustment-reasons/{id}.json \
 -H "Content-Type: application/json" \
 -d '{"code":"string","createdAt":"2022-05-04T09:42:00+00:00","id":42,"name":"string","showInReturnsPortal":true,"updatedAt":"2022-05-04T09:42:00+00:00"}'

Request example

{
  "code": "string",
  "createdAt": "2022-05-04T09:42:00+00:00",
  "id": 42,
  "name": "string",
  "showInReturnsPortal": true,
  "updatedAt": "2022-05-04T09:42:00+00:00"
}

DELETE /adjustment-reasons/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

DELETE /adjustment-reasons/{id}.json

curl \
 -X DELETE http://api.example.com/v1/adjustment-reasons/{id}.json

Agreement

Operations

POST: /agreements.json
GET: /agreements/{id}.json
PUT: /agreements/{id}.json
DELETE: /agreements/{id}.json

POST /agreements.json

Body

files Required /

Files
filesRequired Required / boolean

Files required
instructions string

Instructions
name Required / string

Name
status Required / string

Status

Values are draft, active, or archived. Default value is draft.

Responses

• 200 object

Successful response
- createdAt string(date-time)
  
  Created at
- files Required /
  
  Files
- filesRequired Required / boolean
  
  Files required
- id integer(int32)
  
  Id
- instructions string
  
  Instructions
- name Required / string
  
  Name
- status Required / string
  
  Status
  
  Values are draft, active, or archived. Default value is draft.
- updatedAt string(date-time)
  
  Updated at

POST /agreements.json

curl \
 -X POST http://api.example.com/v1/agreements.json \
 -H "Content-Type: application/json" \
 -d '{"files":"string","filesRequired":true,"instructions":"string","name":"string","status":"draft"}'

Request example

{
  "files": "string",
  "filesRequired": true,
  "instructions": "string",
  "name": "string",
  "status": "draft"
}

Response example (200)

{
  "createdAt": "2022-05-04T09:42:00+00:00",
  "files": "string",
  "filesRequired": true,
  "id": 42,
  "instructions": "string",
  "name": "string",
  "status": "draft",
  "updatedAt": "2022-05-04T09:42:00+00:00"
}

GET /agreements/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Responses

• 200 object

Successful response
- createdAt string(date-time)
  
  Created at
- files Required /
  
  Files
- filesRequired Required / boolean
  
  Files required
- id integer(int32)
  
  Id
- instructions string
  
  Instructions
- name Required / string
  
  Name
- status Required / string
  
  Status
  
  Values are draft, active, or archived. Default value is draft.
- updatedAt string(date-time)
  
  Updated at

GET /agreements/{id}.json

curl \
 -X GET http://api.example.com/v1/agreements/{id}.json

Response example (200)

{
  "createdAt": "2022-05-04T09:42:00+00:00",
  "files": "string",
  "filesRequired": true,
  "id": 42,
  "instructions": "string",
  "name": "string",
  "status": "draft",
  "updatedAt": "2022-05-04T09:42:00+00:00"
}

PUT /agreements/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Body

createdAt string(date-time)

Created at
files Required /

Files
filesRequired Required / boolean

Files required
id integer(int32)

Id
instructions string

Instructions
name Required / string

Name
status Required / string

Status

Values are draft, active, or archived. Default value is draft.
updatedAt string(date-time)

Updated at

PUT /agreements/{id}.json

curl \
 -X PUT http://api.example.com/v1/agreements/{id}.json \
 -H "Content-Type: application/json" \
 -d '{"createdAt":"2022-05-04T09:42:00+00:00","files":"string","filesRequired":true,"id":42,"instructions":"string","name":"string","status":"draft","updatedAt":"2022-05-04T09:42:00+00:00"}'

Request example

{
  "createdAt": "2022-05-04T09:42:00+00:00",
  "files": "string",
  "filesRequired": true,
  "id": 42,
  "instructions": "string",
  "name": "string",
  "status": "draft",
  "updatedAt": "2022-05-04T09:42:00+00:00"
}

DELETE /agreements/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

DELETE /agreements/{id}.json

curl \
 -X DELETE http://api.example.com/v1/agreements/{id}.json

Allowed tag

Operations

POST: /allowed-tags.json
GET: /allowed-tags/{id}.json
PUT: /allowed-tags/{id}.json
DELETE: /allowed-tags/{id}.json

POST /allowed-tags.json

Body

resource Required / string

Resource

Values are all, customers, dropshipments, dropshipProviders, fulfillments, goodsReceipts, purchases, resellers, saleReturns, or sales. Default value is all.
tag Required / string

Tag

Responses

• 200 object

Successful response
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- resource Required / string
  
  Resource
  
  Values are all, customers, dropshipments, dropshipProviders, fulfillments, goodsReceipts, purchases, resellers, saleReturns, or sales. Default value is all.
- tag Required / string
  
  Tag
- updatedAt string(date-time)
  
  Updated at

POST /allowed-tags.json

curl \
 -X POST http://api.example.com/v1/allowed-tags.json \
 -H "Content-Type: application/json" \
 -d '{"resource":"all","tag":"string"}'

Request example

{
  "resource": "all",
  "tag": "string"
}

Response example (200)

{
  "createdAt": "2022-05-04T09:42:00+00:00",
  "id": 42,
  "resource": "all",
  "tag": "string",
  "updatedAt": "2022-05-04T09:42:00+00:00"
}

GET /allowed-tags/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Responses

• 200 object

Successful response
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- resource Required / string
  
  Resource
  
  Values are all, customers, dropshipments, dropshipProviders, fulfillments, goodsReceipts, purchases, resellers, saleReturns, or sales. Default value is all.
- tag Required / string
  
  Tag
- updatedAt string(date-time)
  
  Updated at

GET /allowed-tags/{id}.json

curl \
 -X GET http://api.example.com/v1/allowed-tags/{id}.json

Response example (200)

{
  "createdAt": "2022-05-04T09:42:00+00:00",
  "id": 42,
  "resource": "all",
  "tag": "string",
  "updatedAt": "2022-05-04T09:42:00+00:00"
}

PUT /allowed-tags/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Body

createdAt string(date-time)

Created at
id integer(int32)

Id
resource Required / string

Resource

Values are all, customers, dropshipments, dropshipProviders, fulfillments, goodsReceipts, purchases, resellers, saleReturns, or sales. Default value is all.
tag Required / string

Tag
updatedAt string(date-time)

Updated at

PUT /allowed-tags/{id}.json

curl \
 -X PUT http://api.example.com/v1/allowed-tags/{id}.json \
 -H "Content-Type: application/json" \
 -d '{"createdAt":"2022-05-04T09:42:00+00:00","id":42,"resource":"all","tag":"string","updatedAt":"2022-05-04T09:42:00+00:00"}'

Request example

{
  "createdAt": "2022-05-04T09:42:00+00:00",
  "id": 42,
  "resource": "all",
  "tag": "string",
  "updatedAt": "2022-05-04T09:42:00+00:00"
}

DELETE /allowed-tags/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

DELETE /allowed-tags/{id}.json

curl \
 -X DELETE http://api.example.com/v1/allowed-tags/{id}.json

Amazon account

Operations

POST: /amazon-accounts.json
GET: /amazon-accounts/{id}.json
PUT: /amazon-accounts/{id}.json
DELETE: /amazon-accounts/{id}.json

POST /amazon-accounts.json

Body

authToken Required / string

Auth token
channelId Required / integer(int32)

Channel
marketplaceId Required / string

Marketplace
name Required / string

Name
sellerId Required / string

Seller

Responses

• 200 object

Successful response
- authToken Required / string
  
  Auth token
- channelId Required / integer(int32)
  
  Channel
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- marketplaceId Required / string
  
  Marketplace
- name Required / string
  
  Name
- sellerId Required / string
  
  Seller
- updatedAt string(date-time)
  
  Updated at

POST /amazon-accounts.json

curl \
 -X POST http://api.example.com/v1/amazon-accounts.json \
 -H "Content-Type: application/json" \
 -d '{"authToken":"string","channelId":42,"marketplaceId":"string","name":"string","sellerId":"string"}'

Request example

{
  "authToken": "string",
  "channelId": 42,
  "marketplaceId": "string",
  "name": "string",
  "sellerId": "string"
}

Response example (200)

{
  "authToken": "string",
  "channelId": 42,
  "createdAt": "2022-05-04T09:42:00+00:00",
  "id": 42,
  "marketplaceId": "string",
  "name": "string",
  "sellerId": "string",
  "updatedAt": "2022-05-04T09:42:00+00:00"
}

GET /amazon-accounts/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Responses

• 200 object

Successful response
- authToken Required / string
  
  Auth token
- channelId Required / integer(int32)
  
  Channel
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- marketplaceId Required / string
  
  Marketplace
- name Required / string
  
  Name
- sellerId Required / string
  
  Seller
- updatedAt string(date-time)
  
  Updated at

GET /amazon-accounts/{id}.json

curl \
 -X GET http://api.example.com/v1/amazon-accounts/{id}.json

Response example (200)

{
  "authToken": "string",
  "channelId": 42,
  "createdAt": "2022-05-04T09:42:00+00:00",
  "id": 42,
  "marketplaceId": "string",
  "name": "string",
  "sellerId": "string",
  "updatedAt": "2022-05-04T09:42:00+00:00"
}

PUT /amazon-accounts/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Body

authToken Required / string

Auth token
channelId Required / integer(int32)

Channel
createdAt string(date-time)

Created at
id integer(int32)

Id
marketplaceId Required / string

Marketplace
name Required / string

Name
sellerId Required / string

Seller
updatedAt string(date-time)

Updated at

PUT /amazon-accounts/{id}.json

curl \
 -X PUT http://api.example.com/v1/amazon-accounts/{id}.json \
 -H "Content-Type: application/json" \
 -d '{"authToken":"string","channelId":42,"createdAt":"2022-05-04T09:42:00+00:00","id":42,"marketplaceId":"string","name":"string","sellerId":"string","updatedAt":"2022-05-04T09:42:00+00:00"}'

Request example

{
  "authToken": "string",
  "channelId": 42,
  "createdAt": "2022-05-04T09:42:00+00:00",
  "id": 42,
  "marketplaceId": "string",
  "name": "string",
  "sellerId": "string",
  "updatedAt": "2022-05-04T09:42:00+00:00"
}

DELETE /amazon-accounts/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

DELETE /amazon-accounts/{id}.json

curl \
 -X DELETE http://api.example.com/v1/amazon-accounts/{id}.json

Amazon account report

Operations

POST: /amazon-account-reports.json
GET: /amazon-account-reports/{id}.json
PUT: /amazon-account-reports/{id}.json
DELETE: /amazon-account-reports/{id}.json

POST /amazon-account-reports.json

Body

amazonAccountId Required / integer(int32)

Amazon account
reportId string

Report
reportProcessingStatus Required / string

Report processing status

Values are _SUBMITTED_, _IN_PROGRESS_, _CANCELLED_, _DONE_, or _DONE_NO_DATA_.
reportRequestId Required / string

Report request
reportType Required / string

Report type

Values are _POST_INVENTORY_AVAILABILITY_DATA_.
status Required / string

Status

Values are pending, processing, success, or error. Default value is pending.

Responses

• 200 object

Successful response
- amazonAccountId Required / integer(int32)
  
  Amazon account
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- reportId string
  
  Report
- reportProcessingStatus Required / string
  
  Report processing status
  
  Values are _SUBMITTED_, _IN_PROGRESS_, _CANCELLED_, _DONE_, or _DONE_NO_DATA_.
- reportRequestId Required / string
  
  Report request
- reportType Required / string
  
  Report type
  
  Values are _POST_INVENTORY_AVAILABILITY_DATA_.
- status Required / string
  
  Status
  
  Values are pending, processing, success, or error. Default value is pending.
- updatedAt string(date-time)
  
  Updated at

POST /amazon-account-reports.json

curl \
 -X POST http://api.example.com/v1/amazon-account-reports.json \
 -H "Content-Type: application/json" \
 -d '{"amazonAccountId":42,"reportId":"string","reportProcessingStatus":"_SUBMITTED_","reportRequestId":"string","reportType":"_POST_INVENTORY_AVAILABILITY_DATA_","status":"pending"}'

Request example

{
  "amazonAccountId": 42,
  "reportId": "string",
  "reportProcessingStatus": "_SUBMITTED_",
  "reportRequestId": "string",
  "reportType": "_POST_INVENTORY_AVAILABILITY_DATA_",
  "status": "pending"
}

Response example (200)

{
  "amazonAccountId": 42,
  "createdAt": "2022-05-04T09:42:00+00:00",
  "id": 42,
  "reportId": "string",
  "reportProcessingStatus": "_SUBMITTED_",
  "reportRequestId": "string",
  "reportType": "_POST_INVENTORY_AVAILABILITY_DATA_",
  "status": "pending",
  "updatedAt": "2022-05-04T09:42:00+00:00"
}

GET /amazon-account-reports/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Responses

• 200 object

Successful response
- amazonAccountId Required / integer(int32)
  
  Amazon account
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- reportId string
  
  Report