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

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 string Required
  
  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": "2023-05-04T09:42:00+00:00",
  "dropshipEndpoint": "string",
  "id": 42,
  "name": "string",
  "replenishmentEndpoint": "string",
  "saleEndpoint": "string",
  "updatedAt": "2023-05-04T09:42:00+00:00"
}

GET /accounting-integrations/{id}.json

Path parameters

id integer(int64) Required

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 string Required
  
  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": "2023-05-04T09:42:00+00:00",
  "dropshipEndpoint": "string",
  "id": 42,
  "name": "string",
  "replenishmentEndpoint": "string",
  "saleEndpoint": "string",
  "updatedAt": "2023-05-04T09:42:00+00:00"
}

PUT /accounting-integrations/{id}.json

Path parameters

id integer(int64) Required

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

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":"2023-05-04T09:42:00+00:00","dropshipEndpoint":"string","id":42,"name":"string","replenishmentEndpoint":"string","saleEndpoint":"string","updatedAt":"2023-05-04T09:42:00+00:00"}'

Request example

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

DELETE /accounting-integrations/{id}.json

Path parameters

id integer(int64) Required

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 | null | array | boolean | integer | number | string

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

Payload

Payload

Payload

Payload

Payload

Payload
purchaseInvoiceId integer(int32) | null

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

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

Response

Response

Response

Response

Response

Response
saleInvoiceId integer(int32) | null

Sale invoice
source string Required

Source

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

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 | null | array | boolean | integer | number | string
  
  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
  
  Payload
  
  Payload
  
  Payload
  
  Payload
  
  Payload
  
  Payload
- purchaseInvoiceId integer(int32) | null
  
  Purchase invoice
- response object | null | array | boolean | integer | number | string
  
  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
  
  Response
  
  Response
  
  Response
  
  Response
  
  Response
  
  Response
- saleInvoiceId integer(int32) | null
  
  Sale invoice
- source string Required
  
  Source
  
  Values are quickbooks, xero, or custom.
- status string Required
  
  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": "2023-05-04T09:42:00+00:00",
  "id": 42,
  "payload": {},
  "purchaseInvoiceId": 42,
  "response": {},
  "saleInvoiceId": 42,
  "source": "quickbooks",
  "status": "success",
  "updatedAt": "2023-05-04T09:42:00+00:00"
}

GET /accounting-payloads/{id}.json

Path parameters

id integer(int64) Required

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 | null | array | boolean | integer | number | string
  
  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
  
  Payload
  
  Payload
  
  Payload
  
  Payload
  
  Payload
  
  Payload
- purchaseInvoiceId integer(int32) | null
  
  Purchase invoice
- response object | null | array | boolean | integer | number | string
  
  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
  
  Response
  
  Response
  
  Response
  
  Response
  
  Response
  
  Response
- saleInvoiceId integer(int32) | null
  
  Sale invoice
- source string Required
  
  Source
  
  Values are quickbooks, xero, or custom.
- status string Required
  
  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": "2023-05-04T09:42:00+00:00",
  "id": 42,
  "payload": {},
  "purchaseInvoiceId": 42,
  "response": {},
  "saleInvoiceId": 42,
  "source": "quickbooks",
  "status": "success",
  "updatedAt": "2023-05-04T09:42:00+00:00"
}

PUT /accounting-payloads/{id}.json

Path parameters

id integer(int64) Required

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 | null | array | boolean | integer | number | string

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

Payload

Payload

Payload

Payload

Payload

Payload
purchaseInvoiceId integer(int32) | null

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

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

Response

Response

Response

Response

Response

Response
saleInvoiceId integer(int32) | null

Sale invoice
source string Required

Source

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

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":"2023-05-04T09:42:00+00:00","id":42,"payload":{},"purchaseInvoiceId":42,"response":{},"saleInvoiceId":42,"source":"quickbooks","status":"success","updatedAt":"2023-05-04T09:42:00+00:00"}'

Request example

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

DELETE /accounting-payloads/{id}.json

Path parameters

id integer(int64) Required

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 | null | array | boolean | integer | number | string

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

Payload

Payload

Payload

Payload

Payload

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

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

Response

Response

Response

Response

Response

