Jetti

1.0.0

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 Required

dropshipEndpoint string | null

Dropship endpoint
name Required / string

Name
replenishmentEndpoint string | null

Replenishment endpoint
saleEndpoint string | null

Sale endpoint

Responses

• 200 object

Successful response
- createdAt string(date-time)
  
  Created at
- dropshipEndpoint string | null
  
  Dropship endpoint
- id integer(int32)
  
  Id
- name Required / string
  
  Name
- replenishmentEndpoint string | null
  
  Replenishment endpoint
- saleEndpoint string | null
  
  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 | null
  
  Dropship endpoint
- id integer(int32)
  
  Id
- name Required / string
  
  Name
- replenishmentEndpoint string | null
  
  Replenishment endpoint
- saleEndpoint string | null
  
  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 Required

createdAt string(date-time)

Created at
dropshipEndpoint string | null

Dropship endpoint
id integer(int32)

Id
name Required / string

Name
replenishmentEndpoint string | null

Replenishment endpoint
saleEndpoint string | null

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 Required

accountingIntegrationId integer(int32) | null

Accounting integration
payload object | array | boolean | integer | number | string

Payload
purchaseInvoiceId integer(int32) | null

Purchase invoice
response object | array | boolean | integer | number | string

Response
saleInvoiceId integer(int32) | null

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) | null
  
  Accounting integration
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- payload object | array | boolean | integer | number | string
  
  Payload
- purchaseInvoiceId integer(int32) | null
  
  Purchase invoice
- response object | array | boolean | integer | number | string
  
  Response
- saleInvoiceId integer(int32) | null
  
  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":{},"purchaseInvoiceId":42,"response":{},"saleInvoiceId":42,"source":"quickbooks","status":"success"}'

Request example

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

Response example (200)