Response
saleId integer(int32) | null

Sale
source string | null Required

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 | null | array | boolean | integer | number | string
  
  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
  
  Payload
  
  Payload
  
  Payload
  
  Payload
  
  Payload
  
  Payload
- response object | null | array | boolean | integer | number | string
  
  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
  
  Response
  
  Response
  
  Response
  
  Response
  
  Response
  
  Response
- saleId integer(int32) | null
  
  Sale
- source string | null Required
  
  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": "2023-05-04T09:42:00+00:00",
  "id": 42,
  "payload": {},
  "response": {},
  "saleId": 42,
  "source": "other",
  "updatedAt": "2023-05-04T09:42:00+00:00"
}

GET /address-validations/{id}.json

Path parameters

id integer(int64) Required

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 | null | array | boolean | integer | number | string
  
  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
  
  Payload
  
  Payload
  
  Payload
  
  Payload
  
  Payload
  
  Payload
- response object | null | array | boolean | integer | number | string
  
  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
  
  Response
  
  Response
  
  Response
  
  Response
  
  Response
  
  Response
- saleId integer(int32) | null
  
  Sale
- source string | null Required
  
  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": "2023-05-04T09:42:00+00:00",
  "id": 42,
  "payload": {},
  "response": {},
  "saleId": 42,
  "source": "other",
  "updatedAt": "2023-05-04T09:42:00+00:00"
}

PUT /address-validations/{id}.json

Path parameters

id integer(int64) Required

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 | null | array | boolean | integer | number | string

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

Payload

Payload

Payload

Payload

Payload

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

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

Response

Response

Response

Response

Response

Response
saleId integer(int32) | null

Sale
source string | null Required

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":"2023-05-04T09:42:00+00:00","id":42,"payload":{},"response":{},"saleId":42,"source":"other","updatedAt":"2023-05-04T09:42:00+00:00"}'

Request example

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

DELETE /address-validations/{id}.json

Path parameters

id integer(int64) Required

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

Automated import

Default value is false.
costPrice number | null Required

Cost price

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

Data import
notes string | null

Notes
quantity integer(int32) Required

Quantity
stockTakeItemId integer(int32) | null

Stock take item
userId integer(int32) | null

User
variantId integer(int32) Required

Variant
warehouseId integer(int32) Required

Warehouse
xeroId string | null

Xero

Responses

• 200 object

Successful response
- adjustmentReasonId integer(int32) | null
  
  Adjustment reason
- automatedImport boolean | null Required
  
  Automated import
  
  Default value is false.
- costPrice number | null Required
  
  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 integer(int32) Required
  
  Quantity
- stockTakeItemId integer(int32) | null
  
  Stock take item
- updatedAt string(date-time)
  
  Updated at
- userId integer(int32) | null
  
  User
- variantId integer(int32) Required
  
  Variant
- warehouseId integer(int32) Required
  
  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": "2023-05-04T09:42:00+00:00",
  "dataImportId": 42,
  "id": 42,
  "notes": "string",
  "quantity": 42,
  "stockTakeItemId": 42,
  "updatedAt": "2023-05-04T09:42:00+00:00",
  "userId": 42,
  "variantId": 42,
  "warehouseId": 42,
  "xeroId": "string"
}

GET /adjustments/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Responses

• 200 object

Successful response
- adjustmentReasonId integer(int32) | null
  
  Adjustment reason
- automatedImport boolean | null Required
  
  Automated import
  
  Default value is false.
- costPrice number | null Required
  
  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 integer(int32) Required
  
  Quantity
- stockTakeItemId integer(int32) | null
  
  Stock take item
- updatedAt string(date-time)
  
  Updated at
- userId integer(int32) | null
  
  User
- variantId integer(int32) Required
  
  Variant
- warehouseId integer(int32) Required
  
  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": "2023-05-04T09:42:00+00:00",
  "dataImportId": 42,
  "id": 42,
  "notes": "string",
  "quantity": 42,
  "stockTakeItemId": 42,
  "updatedAt": "2023-05-04T09:42:00+00:00",
  "userId": 42,
  "variantId": 42,
  "warehouseId": 42,
  "xeroId": "string"
}

PUT /adjustments/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Body Required

adjustmentReasonId integer(int32) | null

Adjustment reason
automatedImport boolean | null Required

Automated import

Default value is false.
costPrice number | null Required

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 integer(int32) Required

Quantity
stockTakeItemId integer(int32) | null

Stock take item
updatedAt string(date-time)

Updated at
userId integer(int32) | null

User
variantId integer(int32) Required

Variant
warehouseId integer(int32) Required

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":"2023-05-04T09:42:00+00:00","dataImportId":42,"id":42,"notes":"string","quantity":42,"stockTakeItemId":42,"updatedAt":"2023-05-04T09:42:00+00:00","userId":42,"variantId":42,"warehouseId":42,"xeroId":"string"}'

Request example

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

DELETE /adjustments/{id}.json

Path parameters

id integer(int64) Required

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

Code
name string Required

Name
showInReturnsPortal boolean | null Required

Show in returns portal

Default value is true.

Responses

• 200 object

Successful response
- code string Required
  
  Code
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- name string Required
  
  Name
- showInReturnsPortal boolean | null Required
  
  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": "2023-05-04T09:42:00+00:00",
  "id": 42,
  "name": "string",
  "showInReturnsPortal": true,
  "updatedAt": "2023-05-04T09:42:00+00:00"
}

GET /adjustment-reasons/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Responses

• 200 object

Successful response
- code string Required
  
  Code
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- name string Required
  
  Name
- showInReturnsPortal boolean | null Required
  
  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": "2023-05-04T09:42:00+00:00",
  "id": 42,
  "name": "string",
  "showInReturnsPortal": true,
  "updatedAt": "2023-05-04T09:42:00+00:00"
}

PUT /adjustment-reasons/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Body Required

code string Required

Code
createdAt string(date-time)

Created at
id integer(int32)

Id
name string Required

Name
showInReturnsPortal boolean | null Required

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":"2023-05-04T09:42:00+00:00","id":42,"name":"string","showInReturnsPortal":true,"updatedAt":"2023-05-04T09:42:00+00:00"}'

Request example

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

DELETE /adjustment-reasons/{id}.json

Path parameters

id integer(int64) Required

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 object | array | boolean | integer | number | string Required

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

Files

Files

Files

Files

Files

Files
filesRequired boolean | null Required

Files required

Default value is false.
instructions string | null

Instructions
name string Required

Name
status string | null Required

Status

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

Responses

• 200 object

Successful response
- createdAt string(date-time)
  
  Created at
- files object | array | boolean | integer | number | string Required
  
  Any of:
  object-1 object array-2 array boolean-3 boolean integer-4 integer number-5 number string-6 string
  
  Files
  
  Files
  
  Files
  
  Files
  
  Files
  
  Files
- filesRequired boolean | null Required
  
  Files required
  
  Default value is false.
- id integer(int32)
  
  Id
- instructions string | null
  
  Instructions
- name string Required
  
  Name
- status string | null Required
  
  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": "2023-05-04T09:42:00+00:00",
  "files": {},
  "filesRequired": false,
  "id": 42,
  "instructions": "string",
  "name": "string",
  "status": "draft",
  "updatedAt": "2023-05-04T09:42:00+00:00"
}

GET /agreements/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Responses

• 200 object

Successful response
- createdAt string(date-time)
  
  Created at
- files object | array | boolean | integer | number | string Required
  
  Any of:
  object-1 object array-2 array boolean-3 boolean integer-4 integer number-5 number string-6 string
  
  Files
  
  Files
  
  Files
  
  Files
  
  Files
  
  Files
- filesRequired boolean | null Required
  
  Files required
  
  Default value is false.
- id integer(int32)
  
  Id
- instructions string | null
  
  Instructions
- name string Required
  
  Name
- status string | null Required
  
  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": "2023-05-04T09:42:00+00:00",
  "files": {},
  "filesRequired": false,
  "id": 42,
  "instructions": "string",
  "name": "string",
  "status": "draft",
  "updatedAt": "2023-05-04T09:42:00+00:00"
}

PUT /agreements/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Body Required

createdAt string(date-time)

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

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

Files

Files

Files

Files

Files

Files
filesRequired boolean | null Required