{
  "accountingIntegrationId": 42,
  "createdAt": "2022-05-04T09:42:00+00:00",
  "id": 42,
  "payload": {},
  "purchaseInvoiceId": 42,
  "response": {},
  "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) | null
  
  Accounting integration
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- payload object | array | boolean | integer | number | string
  
  Payload
- purchaseInvoiceId integer(int32) | null
  
  Purchase invoice
- response object | array | boolean | integer | number | string
  
  Response
- saleInvoiceId integer(int32) | null
  
  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": {},
  "purchaseInvoiceId": 42,
  "response": {},
  "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 Required

accountingIntegrationId integer(int32) | null

Accounting integration
createdAt string(date-time)

Created at
id integer(int32)

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

Payload
purchaseInvoiceId integer(int32) | null

Purchase invoice
response object | array | boolean | integer | number | string

Response
saleInvoiceId integer(int32) | null

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":{},"purchaseInvoiceId":42,"response":{},"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": {},
  "purchaseInvoiceId": 42,
  "response": {},
  "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 Required

channelId integer(int32) | null

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

Payload
response object | array | boolean | integer | number | string

Response
saleId integer(int32) | null

Sale
source Required / string | null

Source

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

Responses

• 200 object

Successful response
- channelId integer(int32) | null
  
  Channel
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- payload object | array | boolean | integer | number | string
  
  Payload
- response object | array | boolean | integer | number | string
  
  Response
- saleId integer(int32) | null
  
  Sale
- source Required / string | null
  
  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":{},"response":{},"saleId":42,"source":"other"}'

Request example

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

Response example (200)

{
  "channelId": 42,
  "createdAt": "2022-05-04T09:42:00+00:00",
  "id": 42,
  "payload": {},
  "response": {},
  "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) | null
  
  Channel
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- payload object | array | boolean | integer | number | string
  
  Payload
- response object | array | boolean | integer | number | string
  
  Response
- saleId integer(int32) | null
  
  Sale
- source Required / string | null
  
  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": {},
  "response": {},
  "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 Required

channelId integer(int32) | null

Channel
createdAt string(date-time)

Created at
id integer(int32)

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

Payload
response object | array | boolean | integer | number | string

Response
saleId integer(int32) | null

Sale
source Required / string | null

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":{},"response":{},"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": {},
  "response": {},
  "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 Required

adjustmentReasonId integer(int32) | null

Adjustment reason
automatedImport Required / boolean | null

Automated import

Default value is false.
costPrice Required / number | null

Cost price

Default value is 0.
dataImportId integer(int32) | null

Data import
notes string | null

Notes
quantity Required / integer(int32)

Quantity
stockTakeItemId integer(int32) | null

Stock take item
userId integer(int32) | null

User
variantId Required / integer(int32)

Variant
warehouseId Required / integer(int32)

Warehouse
xeroId string | null

Xero

Responses

• 200 object

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

POST /adjustments.json

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

Request example

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

Response example (200)

{
  "adjustmentReasonId": 42,
  "automatedImport": false,
  "costPrice": 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) | null
  
  Adjustment reason
- automatedImport Required / boolean | null
  
  Automated import
  
  Default value is false.
- costPrice Required / number | null
  
  Cost price
  
  Default value is 0.
- createdAt string(date-time)
  
  Created at
- dataImportId integer(int32) | null
  
  Data import
- id integer(int32)
  
  Id
- notes string | null
  
  Notes
- quantity Required / integer(int32)
  
  Quantity
- stockTakeItemId integer(int32) | null
  
  Stock take item
- updatedAt string(date-time)
  
  Updated at
- userId integer(int32) | null
  
  User
- variantId Required / integer(int32)
  
  Variant
- warehouseId Required / integer(int32)
  
  Warehouse
- xeroId string | null
  
  Xero

GET /adjustments/{id}.json

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

Response example (200)

{
  "adjustmentReasonId": 42,
  "automatedImport": false,
  "costPrice": 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 Required

adjustmentReasonId integer(int32) | null

Adjustment reason
automatedImport Required / boolean | null

Automated import

Default value is false.
costPrice Required / number | null

Cost price

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

Created at
dataImportId integer(int32) | null

Data import
id integer(int32)

Id
notes string | null

Notes
quantity Required / integer(int32)

Quantity
stockTakeItemId integer(int32) | null

Stock take item
updatedAt string(date-time)

Updated at
userId integer(int32) | null

User
variantId Required / integer(int32)

Variant
warehouseId Required / integer(int32)

Warehouse
xeroId string | null

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":false,"costPrice":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": false,
  "costPrice": 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 Required

code Required / string

Code
name Required / string

Name
showInReturnsPortal Required / boolean | null

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 | null
  
  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 | null
  
  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 Required

code Required / string

Code
createdAt string(date-time)

Created at
id integer(int32)

Id
name Required / string

Name
showInReturnsPortal Required / boolean | null

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 Required

files Required / object | array | boolean | integer | number | string

Files
filesRequired Required / boolean | null

Files required

Default value is false.
instructions string | null

Instructions
name Required / string

Name
status Required / string | null

Status

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

Responses

• 200 object

Successful response
- createdAt string(date-time)
  
  Created at
- files Required / object | array | boolean | integer | number | string
  
  Files
- filesRequired Required / boolean | null
  
  Files required
  
  Default value is false.
- id integer(int32)
  
  Id
- instructions string | null
  
  Instructions
- name Required / string
  
  Name
- status Required / string | null
  
  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":{},"filesRequired":false,"instructions":"string","name":"string","status":"draft"}'

Request example

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

Response example (200)

{
  "createdAt": "2022-05-04T09:42:00+00:00",
  "files": {},
  "filesRequired": false,
  "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 / object | array | boolean | integer | number | string
  
  Files
- filesRequired Required / boolean | null
  
  Files required
  
  Default value is false.
- id integer(int32)
  
  Id
- instructions string | null
  
  Instructions
- name Required / string
  
  Name
- status Required / string | null
  
  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": {},
  "filesRequired": false,
  "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 Required

createdAt string(date-time)

Created at
files Required / object | array | boolean | integer | number | string

Files
filesRequired Required / boolean | null

Files required

Default value is false.
id integer(int32)

Id
instructions string | null

Instructions
name Required / string

Name
status Required / string | null

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":{},"filesRequired":false,"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": {},
  "filesRequired": false,
  "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 Required

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 Required

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 Required

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 Required

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