Files required

Default value is false.
id integer(int32)

Id
instructions string | null

Instructions
name string Required

Name
status string | null Required

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":"2023-05-04T09:42:00+00:00","files":{},"filesRequired":false,"id":42,"instructions":"string","name":"string","status":"draft","updatedAt":"2023-05-04T09:42:00+00:00"}'

Request example

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

DELETE /agreements/{id}.json

Path parameters

id integer(int64) Required

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

Resource

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

Tag

Responses

• 200 object

Successful response
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- resource string Required
  
  Resource
  
  Values are all, customers, dropshipments, dropshipProviders, fulfillments, goodsReceipts, purchases, resellers, saleReturns, or sales. Default value is all.
- tag string Required
  
  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": "2023-05-04T09:42:00+00:00",
  "id": 42,
  "resource": "all",
  "tag": "string",
  "updatedAt": "2023-05-04T09:42:00+00:00"
}

GET /allowed-tags/{id}.json

Path parameters

id integer(int64) Required

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 string Required
  
  Resource
  
  Values are all, customers, dropshipments, dropshipProviders, fulfillments, goodsReceipts, purchases, resellers, saleReturns, or sales. Default value is all.
- tag string Required
  
  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": "2023-05-04T09:42:00+00:00",
  "id": 42,
  "resource": "all",
  "tag": "string",
  "updatedAt": "2023-05-04T09:42:00+00:00"
}

PUT /allowed-tags/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Body Required

createdAt string(date-time)

Created at
id integer(int32)

Id
resource string Required

Resource

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

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":"2023-05-04T09:42:00+00:00","id":42,"resource":"all","tag":"string","updatedAt":"2023-05-04T09:42:00+00:00"}'

Request example

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

DELETE /allowed-tags/{id}.json

Path parameters

id integer(int64) Required

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

Auth token
channelId integer(int32) Required

Channel
marketplaceId string Required

Marketplace
name string Required

Name
sellerId string Required

Seller

Responses

• 200 object

Successful response
- authToken string Required
  
  Auth token
- channelId integer(int32) Required
  
  Channel
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- marketplaceId string Required
  
  Marketplace
- name string Required
  
  Name
- sellerId string Required
  
  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": "2023-05-04T09:42:00+00:00",
  "id": 42,
  "marketplaceId": "string",
  "name": "string",
  "sellerId": "string",
  "updatedAt": "2023-05-04T09:42:00+00:00"
}

GET /amazon-accounts/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Responses

• 200 object

Successful response
- authToken string Required
  
  Auth token
- channelId integer(int32) Required
  
  Channel
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- marketplaceId string Required
  
  Marketplace
- name string Required
  
  Name
- sellerId string Required
  
  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": "2023-05-04T09:42:00+00:00",
  "id": 42,
  "marketplaceId": "string",
  "name": "string",
  "sellerId": "string",
  "updatedAt": "2023-05-04T09:42:00+00:00"
}

PUT /amazon-accounts/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Body Required

authToken string Required

Auth token
channelId integer(int32) Required

Channel
createdAt string(date-time)

Created at
id integer(int32)

Id
marketplaceId string Required

Marketplace
name string Required

Name
sellerId string Required

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":"2023-05-04T09:42:00+00:00","id":42,"marketplaceId":"string","name":"string","sellerId":"string","updatedAt":"2023-05-04T09:42:00+00:00"}'

Request example

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

DELETE /amazon-accounts/{id}.json

Path parameters

id integer(int64) Required

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 Required

amazonAccountId integer(int32) Required

Amazon account
reportId string | null

Report
reportProcessingStatus string Required

Report processing status

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

Report request
reportType string Required

Report type

Value is _POST_INVENTORY_AVAILABILITY_DATA_.
status string Required

Status

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

Responses

• 200 object

Successful response
- amazonAccountId integer(int32) Required
  
  Amazon account
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- reportId string | null
  
  Report
- reportProcessingStatus string Required
  
  Report processing status
  
  Values are _SUBMITTED_, _IN_PROGRESS_, _CANCELLED_, _DONE_, or _DONE_NO_DATA_.
- reportRequestId string Required
  
  Report request
- reportType string Required
  
  Report type
  
  Value is _POST_INVENTORY_AVAILABILITY_DATA_.
- status string Required
  
  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": "2023-05-04T09:42:00+00:00",
  "id": 42,
  "reportId": "string",
  "reportProcessingStatus": "_SUBMITTED_",
  "reportRequestId": "string",
  "reportType": "_POST_INVENTORY_AVAILABILITY_DATA_",
  "status": "pending",
  "updatedAt": "2023-05-04T09:42:00+00:00"
}

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

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Responses

• 200 object

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

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

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

Response example (200)

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

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

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Body Required

amazonAccountId integer(int32) Required

Amazon account
createdAt string(date-time)

Created at
id integer(int32)

Id
reportId string | null

Report
reportProcessingStatus string Required

Report processing status

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

Report request
reportType string Required

Report type

Value is _POST_INVENTORY_AVAILABILITY_DATA_.
status string Required

Status

Values are pending, processing, success, or error. Default value is pending.
updatedAt string(date-time)

Updated at

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

curl \
 -X PUT http://api.example.com/v1/amazon-account-reports/{id}.json \
 -H "Content-Type: application/json" \
 -d '{"amazonAccountId":42,"createdAt":"2023-05-04T09:42:00+00:00","id":42,"reportId":"string","reportProcessingStatus":"_SUBMITTED_","reportRequestId":"string","reportType":"_POST_INVENTORY_AVAILABILITY_DATA_","status":"pending","updatedAt":"2023-05-04T09:42:00+00:00"}'

Request example

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

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

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

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

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

big-commerce-store

Operations

POST: /big-commerce-stores.json
GET: /big-commerce-stores/{id}.json
PUT: /big-commerce-stores/{id}.json
DELETE: /big-commerce-stores/{id}.json

POST /big-commerce-stores.json

Body Required

accessToken string | null

Access token
authenticationType string | null Required

Authentication type

Values are public or private. Default value is public.
channelId integer(int32) Required

Channel
clientId string | null

Client
clientSecret string | null

Client secret
defaultCategory string | null

Default category
enabled boolean | null Required

Enabled

Default value is true.
lastFetchedSalesAt string(date-time) | null

Last fetched sales at
name string | null

Name
shop string Required

Shop
storeHash string | null

Store hash

Responses

• 200 object

Successful response
- accessToken string | null
  
  Access token
- authenticationType string | null Required
  
  Authentication type
  
  Values are public or private. Default value is public.
- channelId integer(int32) Required
  
  Channel
- clientId string | null
  
  Client
- clientSecret string | null
  
  Client secret
- createdAt string(date-time)
  
  Created at
- defaultCategory string | null
  
  Default category
- enabled boolean | null Required
  
  Enabled
  
  Default value is true.
- id integer(int32)
  
  Id
- lastFetchedSalesAt string(date-time) | null
  
  Last fetched sales at
- name string | null
  
  Name
- shop string Required
  
  Shop
- storeHash string | null
  
  Store hash
- updatedAt string(date-time)
  
  Updated at

POST /big-commerce-stores.json

curl \
 -X POST http://api.example.com/v1/big-commerce-stores.json \
 -H "Content-Type: application/json" \
 -d '{"accessToken":"string","authenticationType":"public","channelId":42,"clientId":"string","clientSecret":"string","defaultCategory":"string","enabled":true,"lastFetchedSalesAt":"2023-05-04T09:42:00+00:00","name":"string","shop":"string","storeHash":"string"}'

Request example

{
  "accessToken": "string",
  "authenticationType": "public",
  "channelId": 42,
  "clientId": "string",
  "clientSecret": "string",
  "defaultCategory": "string",
  "enabled": true,
  "lastFetchedSalesAt": "2023-05-04T09:42:00+00:00",
  "name": "string",
  "shop": "string",
  "storeHash": "string"
}

Response example (200)

{
  "accessToken": "string",
  "authenticationType": "public",
  "channelId": 42,
  "clientId": "string",
  "clientSecret": "string",
  "createdAt": "2023-05-04T09:42:00+00:00",
  "defaultCategory": "string",
  "enabled": true,
  "id": 42,
  "lastFetchedSalesAt": "2023-05-04T09:42:00+00:00",
  "name": "string",
  "shop": "string",
  "storeHash": "string",
  "updatedAt": "2023-05-04T09:42:00+00:00"
}

GET /big-commerce-stores/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Responses

• 200 object

Successful response
- accessToken string | null
  
  Access token
- authenticationType string | null Required
  
  Authentication type
  
  Values are public or private. Default value is public.
- channelId integer(int32) Required
  
  Channel
- clientId string | null
  
  Client
- clientSecret string | null
  
  Client secret
- createdAt string(date-time)
  
  Created at
- defaultCategory string | null
  
  Default category
- enabled boolean | null Required
  
  Enabled
  
  Default value is true.
- id integer(int32)
  
  Id
- lastFetchedSalesAt string(date-time) | null
  
  Last fetched sales at
- name string | null
  
  Name
- shop string Required
  
  Shop
- storeHash string | null
  
  Store hash
- updatedAt string(date-time)
  
  Updated at

GET /big-commerce-stores/{id}.json

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

Response example (200)

{
  "accessToken": "string",
  "authenticationType": "public",
  "channelId": 42,
  "clientId": "string",
  "clientSecret": "string",
  "createdAt": "2023-05-04T09:42:00+00:00",
  "defaultCategory": "string",
  "enabled": true,
  "id": 42,
  "lastFetchedSalesAt": "2023-05-04T09:42:00+00:00",
  "name": "string",
  "shop": "string",
  "storeHash": "string",
  "updatedAt": "2023-05-04T09:42:00+00:00"
}

PUT /big-commerce-stores/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Body Required

accessToken string | null

Access token
authenticationType string | null Required

Authentication type

Values are public or private. Default value is public.
channelId integer(int32) Required

Channel
clientId string | null

Client
clientSecret string | null

Client secret
createdAt string(date-time)

Created at
defaultCategory string | null

Default category
enabled boolean | null Required

Enabled

Default value is true.
id integer(int32)

Id
lastFetchedSalesAt string(date-time) | null

Last fetched sales at
name string | null

Name
shop string Required

Shop
storeHash string | null

Store hash
updatedAt string(date-time)

Updated at

PUT /big-commerce-stores/{id}.json

curl \
 -X PUT http://api.example.com/v1/big-commerce-stores/{id}.json \
 -H "Content-Type: application/json" \
 -d '{"accessToken":"string","authenticationType":"public","channelId":42,"clientId":"string","clientSecret":"string","createdAt":"2023-05-04T09:42:00+00:00","defaultCategory":"string","enabled":true,"id":42,"lastFetchedSalesAt":"2023-05-04T09:42:00+00:00","name":"string","shop":"string","storeHash":"string","updatedAt":"2023-05-04T09:42:00+00:00"}'

Request example

{
  "accessToken": "string",
  "authenticationType": "public",
  "channelId": 42,
  "clientId": "string",
  "clientSecret": "string",
  "createdAt": "2023-05-04T09:42:00+00:00",
  "defaultCategory": "string",
  "enabled": true,
  "id": 42,
  "lastFetchedSalesAt": "2023-05-04T09:42:00+00:00",
  "name": "string",
  "shop": "string",
  "storeHash": "string",
  "updatedAt": "2023-05-04T09:42:00+00:00"
}

DELETE /big-commerce-stores/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

DELETE /big-commerce-stores/{id}.json

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

bundle-variant

Operations

POST: /bundle-variants.json
GET: /bundle-variants/{id}.json
PUT: /bundle-variants/{id}.json
DELETE: /bundle-variants/{id}.json

POST /bundle-variants.json

Body Required

componentVariantId integer(int32) Required

Component variant
quantity integer(int32) Required

Quantity

Default value is 1.
variantId integer(int32) Required

Variant

Responses

• 200 object

Successful response
- componentVariantId integer(int32) Required
  
  Component variant
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- quantity integer(int32) Required
  
  Quantity
  
  Default value is 1.
- updatedAt string(date-time)
  
  Updated at
- variantId integer(int32) Required
  
  Variant

POST /bundle-variants.json

curl \
 -X POST http://api.example.com/v1/bundle-variants.json \
 -H "Content-Type: application/json" \
 -d '{"componentVariantId":42,"quantity":1,"variantId":42}'

Request example

{
  "componentVariantId": 42,
  "quantity": 1,
  "variantId": 42
}

Response example (200)

{
  "componentVariantId": 42,
  "createdAt": "2023-05-04T09:42:00+00:00",
  "id": 42,
  "quantity": 1,
  "updatedAt": "2023-05-04T09:42:00+00:00",
  "variantId": 42
}

GET /bundle-variants/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Responses

• 200 object

Successful response
- componentVariantId integer(int32) Required
  
  Component variant
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- quantity integer(int32) Required
  
  Quantity
  
  Default value is 1.
- updatedAt string(date-time)
  
  Updated at
- variantId integer(int32) Required
  
  Variant

GET /bundle-variants/{id}.json

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

Response example (200)

{
  "componentVariantId": 42,
  "createdAt": "2023-05-04T09:42:00+00:00",
  "id": 42,
  "quantity": 1,
  "updatedAt": "2023-05-04T09:42:00+00:00",
  "variantId": 42
}

PUT /bundle-variants/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Body Required

componentVariantId integer(int32) Required

Component variant
createdAt string(date-time)

Created at
id integer(int32)

Id
quantity integer(int32) Required

Quantity

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

Updated at
variantId integer(int32) Required

Variant

PUT /bundle-variants/{id}.json

curl \
 -X PUT http://api.example.com/v1/bundle-variants/{id}.json \
 -H "Content-Type: application/json" \
 -d '{"componentVariantId":42,"createdAt":"2023-05-04T09:42:00+00:00","id":42,"quantity":1,"updatedAt":"2023-05-04T09:42:00+00:00","variantId":42}'

Request example

{
  "componentVariantId": 42,
  "createdAt": "2023-05-04T09:42:00+00:00",
  "id": 42,
  "quantity": 1,
  "updatedAt": "2023-05-04T09:42:00+00:00",
  "variantId": 42
}

DELETE /bundle-variants/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

DELETE /bundle-variants/{id}.json

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

carrier

Operations

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

POST /carriers.json

Body Required

carrierType string | null

Carrier type

Values are australia_post, canada_post, deutsche_post, dhl_germany, dhl_ecommerce, dhl_express, fedex, gls_fr, lasership, mondial_relay, newgistics, ontrac, purolator, ups, or usps.
externalId string | null

External
name string | null

Name
platform string | null Required

Platform

Values are shippo or manual. Default value is manual.

Responses

• 200 object

Successful response
- carrierType string | null
  
  Carrier type
  
  Values are australia_post, canada_post, deutsche_post, dhl_germany, dhl_ecommerce, dhl_express, fedex, gls_fr, lasership, mondial_relay, newgistics, ontrac, purolator, ups, or usps.
- createdAt string(date-time)
  
  Created at
- externalId string | null
  
  External
- id integer(int32)
  
  Id
- name string | null
  
  Name
- platform string | null Required
  
  Platform
  
  Values are shippo or manual. Default value is manual.
- updatedAt string(date-time)
  
  Updated at

POST /carriers.json

curl \
 -X POST http://api.example.com/v1/carriers.json \
 -H "Content-Type: application/json" \
 -d '{"carrierType":"australia_post","externalId":"string","name":"string","platform":"manual"}'

Request example

{
  "carrierType": "australia_post",
  "externalId": "string",
  "name": "string",
  "platform": "manual"
}

Response example (200)

{
  "carrierType": "australia_post",
  "createdAt": "2023-05-04T09:42:00+00:00",
  "externalId": "string",
  "id": 42,
  "name": "string",
  "platform": "manual",
  "updatedAt": "2023-05-04T09:42:00+00:00"
}

GET /carriers/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Responses

• 200 object

Successful response
- carrierType string | null
  
  Carrier type
  
  Values are australia_post, canada_post, deutsche_post, dhl_germany, dhl_ecommerce, dhl_express, fedex, gls_fr, lasership, mondial_relay, newgistics, ontrac, purolator, ups, or usps.
- createdAt string(date-time)
  
  Created at

Jetti 1.0.0

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Body Required

Jetti
1.0.0