Jetti API documentation

Changes history

Toggle dark mode

Jetti

Jetti API Documentation

This is the documentation for version 1.0.0 of the API. Last update on Jun 18, 2021.

Base URL

http://api.example.com/v1

Accounting integration

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

Definition

POST http://api.example.com/v1/accounting-integrations.json

cURL example

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 payload example

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

Response example (200)

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

Definition

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

cURL example

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

Response example (200)

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

Definition

PUT http://api.example.com/v1/accounting-integrations/{id}.json

cURL example

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

Request payload example

{
  "createdAt": "2021-05-04T09:42:00+00:00",
  "dropshipEndpoint": "string",
  "id": 42,
  "name": "string",
  "replenishmentEndpoint": "string",
  "saleEndpoint": "string",
  "updatedAt": "2021-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.

Definition

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

cURL example

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

Accounting payload

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, and custom.
status Required / string

Status

Values are success and 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, and custom.
- status Required / string
  
  Status
  
  Values are success and error.
- updatedAt string(date-time)
  
  Updated at

Definition

POST http://api.example.com/v1/accounting-payloads.json

cURL example

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 payload example

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

Response example (200)

{
  "accountingIntegrationId": 42,
  "createdAt": "2021-05-04T09:42:00+00:00",
  "id": 42,
  "payload": "string",
  "purchaseInvoiceId": 42,
  "response": "string",
  "saleInvoiceId": 42,
  "source": "quickbooks",
  "status": "success",
  "updatedAt": "2021-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, and custom.
- status Required / string
  
  Status
  
  Values are success and error.
- updatedAt string(date-time)
  
  Updated at

Definition

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

cURL example

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

Response example (200)

{
  "accountingIntegrationId": 42,
  "createdAt": "2021-05-04T09:42:00+00:00",
  "id": 42,
  "payload": "string",
  "purchaseInvoiceId": 42,
  "response": "string",
  "saleInvoiceId": 42,
  "source": "quickbooks",
  "status": "success",
  "updatedAt": "2021-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, and custom.
status Required / string

Status

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

Updated at

Definition

PUT http://api.example.com/v1/accounting-payloads/{id}.json

cURL example

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

Request payload example

{
  "accountingIntegrationId": 42,
  "createdAt": "2021-05-04T09:42:00+00:00",
  "id": 42,
  "payload": "string",
  "purchaseInvoiceId": 42,
  "response": "string",
  "saleInvoiceId": 42,
  "source": "quickbooks",
  "status": "success",
  "updatedAt": "2021-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.

Definition

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

cURL example

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

Address validation

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, and 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, and shippo. Default value is other.
- updatedAt string(date-time)
  
  Updated at

Definition

POST http://api.example.com/v1/address-validations.json

cURL example

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 payload example

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

Response example (200)

{
  "channelId": 42,
  "createdAt": "2021-05-04T09:42:00+00:00",
  "id": 42,
  "payload": "string",
  "response": "string",
  "saleId": 42,
  "source": "other",
  "updatedAt": "2021-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, and shippo. Default value is other.
- updatedAt string(date-time)
  
  Updated at

Definition

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

cURL example

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

Response example (200)

{
  "channelId": 42,
  "createdAt": "2021-05-04T09:42:00+00:00",
  "id": 42,
  "payload": "string",
  "response": "string",
  "saleId": 42,
  "source": "other",
  "updatedAt": "2021-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, and shippo. Default value is other.
updatedAt string(date-time)

Updated at

Definition

PUT http://api.example.com/v1/address-validations/{id}.json

cURL example

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

Request payload example

{
  "channelId": 42,
  "createdAt": "2021-05-04T09:42:00+00:00",
  "id": 42,
  "payload": "string",
  "response": "string",
  "saleId": 42,
  "source": "other",
  "updatedAt": "2021-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.

Definition

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

cURL example

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

Adjustment

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

Definition

POST http://api.example.com/v1/adjustments.json

cURL example

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 payload 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": "2021-05-04T09:42:00+00:00",
  "dataImportId": 42,
  "id": 42,
  "notes": "string",
  "quantity": 42,
  "stockTakeItemId": 42,
  "updatedAt": "2021-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

Definition

GET http://api.example.com/v1/adjustments/{id}.json

cURL example

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

Response example (200)

{
  "adjustmentReasonId": 42,
  "automatedImport": true,
  "costPrice": 42.0,
  "createdAt": "2021-05-04T09:42:00+00:00",
  "dataImportId": 42,
  "id": 42,
  "notes": "string",
  "quantity": 42,
  "stockTakeItemId": 42,
  "updatedAt": "2021-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

Definition

PUT http://api.example.com/v1/adjustments/{id}.json

cURL example

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

Request payload example

{
  "adjustmentReasonId": 42,
  "automatedImport": true,
  "costPrice": 42.0,
  "createdAt": "2021-05-04T09:42:00+00:00",
  "dataImportId": 42,
  "id": 42,
  "notes": "string",
  "quantity": 42,
  "stockTakeItemId": 42,
  "updatedAt": "2021-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.

Definition

DELETE http://api.example.com/v1/adjustments/{id}.json

cURL example

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

Adjustment reason

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

Definition

POST http://api.example.com/v1/adjustment-reasons.json

cURL example

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

Request payload example

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

Response example (200)

{
  "code": "string",
  "createdAt": "2021-05-04T09:42:00+00:00",
  "id": 42,
  "name": "string",
  "showInReturnsPortal": true,
  "updatedAt": "2021-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

Definition

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

cURL example

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

Response example (200)

{
  "code": "string",
  "createdAt": "2021-05-04T09:42:00+00:00",
  "id": 42,
  "name": "string",
  "showInReturnsPortal": true,
  "updatedAt": "2021-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

Definition

PUT http://api.example.com/v1/adjustment-reasons/{id}.json

cURL example

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

Request payload example

{
  "code": "string",
  "createdAt": "2021-05-04T09:42:00+00:00",
  "id": 42,
  "name": "string",
  "showInReturnsPortal": true,
  "updatedAt": "2021-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.

Definition

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

cURL example

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

Agreement

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, and 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, and archived. Default value is draft.
- updatedAt string(date-time)
  
  Updated at

Definition

POST http://api.example.com/v1/agreements.json

cURL example

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 payload example

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

Response example (200)

{
  "createdAt": "2021-05-04T09:42:00+00:00",
  "files": "string",
  "filesRequired": true,
  "id": 42,
  "instructions": "string",
  "name": "string",
  "status": "draft",
  "updatedAt": "2021-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, and archived. Default value is draft.
- updatedAt string(date-time)
  
  Updated at

Definition

GET http://api.example.com/v1/agreements/{id}.json

cURL example

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

Response example (200)

{
  "createdAt": "2021-05-04T09:42:00+00:00",
  "files": "string",
  "filesRequired": true,
  "id": 42,
  "instructions": "string",
  "name": "string",
  "status": "draft",
  "updatedAt": "2021-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, and archived. Default value is draft.
updatedAt string(date-time)

Updated at

Definition

PUT http://api.example.com/v1/agreements/{id}.json

cURL example

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

Request payload example

{
  "createdAt": "2021-05-04T09:42:00+00:00",
  "files": "string",
  "filesRequired": true,
  "id": 42,
  "instructions": "string",
  "name": "string",
  "status": "draft",
  "updatedAt": "2021-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.

Definition

DELETE http://api.example.com/v1/agreements/{id}.json

cURL example

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

Allowed tag

POST /allowed-tags.json

Body

resource Required / string

Resource

Values are all, customers, dropshipments, dropshipProviders, fulfillments, goodsReceipts, purchases, resellers, saleReturns, and 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, and sales. Default value is all.
- tag Required / string
  
  Tag
- updatedAt string(date-time)
  
  Updated at

Definition

POST http://api.example.com/v1/allowed-tags.json

cURL example

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

Request payload example

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

Response example (200)

{
  "createdAt": "2021-05-04T09:42:00+00:00",
  "id": 42,
  "resource": "all",
  "tag": "string",
  "updatedAt": "2021-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, and sales. Default value is all.
- tag Required / string
  
  Tag
- updatedAt string(date-time)
  
  Updated at

Definition

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

cURL example

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

Response example (200)

{
  "createdAt": "2021-05-04T09:42:00+00:00",
  "id": 42,
  "resource": "all",
  "tag": "string",
  "updatedAt": "2021-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, and sales. Default value is all.
tag Required / string

Tag
updatedAt string(date-time)

Updated at

Definition

PUT http://api.example.com/v1/allowed-tags/{id}.json

cURL example

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

Request payload example

{
  "createdAt": "2021-05-04T09:42:00+00:00",
  "id": 42,
  "resource": "all",
  "tag": "string",
  "updatedAt": "2021-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.

Definition

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

cURL example

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

Amazon account

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

Definition

POST http://api.example.com/v1/amazon-accounts.json

cURL example

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 payload example

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

Response example (200)

{
  "authToken": "string",
  "channelId": 42,
  "createdAt": "2021-05-04T09:42:00+00:00",
  "id": 42,
  "marketplaceId": "string",
  "name": "string",
  "sellerId": "string",
  "updatedAt": "2021-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

Definition

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

cURL example

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

Response example (200)

{
  "authToken": "string",
  "channelId": 42,
  "createdAt": "2021-05-04T09:42:00+00:00",
  "id": 42,
  "marketplaceId": "string",
  "name": "string",
  "sellerId": "string",
  "updatedAt": "2021-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

Definition

PUT http://api.example.com/v1/amazon-accounts/{id}.json

cURL example

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

Request payload example

{
  "authToken": "string",
  "channelId": 42,
  "createdAt": "2021-05-04T09:42:00+00:00",
  "id": 42,
  "marketplaceId": "string",
  "name": "string",
  "sellerId": "string",
  "updatedAt": "2021-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.

Definition

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

cURL example

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

Amazon account report

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_, and _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, and 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_, and _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, and error. Default value is pending.
- updatedAt string(date-time)
  
  Updated at

Definition

POST http://api.example.com/v1/amazon-account-reports.json

cURL example

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 payload example

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

Response example (200)

{
  "amazonAccountId": 42,
  "createdAt": "2021-05-04T09:42:00+00:00",
  "id": 42,
  "reportId": "string",
  "reportProcessingStatus": "_SUBMITTED_",
  "reportRequestId": "string",
  "reportType": "_POST_INVENTORY_AVAILABILITY_DATA_",
  "status": "pending",
  "updatedAt": "2021-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
- reportProcessingStatus Required / string
  
  Report processing status
  
  Values are _SUBMITTED_, _IN_PROGRESS_, _CANCELLED_, _DONE_, and _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, and error. Default value is pending.
- updatedAt string(date-time)
  
  Updated at

Definition

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

cURL example

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

Response example (200)

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

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

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Body

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_, and _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, and error. Default value is pending.
updatedAt string(date-time)

Updated at

Definition

PUT http://api.example.com/v1/amazon-account-reports/{id}.json

cURL example

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

Request payload example

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

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

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Definition

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

cURL example

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

Big commerce store

POST /big-commerce-stores.json

Body

accessToken string

Access token
authenticationType Required / string

Authentication type

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

Channel
clientId string

Client
clientSecret string

Client secret
defaultCategory string

Default category
enabled Required / boolean

Enabled

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

Last fetched sales at
name string

Name
shop Required / string

Shop
storeHash string

Store hash

Responses

• 200 object

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

Definition

POST http://api.example.com/v1/big-commerce-stores.json

cURL example

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":"2021-05-04T09:42:00+00:00","name":"string","shop":"string","storeHash":"string"}'

Request payload example

{
  "accessToken": "string",
  "authenticationType": "public",
  "channelId": 42,
  "clientId": "string",
  "clientSecret": "string",
  "defaultCategory": "string",
  "enabled": true,
  "lastFetchedSalesAt": "2021-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": "2021-05-04T09:42:00+00:00",
  "defaultCategory": "string",
  "enabled": true,
  "id": 42,
  "lastFetchedSalesAt": "2021-05-04T09:42:00+00:00",
  "name": "string",
  "shop": "string",
  "storeHash": "string",
  "updatedAt": "2021-05-04T09:42:00+00:00"
}

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

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Responses

• 200 object

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

Definition

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

cURL example

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": "2021-05-04T09:42:00+00:00",
  "defaultCategory": "string",
  "enabled": true,
  "id": 42,
  "lastFetchedSalesAt": "2021-05-04T09:42:00+00:00",
  "name": "string",
  "shop": "string",
  "storeHash": "string",
  "updatedAt": "2021-05-04T09:42:00+00:00"
}

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

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Body

accessToken string

Access token
authenticationType Required / string

Authentication type

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

Channel
clientId string

Client
clientSecret string

Client secret
createdAt string(date-time)

Created at
defaultCategory string

Default category
enabled Required / boolean

Enabled

Default value is true.
id integer(int32)

Id
lastFetchedSalesAt string(date-time)

Last fetched sales at
name string

Name
shop Required / string

Shop
storeHash string

Store hash
updatedAt string(date-time)

Updated at

Definition

PUT http://api.example.com/v1/big-commerce-stores/{id}.json

cURL example

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":"2021-05-04T09:42:00+00:00","defaultCategory":"string","enabled":true,"id":42,"lastFetchedSalesAt":"2021-05-04T09:42:00+00:00","name":"string","shop":"string","storeHash":"string","updatedAt":"2021-05-04T09:42:00+00:00"}'

Request payload example

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

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

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Definition

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

cURL example

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

Bundle variant

POST /bundle-variants.json

Body

componentVariantId Required / integer(int32)

Component variant
quantity Required / integer(int32)

Quantity

Default value is 1.
variantId Required / integer(int32)

Variant

Responses

• 200 object

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

Definition

POST http://api.example.com/v1/bundle-variants.json

cURL example

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

Request payload example

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

Response example (200)

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

GET /bundle-variants/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Responses

• 200 object

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

Definition

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

cURL example

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

Response example (200)

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

PUT /bundle-variants/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Body

componentVariantId Required / integer(int32)

Component variant
createdAt string(date-time)

Created at
id integer(int32)

Id
quantity Required / integer(int32)

Quantity

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

Updated at
variantId Required / integer(int32)

Variant

Definition

PUT http://api.example.com/v1/bundle-variants/{id}.json

cURL example

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

Request payload example

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

DELETE /bundle-variants/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Definition

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

cURL example

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

Carrier

POST /carriers.json

Body

carrierType string

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, and usps.
externalId string

External
name string

Name
platform Required / string

Platform

Values are shippo and manual. Default value is manual.

Responses

• 200 object

Successful response
- carrierType string
  
  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, and usps.
- createdAt string(date-time)
  
  Created at
- externalId string
  
  External
- id integer(int32)
  
  Id
- name string
  
  Name
- platform Required / string
  
  Platform
  
  Values are shippo and manual. Default value is manual.
- updatedAt string(date-time)
  
  Updated at

Definition

POST http://api.example.com/v1/carriers.json

cURL example

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

Request payload example

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

Response example (200)

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

GET /carriers/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Responses

• 200 object

Successful response
- carrierType string
  
  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, and usps.
- createdAt string(date-time)
  
  Created at
- externalId string
  
  External
- id integer(int32)
  
  Id
- name string
  
  Name
- platform Required / string
  
  Platform
  
  Values are shippo and manual. Default value is manual.
- updatedAt string(date-time)
  
  Updated at

Definition

GET http://api.example.com/v1/carriers/{id}.json

cURL example

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

Response example (200)

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

PUT /carriers/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Body

carrierType string

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, and usps.
createdAt string(date-time)

Created at
externalId string

External
id integer(int32)

Id
name string

Name
platform Required / string

Platform

Values are shippo and manual. Default value is manual.
updatedAt string(date-time)

Updated at

Definition

PUT http://api.example.com/v1/carriers/{id}.json

cURL example

curl \
 -X PUT http://api.example.com/v1/carriers/{id}.json \
 -H "Content-Type: application/json" \
 -d '{"carrierType":"australia_post","createdAt":"2021-05-04T09:42:00+00:00","externalId":"string","id":42,"name":"string","platform":"shippo","updatedAt":"2021-05-04T09:42:00+00:00"}'

Request payload example

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

DELETE /carriers/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Definition

DELETE http://api.example.com/v1/carriers/{id}.json

cURL example

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

Carrier pickup

POST /carrier-pickups.json

Body

carrier Required / string

Carrier
dropshipProviderId Required / integer(int32)

Dropship provider
externalId string

External
fromAddressLineOne string

From address line one
fromAddressLineTwo string

From address line two
fromCity string

From city
fromCountry string

From country
fromEmail string

From email
fromName string

From name
fromPhone string

From phone
fromState string

From state
fromZip string

From zip
payload

Payload
pickupAt Required / string(date-time)

Pickup at
response

Response
source Required / string

Source
status Required / string

Status
toCountry string

To country

Responses

• 200 object

Successful response
- carrier Required / string
  
  Carrier
- createdAt string(date-time)
  
  Created at
- dropshipProviderId Required / integer(int32)
  
  Dropship provider
- externalId string
  
  External
- fromAddressLineOne string
  
  From address line one
- fromAddressLineTwo string
  
  From address line two
- fromCity string
  
  From city
- fromCountry string
  
  From country
- fromEmail string
  
  From email
- fromName string
  
  From name
- fromPhone string
  
  From phone
- fromState string
  
  From state
- fromZip string
  
  From zip
- id integer(int32)
  
  Id
- payload
  
  Payload
- pickupAt Required / string(date-time)
  
  Pickup at
- response
  
  Response
- source Required / string
  
  Source
- status Required / string
  
  Status
- toCountry string
  
  To country
- updatedAt string(date-time)
  
  Updated at

Definition

POST http://api.example.com/v1/carrier-pickups.json

cURL example

curl \
 -X POST http://api.example.com/v1/carrier-pickups.json \
 -H "Content-Type: application/json" \
 -d '{"carrier":"string","dropshipProviderId":42,"externalId":"string","fromAddressLineOne":"string","fromAddressLineTwo":"string","fromCity":"string","fromCountry":"string","fromEmail":"string","fromName":"string","fromPhone":"string","fromState":"string","fromZip":"string","payload":"string","pickupAt":"2021-05-04T09:42:00+00:00","response":"string","source":"string","status":"string","toCountry":"string"}'

Request payload example

{
  "carrier": "string",
  "dropshipProviderId": 42,
  "externalId": "string",
  "fromAddressLineOne": "string",
  "fromAddressLineTwo": "string",
  "fromCity": "string",
  "fromCountry": "string",
  "fromEmail": "string",
  "fromName": "string",
  "fromPhone": "string",
  "fromState": "string",
  "fromZip": "string",
  "payload": "string",
  "pickupAt": "2021-05-04T09:42:00+00:00",
  "response": "string",
  "source": "string",
  "status": "string",
  "toCountry": "string"
}

Response example (200)

{
  "carrier": "string",
  "createdAt": "2021-05-04T09:42:00+00:00",
  "dropshipProviderId": 42,
  "externalId": "string",
  "fromAddressLineOne": "string",
  "fromAddressLineTwo": "string",
  "fromCity": "string",
  "fromCountry": "string",
  "fromEmail": "string",
  "fromName": "string",
  "fromPhone": "string",
  "fromState": "string",
  "fromZip": "string",
  "id": 42,
  "payload": "string",
  "pickupAt": "2021-05-04T09:42:00+00:00",
  "response": "string",
  "source": "string",
  "status": "string",
  "toCountry": "string",
  "updatedAt": "2021-05-04T09:42:00+00:00"
}

GET /carrier-pickups/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Responses

• 200 object

Successful response
- carrier Required / string
  
  Carrier
- createdAt string(date-time)
  
  Created at
- dropshipProviderId Required / integer(int32)
  
  Dropship provider
- externalId string
  
  External
- fromAddressLineOne string
  
  From address line one
- fromAddressLineTwo string
  
  From address line two
- fromCity string
  
  From city
- fromCountry string
  
  From country
- fromEmail string
  
  From email
- fromName string
  
  From name
- fromPhone string
  
  From phone
- fromState string
  
  From state
- fromZip string
  
  From zip
- id integer(int32)
  
  Id
- payload
  
  Payload
- pickupAt Required / string(date-time)
  
  Pickup at
- response
  
  Response
- source Required / string
  
  Source
- status Required / string
  
  Status
- toCountry string
  
  To country
- updatedAt string(date-time)
  
  Updated at

Definition

GET http://api.example.com/v1/carrier-pickups/{id}.json

cURL example

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

Response example (200)

{
  "carrier": "string",
  "createdAt": "2021-05-04T09:42:00+00:00",
  "dropshipProviderId": 42,
  "externalId": "string",
  "fromAddressLineOne": "string",
  "fromAddressLineTwo": "string",
  "fromCity": "string",
  "fromCountry": "string",
  "fromEmail": "string",
  "fromName": "string",
  "fromPhone": "string",
  "fromState": "string",
  "fromZip": "string",
  "id": 42,
  "payload": "string",
  "pickupAt": "2021-05-04T09:42:00+00:00",
  "response": "string",
  "source": "string",
  "status": "string",
  "toCountry": "string",
  "updatedAt": "2021-05-04T09:42:00+00:00"
}

PUT /carrier-pickups/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Body

carrier Required / string

Carrier
createdAt string(date-time)

Created at
dropshipProviderId Required / integer(int32)

Dropship provider
externalId string

External
fromAddressLineOne string

From address line one
fromAddressLineTwo string

From address line two
fromCity string

From city
fromCountry string

From country
fromEmail string

From email
fromName string

From name
fromPhone string

From phone
fromState string

From state
fromZip string

From zip
id integer(int32)

Id
payload

Payload
pickupAt Required / string(date-time)

Pickup at
response

Response
source Required / string

Source
status Required / string

Status
toCountry string

To country
updatedAt string(date-time)

Updated at

Definition

PUT http://api.example.com/v1/carrier-pickups/{id}.json

cURL example

curl \
 -X PUT http://api.example.com/v1/carrier-pickups/{id}.json \
 -H "Content-Type: application/json" \
 -d '{"carrier":"string","createdAt":"2021-05-04T09:42:00+00:00","dropshipProviderId":42,"externalId":"string","fromAddressLineOne":"string","fromAddressLineTwo":"string","fromCity":"string","fromCountry":"string","fromEmail":"string","fromName":"string","fromPhone":"string","fromState":"string","fromZip":"string","id":42,"payload":"string","pickupAt":"2021-05-04T09:42:00+00:00","response":"string","source":"string","status":"string","toCountry":"string","updatedAt":"2021-05-04T09:42:00+00:00"}'

Request payload example

{
  "carrier": "string",
  "createdAt": "2021-05-04T09:42:00+00:00",
  "dropshipProviderId": 42,
  "externalId": "string",
  "fromAddressLineOne": "string",
  "fromAddressLineTwo": "string",
  "fromCity": "string",
  "fromCountry": "string",
  "fromEmail": "string",
  "fromName": "string",
  "fromPhone": "string",
  "fromState": "string",
  "fromZip": "string",
  "id": 42,
  "payload": "string",
  "pickupAt": "2021-05-04T09:42:00+00:00",
  "response": "string",
  "source": "string",
  "status": "string",
  "toCountry": "string",
  "updatedAt": "2021-05-04T09:42:00+00:00"
}

DELETE /carrier-pickups/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Definition

DELETE http://api.example.com/v1/carrier-pickups/{id}.json

cURL example

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

Channel

POST /channels.json

Body

addressValidationEndpoint string

Address validation endpoint
addressValidationFinalize Required / boolean

Address validation finalize
aftershipError Required / string

When there is an error returned from AfterShip (e.g. if the carrier name was missing), you can select whether to pause sending the shipment notification to your store. Or, continue to sync the shipment with your online store despite the error.

Values are skip and error. Default value is skip.
allocateDraftSales Required / string

Allocate draft sales

Values are enabled and disabled. Default value is enabled.
allocatedShipments Required / string

If an item can not be allocated to a dropship provider or warehouse, you can either allow the customer to continue to checkout. Or, throw an error.

Values are allow and error. Default value is allow.
automaticallyCancelSales Required / boolean

Automatically cancel sales

Default value is true.
automaticallyFinalizeSales Required / boolean

Automatically finalize sales

Default value is true.
automaticallyPublish Required / boolean

Automatically publish

Default value is true.
blendedPreference Required / string

Blended preference

Values are dropship, inhouse, and routing. Default value is inhouse.
checkoutString string

Checkout string
collectionEndpoint string

Collection endpoint
connectToFeed boolean

Connect to feed
connectedAt string(date-time)

Connected at
disableVariantInventorySync boolean

Disable variant inventory sync
dropshipProviderId integer(int32)

Dropship provider
dropshipRouting Required / string

Dropship routing

Values are default and custom. Default value is default.
dropshipRoutingTags array[string]

Dropship routing tags
dropshipTags Required / array[string]

Dropship tags
email string

Email
enableFreeShippingCountries Required / boolean

Enable free shipping countries
exportToShipstation boolean

Export to shipstation
forceConnectToFeed Required / boolean

Force connect to feed
freeShippingCode string

Free shipping code
freeShippingCountries array[string]

Free shipping countries
freeShippingName string

Free shipping name
freeShippingOriginCountries array[string]

Free shipping origin countries
freeShippingOverride boolean

Free shipping override
freeShippingScope Required / string

Free shipping scope

Values are all, domestic, and selected. Default value is all.
freeShippingThreshold number

Free shipping threshold
hash

Hash
hideWhenNoCostPrice boolean

Hide when no cost price
imageSync Required / string

Image sync

Values are bidirectional, jetti, channel, and inventoryFeed. Default value is bidirectional.
importFromFeed boolean

Import from feed
importPaymentStatus Required / string

Import payment status

Values are unpaid, partiallyPaid, and paid. Default value is paid.
importProductsSeconds integer(int32)

Import products seconds
includeBackorderQuantity Required / boolean

Include backorder quantity

Default value is true.
includeSaleTags Required / boolean

Include sale tags
inventoryFeedRemoved Required / string

Inventory feed removed

Values are all and partial. Default value is all.
inventoryFeedUnpublish Required / string

If a vendor removes the item from their store. Or, the item becomes unavailable from their feed, you can automatically make the item unavailable in your channel. This is done by setting the inventory policy to deny and the available quantity to 0.

Values are none, unpublish, and unavailable. Default value is none.
inventorySync Required / string

Inventory sync

Values are all, inventory_feeds, and none. Default value is all.
manualSaleItemRouting Required / string

Some e-commerce platforms may add non-product items to orders. For example, a line item for the gift messaging with an associated price. Or, an order might be imported into Jetti with an item not yet connected to a product. When this happens, you may want to pause the processing of the order until the product can be associated with a dropship provider.

Values are ignore and pause. Default value is ignore.
maxShippingCost boolean

Max shipping cost
maxShippingCostThreshold number

Max shipping cost threshold
maximumExpectedShipping string

Dropship providers have the ability to change the expected delivery of an order. You can select whether this could be any date. Or, restrict the selection of the date so it's only within a specific number of days.

Values are enabled and disabled.
maximumExpectedShippingDuration Required / integer(int32)

Maximum expected shipping duration

Default value is 0.
name Required / string

Name
negativeStock Required / string

Negative stock

Values are enabled and disabled. Default value is enabled.
negativeStockLevel Required / integer(int32)

Negative stock level

Default value is 0.
noRatesError Required / boolean

No rates error
orderRouting Required / string

Order routing

Values are automated, manual, and ignore. Default value is automated.
orderRoutingEndpoint string

Order routing endpoint
oversellingPrevention Required / string

Overselling prevention

Values are enabled and disabled. Default value is disabled.
parentChannel Required / string

Parent channel

Values are bigCommerce, custom, duoplane, elasticPath, magento, manual, salesforce, shopify, and wooCommerce. Default value is manual.
pdfLegal string

Pdf legal
phone string

Phone
priceListId Required / integer(int32)

Price list
productsImportedAt string(date-time)

Products imported at
publishAdditionalTags Required / array[string]

When items are published to the channel, you can specify any additional tags to include.

Default value is ["jetti"].
publishMetaFields boolean

Publish meta fields
publishProducts Required / boolean

Publish products

Default value is true.
publishProductsWithoutPrice Required / boolean

Publish products without price

Default value is true.
publishTags Required / string

Publish tags

Values are all and none. Default value is all.
purchasePrefix string

Purchase prefix
purchaseStatusId integer(int32)

Purchase status
rateLogging Required / boolean

Rate logging
requirePhoneNumber Required / boolean

The order will not be able to be finalized and processed if a phone number was not supplied by the customer. Jetti won't check to see if the phone number is valid (e.g. a valid US phone number), it will just check to see if a phone number was added. The phone number is typically provided by the customer and they are purchasing items in your online store. When enabled, you'll receive an email notification letting you know an order was imported if a phone number is not found.
requireVendorName boolean

Require vendor name
routingPriorityOne Required / string

Routing priority one

Values are none, country, costPrice, and inStock. Default value is inStock.
routingPriorityThree Required / string

Routing priority three

Values are none, country, costPrice, and inStock. Default value is none.
routingPriorityTwo Required / string

Routing priority two

Values are none, country, costPrice, and inStock. Default value is none.
saleCustomFields array[string]

Select the names of the custom fields to be applied. E.g. vat_number, gift_note.
saleCustomFieldsScope Required / string

When importing sales from your channel, custom or meta fields may be applied. For example, the Customer VAT number of gift note. By default, none of the custom fields are applied to the dropship purchase order. You can optionally include all or a selection of the custom fields when dropship orders are raised.

Values are all, selected, and none. Default value is none.
saleLogging Required / boolean

When connecting custom frontends to Jetti, it may be useful to log all incoming data for inspecting and validating. This will detail the payload send to Jetti and any errors encountered processing the data.
saleLoggingEmail Required / string

When importing data from your online store, you can be notified if an error is encountered. We'd recommend only using this for custom frontends, where developers are building a connector with Jetti.

Values are none, initial, and all. Default value is none.
saleMetaFieldFilter array[string]

Create an allow list of meta field keys/names to import on orders. May be useful when you want to exclude metafields being added from 3rd party apps.
saleMetaFields Required / string

Select whether to import custom fields on orders. Currently, Shopify orders will import all custom fields.

Values are all, selected, and none. Default value is none.
salePrefix string

Sale prefix
sendShippingNotification Required / boolean

This will trigger an email being sent to the customer within your online store. Jetti does not send the email. Instead, we'll notify your online store to send their default shipping email. For example, on Shopify, this will send the default shipping notification template.

Default value is true.
shippingInvoiceTemplate string

Optional. Customize the reference for inclusion on commercial invoices. You can use {reference} for adding in the reference. E.g. "INVOICE_{reference}"
shipstationConnectedAt string(date-time)

Shipstation connected at
shipstationPassword string

Shipstation password
shipstationTags array[string]

Shipstation tags
shipstationUrl

Shipstation url
shipstationUsername string

Shipstation username
skipLineItems Required / array[string]

Skip line items
skipTags Required / array[string]

Skip tags
skipVariantTags Required / array[string]

Skip variant tags
splitShipping Required / string

Split shipping

Values are quantity, value, equal, full, and first. Default value is full.
syncAddressUpdates Required / boolean

Sync address updates

Default value is true.
syncCostPrices Required / boolean

Sync cost prices
syncImages Required / boolean

Sync images

Default value is true.
syncPricing Required / boolean

Sync pricing

Default value is true.
syncQuickbookSalesAutomatically boolean

Sync quickbook sales automatically
syncWeightZero Required / boolean

You may want to disable the syncing of weights if an item has no weight in your store. Otherwise, if you've manually adjusted the weight in Jetti or when fetching a dropship inventory feed, it might reset the weight back to zero again the next time the item is imported from your store.
taxCalculation Required / string

Tax calculation

Values are channel, taxRate, and taxjar. Default value is channel.
taxId string

This will be added to the "ship from" address the commerical invoices when shipping labels are generated. If the dropship provider has added their tax id in their settings, their tax id will be used instead of the value here.
taxIncluded Required / boolean

Tax included

Default value is true.
taxShipping Required / boolean

Tax shipping

Default value is true.
unallocatedDropship Required / string

When finalizing an order, dropship items not allocated to a dropship provider. When this happens, you can either pause the order to resolve. Or, continue to finalize and process the order, allow the line item to be mapped later.

Values are ignore and pause. Default value is pause.
unassignedSaleItems Required / string

Unassigned sale items

Values are include, exclude, and block. Default value is include.
unpublishNoInventory Required / boolean

Unpublish no inventory
useOrderRoutingEndpoint Required / boolean

Use the Jetti API to automatically route and select the appropriate dropship provider during checkout and when finalizing orders.
variantImportScope Required / string

Variant import scope

Values are product and mapping. Default value is product.
variantLogging Required / boolean

Variant logging
warehouseId Required / integer(int32)

Warehouse
warehouseSync Required / string

Warehouse sync

Values are default and all. Default value is default.
weightUnit Required / string

Weight unit

Values are g, kg, oz, and lb. Default value is g.

Responses

• 200 object

Successful response
- addressValidationEndpoint string
  
  Address validation endpoint
- addressValidationFinalize Required / boolean
  
  Address validation finalize
- aftershipError Required / string
  
  When there is an error returned from AfterShip (e.g. if the carrier name was missing), you can select whether to pause sending the shipment notification to your store. Or, continue to sync the shipment with your online store despite the error.
  
  Values are skip and error. Default value is skip.
- allocateDraftSales Required / string
  
  Allocate draft sales
  
  Values are enabled and disabled. Default value is enabled.
- allocatedShipments Required / string
  
  If an item can not be allocated to a dropship provider or warehouse, you can either allow the customer to continue to checkout. Or, throw an error.
  
  Values are allow and error. Default value is allow.
- automaticallyCancelSales Required / boolean
  
  Automatically cancel sales
  
  Default value is true.
- automaticallyFinalizeSales Required / boolean
  
  Automatically finalize sales
  
  Default value is true.
- automaticallyPublish Required / boolean
  
  Automatically publish
  
  Default value is true.
- blendedPreference Required / string
  
  Blended preference
  
  Values are dropship, inhouse, and routing. Default value is inhouse.
- checkoutString string
  
  Checkout string
- collectionEndpoint string
  
  Collection endpoint
- connectToFeed boolean
  
  Connect to feed
- connectedAt string(date-time)
  
  Connected at
- createdAt string(date-time)
  
  Created at
- disableVariantInventorySync boolean
  
  Disable variant inventory sync
- dropshipProviderId integer(int32)
  
  Dropship provider
- dropshipRouting Required / string
  
  Dropship routing
  
  Values are default and custom. Default value is default.
- dropshipRoutingTags array[string]
  
  Dropship routing tags
- dropshipTags Required / array[string]
  
  Dropship tags
- email string
  
  Email
- enableFreeShippingCountries Required / boolean
  
  Enable free shipping countries
- exportToShipstation boolean
  
  Export to shipstation
- forceConnectToFeed Required / boolean
  
  Force connect to feed
- freeShippingCode string
  
  Free shipping code
- freeShippingCountries array[string]
  
  Free shipping countries
- freeShippingName string
  
  Free shipping name
- freeShippingOriginCountries array[string]
  
  Free shipping origin countries
- freeShippingOverride boolean
  
  Free shipping override
- freeShippingScope Required / string
  
  Free shipping scope
  
  Values are all, domestic, and selected. Default value is all.
- freeShippingThreshold number
  
  Free shipping threshold
- hash
  
  Hash
- hideWhenNoCostPrice boolean
  
  Hide when no cost price
- id integer(int32)
  
  Id
- imageSync Required / string
  
  Image sync
  
  Values are bidirectional, jetti, channel, and inventoryFeed. Default value is bidirectional.
- importFromFeed boolean
  
  Import from feed
- importPaymentStatus Required / string
  
  Import payment status
  
  Values are unpaid, partiallyPaid, and paid. Default value is paid.
- importProductsSeconds integer(int32)
  
  Import products seconds
- includeBackorderQuantity Required / boolean
  
  Include backorder quantity
  
  Default value is true.
- includeSaleTags Required / boolean
  
  Include sale tags
- inventoryFeedRemoved Required / string
  
  Inventory feed removed
  
  Values are all and partial. Default value is all.
- inventoryFeedUnpublish Required / string
  
  If a vendor removes the item from their store. Or, the item becomes unavailable from their feed, you can automatically make the item unavailable in your channel. This is done by setting the inventory policy to deny and the available quantity to 0.
  
  Values are none, unpublish, and unavailable. Default value is none.
- inventorySync Required / string
  
  Inventory sync
  
  Values are all, inventory_feeds, and none. Default value is all.
- manualSaleItemRouting Required / string
  
  Some e-commerce platforms may add non-product items to orders. For example, a line item for the gift messaging with an associated price. Or, an order might be imported into Jetti with an item not yet connected to a product. When this happens, you may want to pause the processing of the order until the product can be associated with a dropship provider.
  
  Values are ignore and pause. Default value is ignore.
- maxShippingCost boolean
  
  Max shipping cost
- maxShippingCostThreshold number
  
  Max shipping cost threshold
- maximumExpectedShipping string
  
  Dropship providers have the ability to change the expected delivery of an order. You can select whether this could be any date. Or, restrict the selection of the date so it's only within a specific number of days.
  
  Values are enabled and disabled.
- maximumExpectedShippingDuration Required / integer(int32)
  
  Maximum expected shipping duration
  
  Default value is 0.
- name Required / string
  
  Name
- negativeStock Required / string
  
  Negative stock
  
  Values are enabled and disabled. Default value is enabled.
- negativeStockLevel Required / integer(int32)
  
  Negative stock level
  
  Default value is 0.
- noRatesError Required / boolean
  
  No rates error
- orderRouting Required / string
  
  Order routing
  
  Values are automated, manual, and ignore. Default value is automated.
- orderRoutingEndpoint string
  
  Order routing endpoint
- oversellingPrevention Required / string
  
  Overselling prevention
  
  Values are enabled and disabled. Default value is disabled.
- parentChannel Required / string
  
  Parent channel
  
  Values are bigCommerce, custom, duoplane, elasticPath, magento, manual, salesforce, shopify, and wooCommerce. Default value is manual.
- pdfLegal string
  
  Pdf legal
- phone string
  
  Phone
- priceListId Required / integer(int32)
  
  Price list
- productsImportedAt string(date-time)
  
  Products imported at
- publishAdditionalTags Required / array[string]
  
  When items are published to the channel, you can specify any additional tags to include.
  
  Default value is ["jetti"].
- publishMetaFields boolean
  
  Publish meta fields
- publishProducts Required / boolean
  
  Publish products
  
  Default value is true.
- publishProductsWithoutPrice Required / boolean
  
  Publish products without price
  
  Default value is true.
- publishTags Required / string
  
  Publish tags
  
  Values are all and none. Default value is all.
- purchasePrefix string
  
  Purchase prefix
- purchaseStatusId integer(int32)
  
  Purchase status
- rateLogging Required / boolean
  
  Rate logging
- requirePhoneNumber Required / boolean
  
  The order will not be able to be finalized and processed if a phone number was not supplied by the customer. Jetti won't check to see if the phone number is valid (e.g. a valid US phone number), it will just check to see if a phone number was added. The phone number is typically provided by the customer and they are purchasing items in your online store. When enabled, you'll receive an email notification letting you know an order was imported if a phone number is not found.
- requireVendorName boolean
  
  Require vendor name
- routingPriorityOne Required / string
  
  Routing priority one
  
  Values are none, country, costPrice, and inStock. Default value is inStock.
- routingPriorityThree Required / string
  
  Routing priority three
  
  Values are none, country, costPrice, and inStock. Default value is none.
- routingPriorityTwo Required / string
  
  Routing priority two
  
  Values are none, country, costPrice, and inStock. Default value is none.
- saleCustomFields array[string]
  
  Select the names of the custom fields to be applied. E.g. vat_number, gift_note.
- saleCustomFieldsScope Required / string
  
  When importing sales from your channel, custom or meta fields may be applied. For example, the Customer VAT number of gift note. By default, none of the custom fields are applied to the dropship purchase order. You can optionally include all or a selection of the custom fields when dropship orders are raised.
  
  Values are all, selected, and none. Default value is none.
- saleLogging Required / boolean
  
  When connecting custom frontends to Jetti, it may be useful to log all incoming data for inspecting and validating. This will detail the payload send to Jetti and any errors encountered processing the data.
- saleLoggingEmail Required / string
  
  When importing data from your online store, you can be notified if an error is encountered. We'd recommend only using this for custom frontends, where developers are building a connector with Jetti.
  
  Values are none, initial, and all. Default value is none.
- saleMetaFieldFilter array[string]
  
  Create an allow list of meta field keys/names to import on orders. May be useful when you want to exclude metafields being added from 3rd party apps.
- saleMetaFields Required / string
  
  Select whether to import custom fields on orders. Currently, Shopify orders will import all custom fields.
  
  Values are all, selected, and none. Default value is none.
- salePrefix string
  
  Sale prefix
- sendShippingNotification Required / boolean
  
  This will trigger an email being sent to the customer within your online store. Jetti does not send the email. Instead, we'll notify your online store to send their default shipping email. For example, on Shopify, this will send the default shipping notification template.
  
  Default value is true.
- shippingInvoiceTemplate string
  
  Optional. Customize the reference for inclusion on commercial invoices. You can use {reference} for adding in the reference. E.g. "INVOICE_{reference}"
- shipstationConnectedAt string(date-time)
  
  Shipstation connected at
- shipstationPassword string
  
  Shipstation password
- shipstationTags array[string]
  
  Shipstation tags
- shipstationUrl
  
  Shipstation url
- shipstationUsername string
  
  Shipstation username
- skipLineItems Required / array[string]
  
  Skip line items
- skipTags Required / array[string]
  
  Skip tags
- skipVariantTags Required / array[string]
  
  Skip variant tags
- splitShipping Required / string
  
  Split shipping
  
  Values are quantity, value, equal, full, and first. Default value is full.
- syncAddressUpdates Required / boolean
  
  Sync address updates
  
  Default value is true.
- syncCostPrices Required / boolean
  
  Sync cost prices
- syncImages Required / boolean
  
  Sync images
  
  Default value is true.
- syncPricing Required / boolean
  
  Sync pricing
  
  Default value is true.
- syncQuickbookSalesAutomatically boolean
  
  Sync quickbook sales automatically
- syncWeightZero Required / boolean
  
  You may want to disable the syncing of weights if an item has no weight in your store. Otherwise, if you've manually adjusted the weight in Jetti or when fetching a dropship inventory feed, it might reset the weight back to zero again the next time the item is imported from your store.
- taxCalculation Required / string
  
  Tax calculation
  
  Values are channel, taxRate, and taxjar. Default value is channel.
- taxId string
  
  This will be added to the "ship from" address the commerical invoices when shipping labels are generated. If the dropship provider has added their tax id in their settings, their tax id will be used instead of the value here.
- taxIncluded Required / boolean
  
  Tax included
  
  Default value is true.
- taxShipping Required / boolean
  
  Tax shipping
  
  Default value is true.
- unallocatedDropship Required / string
  
  When finalizing an order, dropship items not allocated to a dropship provider. When this happens, you can either pause the order to resolve. Or, continue to finalize and process the order, allow the line item to be mapped later.
  
  Values are ignore and pause. Default value is pause.
- unassignedSaleItems Required / string
  
  Unassigned sale items
  
  Values are include, exclude, and block. Default value is include.
- unpublishNoInventory Required / boolean
  
  Unpublish no inventory
- updatedAt string(date-time)
  
  Updated at
- useOrderRoutingEndpoint Required / boolean
  
  Use the Jetti API to automatically route and select the appropriate dropship provider during checkout and when finalizing orders.
- variantImportScope Required / string
  
  Variant import scope
  
  Values are product and mapping. Default value is product.
- variantLogging Required / boolean
  
  Variant logging
- warehouseId Required / integer(int32)
  
  Warehouse
- warehouseSync Required / string
  
  Warehouse sync
  
  Values are default and all. Default value is default.
- weightUnit Required / string
  
  Weight unit
  
  Values are g, kg, oz, and lb. Default value is g.

Definition

POST http://api.example.com/v1/channels.json

cURL example

curl \
 -X POST http://api.example.com/v1/channels.json \
 -H "Content-Type: application/json" \
 -d '{"addressValidationEndpoint":"string","addressValidationFinalize":true,"aftershipError":"skip","allocateDraftSales":"enabled","allocatedShipments":"allow","automaticallyCancelSales":true,"automaticallyFinalizeSales":true,"automaticallyPublish":true,"blendedPreference":"dropship","checkoutString":"string","collectionEndpoint":"string","connectToFeed":true,"connectedAt":"2021-05-04T09:42:00+00:00","disableVariantInventorySync":true,"dropshipProviderId":42,"dropshipRouting":"default","dropshipR...}'

Request payload example

{
  "addressValidationEndpoint": "string",
  "addressValidationFinalize": true,
  "aftershipError": "skip",
  "allocateDraftSales": "enabled",
  "allocatedShipments": "allow",
  "automaticallyCancelSales": true,
  "automaticallyFinalizeSales": true,
  "automaticallyPublish": true,
  "blendedPreference": "dropship",
  "checkoutString": "string",
  "collectionEndpoint": "string",
  "connectToFeed": true,
  "connectedAt": "2021-05-04T09:42:00+00:00",
  "disableVariantInventorySync": true,
  "dropshipProviderId": 42,
  "dropshipRouting": "default",
  "dropshipRoutingTags": [
    "string"
  ],
  "dropshipTags": [
    "string"
  ],
  "email": "string",
  "enableFreeShippingCountries": true,
  "exportToShipstation": true,
  "forceConnectToFeed": true,
  "freeShippingCode": "string",
  "freeShippingCountries": [
    "string"
  ],
  "freeShippingName": "string",
  "freeShippingOriginCountries": [
    "string"
  ],
  "freeShippingOverride": true,
  "freeShippingScope": "all",
  "freeShippingThreshold": 42.0,
  "hash": "string",
  "hideWhenNoCostPrice": true,
  "imageSync": "bidirectional",
  "importFromFeed": true,
  "importPaymentStatus": "unpaid",
  "importProductsSeconds": 42,
  "includeBackorderQuantity": true,
  "includeSaleTags": true,
  "inventoryFeedRemoved": "all",
  "inventoryFeedUnpublish": "none",
  "inventorySync": "all",
  "manualSaleItemRouting": "ignore",
  "maxShippingCost": true,
  "maxShippingCostThreshold": 42.0,
  "maximumExpectedShipping": "enabled",
  "maximumExpectedShippingDuration": 42,
  "name": "string",
  "negativeStock": "enabled",
  "negativeStockLevel": 42,
  "noRatesError": true,
  "orderRouting": "automated",
  "orderRoutingEndpoint": "string",
  "oversellingPrevention": "enabled",
  "parentChannel": "bigCommerce",
  "pdfLegal": "string",
  "phone": "string",
  "priceListId": 42,
  "productsImportedAt": "2021-05-04T09:42:00+00:00",
  "publishAdditionalTags": [
    "string"
  ],
  "publishMetaFields": true,
  "publishProducts": true,
  "publishProductsWithoutPrice": true,
  "publishTags": "all",
  "purchasePrefix": "string",
  "purchaseStatusId": 42,
  "rateLogging": true,
  "requirePhoneNumber": true,
  "requireVendorName": true,
  "routingPriorityOne": "none",
  "routingPriorityThree": "none",
  "routingPriorityTwo": "none",
  "saleCustomFields": [
    "string"
  ],
  "saleCustomFieldsScope": "all",
  "saleLogging": true,
  "saleLoggingEmail": "none",
  "saleMetaFieldFilter": [
    "string"
  ],
  "saleMetaFields": "all",
  "salePrefix": "string",
  "sendShippingNotification": true,
  "shippingInvoiceTemplate": "string",
  "shipstationConnectedAt": "2021-05-04T09:42:00+00:00",
  "shipstationPassword": "string",
  "shipstationTags": [
    "string"
  ],
  "shipstationUrl": "string",
  "shipstationUsername": "string",
  "skipLineItems": [
    "string"
  ],
  "skipTags": [
    "string"
  ],
  "skipVariantTags": [
    "string"
  ],
  "splitShipping": "quantity",
  "syncAddressUpdates": true,
  "syncCostPrices": true,
  "syncImages": true,
  "syncPricing": true,
  "syncQuickbookSalesAutomatically": true,
  "syncWeightZero": true,
  "taxCalculation": "channel",
  "taxId": "string",
  "taxIncluded": true,
  "taxShipping": true,
  "unallocatedDropship": "ignore",
  "unassignedSaleItems": "include",
  "unpublishNoInventory": true,
  "useOrderRoutingEndpoint": true,
  "variantImportScope": "product",
  "variantLogging": true,
  "warehouseId": 42,
  "warehouseSync": "default",
  "weightUnit": "g"
}

Response example (200)

{
  "addressValidationEndpoint": "string",
  "addressValidationFinalize": true,
  "aftershipError": "skip",
  "allocateDraftSales": "enabled",
  "allocatedShipments": "allow",
  "automaticallyCancelSales": true,
  "automaticallyFinalizeSales": true,
  "automaticallyPublish": true,
  "blendedPreference": "dropship",
  "checkoutString": "string",
  "collectionEndpoint": "string",
  "connectToFeed": true,
  "connectedAt": "2021-05-04T09:42:00+00:00",
  "createdAt": "2021-05-04T09:42:00+00:00",
  "disableVariantInventorySync": true,
  "dropshipProviderId": 42,
  "dropshipRouting": "default",
  "dropshipRoutingTags": [
    "string"
  ],
  "dropshipTags": [
    "string"
  ],
  "email": "string",
  "enableFreeShippingCountries": true,
  "exportToShipstation": true,
  "forceConnectToFeed": true,
  "freeShippingCode": "string",
  "freeShippingCountries": [
    "string"
  ],
  "freeShippingName": "string",
  "freeShippingOriginCountries": [
    "string"
  ],
  "freeShippingOverride": true,
  "freeShippingScope": "all",
  "freeShippingThreshold": 42.0,
  "hash": "string",
  "hideWhenNoCostPrice": true,
  "id": 42,
  "imageSync": "bidirectional",
  "importFromFeed": true,
  "importPaymentStatus": "unpaid",
  "importProductsSeconds": 42,
  "includeBackorderQuantity": true,
  "includeSaleTags": true,
  "inventoryFeedRemoved": "all",
  "inventoryFeedUnpublish": "none",
  "inventorySync": "all",
  "manualSaleItemRouting": "ignore",
  "maxShippingCost": true,
  "maxShippingCostThreshold": 42.0,
  "maximumExpectedShipping": "enabled",
  "maximumExpectedShippingDuration": 42,
  "name": "string",
  "negativeStock": "enabled",
  "negativeStockLevel": 42,
  "noRatesError": true,
  "orderRouting": "automated",
  "orderRoutingEndpoint": "string",
  "oversellingPrevention": "enabled",
  "parentChannel": "bigCommerce",
  "pdfLegal": "string",
  "phone": "string",
  "priceListId": 42,
  "productsImportedAt": "2021-05-04T09:42:00+00:00",
  "publishAdditionalTags": [
    "string"
  ],
  "publishMetaFields": true,
  "publishProducts": true,
  "publishProductsWithoutPrice": true,
  "publishTags": "all",
  "purchasePrefix": "string",
  "purchaseStatusId": 42,
  "rateLogging": true,
  "requirePhoneNumber": true,
  "requireVendorName": true,
  "routingPriorityOne": "none",
  "routingPriorityThree": "none",
  "routingPriorityTwo": "none",
  "saleCustomFields": [
    "string"
  ],
  "saleCustomFieldsScope": "all",
  "saleLogging": true,
  "saleLoggingEmail": "none",
  "saleMetaFieldFilter": [
    "string"
  ],
  "saleMetaFields": "all",
  "salePrefix": "string",
  "sendShippingNotification": true,
  "shippingInvoiceTemplate": "string",
  "shipstationConnectedAt": "2021-05-04T09:42:00+00:00",
  "shipstationPassword": "string",
  "shipstationTags": [
    "string"
  ],
  "shipstationUrl": "string",
  "shipstationUsername": "string",
  "skipLineItems": [
    "string"
  ],
  "skipTags": [
    "string"
  ],
  "skipVariantTags": [
    "string"
  ],
  "splitShipping": "quantity",
  "syncAddressUpdates": true,
  "syncCostPrices": true,
  "syncImages": true,
  "syncPricing": true,
  "syncQuickbookSalesAutomatically": true,
  "syncWeightZero": true,
  "taxCalculation": "channel",
  "taxId": "string",
  "taxIncluded": true,
  "taxShipping": true,
  "unallocatedDropship": "ignore",
  "unassignedSaleItems": "include",
  "unpublishNoInventory": true,
  "updatedAt": "2021-05-04T09:42:00+00:00",
  "useOrderRoutingEndpoint": true,
  "variantImportScope": "product",
  "variantLogging": true,
  "warehouseId": 42,
  "warehouseSync": "default",
  "weightUnit": "g"
}

GET /channels/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Responses

• 200 object

Successful response
- addressValidationEndpoint string
  
  Address validation endpoint
- addressValidationFinalize Required / boolean
  
  Address validation finalize
- aftershipError Required / string
  
  When there is an error returned from AfterShip (e.g. if the carrier name was missing), you can select whether to pause sending the shipment notification to your store. Or, continue to sync the shipment with your online store despite the error.
  
  Values are skip and error. Default value is skip.
- allocateDraftSales Required / string
  
  Allocate draft sales
  
  Values are enabled and disabled. Default value is enabled.
- allocatedShipments Required / string
  
  If an item can not be allocated to a dropship provider or warehouse, you can either allow the customer to continue to checkout. Or, throw an error.
  
  Values are allow and error. Default value is allow.
- automaticallyCancelSales Required / boolean
  
  Automatically cancel sales
  
  Default value is true.
- automaticallyFinalizeSales Required / boolean
  
  Automatically finalize sales
  
  Default value is true.
- automaticallyPublish Required / boolean
  
  Automatically publish
  
  Default value is true.
- blendedPreference Required / string
  
  Blended preference
  
  Values are dropship, inhouse, and routing. Default value is inhouse.
- checkoutString string
  
  Checkout string
- collectionEndpoint string
  
  Collection endpoint
- connectToFeed boolean
  
  Connect to feed
- connectedAt string(date-time)
  
  Connected at
- createdAt string(date-time)
  
  Created at
- disableVariantInventorySync boolean
  
  Disable variant inventory sync
- dropshipProviderId integer(int32)
  
  Dropship provider
- dropshipRouting Required / string
  
  Dropship routing
  
  Values are default and custom. Default value is default.
- dropshipRoutingTags array[string]
  
  Dropship routing tags
- dropshipTags Required / array[string]
  
  Dropship tags
- email string
  
  Email
- enableFreeShippingCountries Required / boolean
  
  Enable free shipping countries
- exportToShipstation boolean
  
  Export to shipstation
- forceConnectToFeed Required / boolean
  
  Force connect to feed
- freeShippingCode string
  
  Free shipping code
- freeShippingCountries array[string]
  
  Free shipping countries
- freeShippingName string
  
  Free shipping name
- freeShippingOriginCountries array[string]
  
  Free shipping origin countries
- freeShippingOverride boolean
  
  Free shipping override
- freeShippingScope Required / string
  
  Free shipping scope
  
  Values are all, domestic, and selected. Default value is all.
- freeShippingThreshold number
  
  Free shipping threshold
- hash
  
  Hash
- hideWhenNoCostPrice boolean
  
  Hide when no cost price
- id integer(int32)
  
  Id
- imageSync Required / string
  
  Image sync
  
  Values are bidirectional, jetti, channel, and inventoryFeed. Default value is bidirectional.
- importFromFeed boolean
  
  Import from feed
- importPaymentStatus Required / string
  
  Import payment status
  
  Values are unpaid, partiallyPaid, and paid. Default value is paid.
- importProductsSeconds integer(int32)
  
  Import products seconds
- includeBackorderQuantity Required / boolean
  
  Include backorder quantity
  
  Default value is true.
- includeSaleTags Required / boolean
  
  Include sale tags
- inventoryFeedRemoved Required / string
  
  Inventory feed removed
  
  Values are all and partial. Default value is all.
- inventoryFeedUnpublish Required / string
  
  If a vendor removes the item from their store. Or, the item becomes unavailable from their feed, you can automatically make the item unavailable in your channel. This is done by setting the inventory policy to deny and the available quantity to 0.
  
  Values are none, unpublish, and unavailable. Default value is none.
- inventorySync Required / string
  
  Inventory sync
  
  Values are all, inventory_feeds, and none. Default value is all.
- manualSaleItemRouting Required / string
  
  Some e-commerce platforms may add non-product items to orders. For example, a line item for the gift messaging with an associated price. Or, an order might be imported into Jetti with an item not yet connected to a product. When this happens, you may want to pause the processing of the order until the product can be associated with a dropship provider.
  
  Values are ignore and pause. Default value is ignore.
- maxShippingCost boolean
  
  Max shipping cost
- maxShippingCostThreshold number
  
  Max shipping cost threshold
- maximumExpectedShipping string
  
  Dropship providers have the ability to change the expected delivery of an order. You can select whether this could be any date. Or, restrict the selection of the date so it's only within a specific number of days.
  
  Values are enabled and disabled.
- maximumExpectedShippingDuration Required / integer(int32)
  
  Maximum expected shipping duration
  
  Default value is 0.
- name Required / string
  
  Name
- negativeStock Required / string
  
  Negative stock
  
  Values are enabled and disabled. Default value is enabled.
- negativeStockLevel Required / integer(int32)
  
  Negative stock level
  
  Default value is 0.
- noRatesError Required / boolean
  
  No rates error
- orderRouting Required / string
  
  Order routing
  
  Values are automated, manual, and ignore. Default value is automated.
- orderRoutingEndpoint string
  
  Order routing endpoint
- oversellingPrevention Required / string
  
  Overselling prevention
  
  Values are enabled and disabled. Default value is disabled.
- parentChannel Required / string
  
  Parent channel
  
  Values are bigCommerce, custom, duoplane, elasticPath, magento, manual, salesforce, shopify, and wooCommerce. Default value is manual.
- pdfLegal string
  
  Pdf legal
- phone string
  
  Phone
- priceListId Required / integer(int32)
  
  Price list
- productsImportedAt string(date-time)
  
  Products imported at
- publishAdditionalTags Required / array[string]
  
  When items are published to the channel, you can specify any additional tags to include.
  
  Default value is ["jetti"].
- publishMetaFields boolean
  
  Publish meta fields
- publishProducts Required / boolean
  
  Publish products
  
  Default value is true.
- publishProductsWithoutPrice Required / boolean
  
  Publish products without price
  
  Default value is true.
- publishTags Required / string
  
  Publish tags
  
  Values are all and none. Default value is all.
- purchasePrefix string
  
  Purchase prefix
- purchaseStatusId integer(int32)
  
  Purchase status
- rateLogging Required / boolean
  
  Rate logging
- requirePhoneNumber Required / boolean
  
  The order will not be able to be finalized and processed if a phone number was not supplied by the customer. Jetti won't check to see if the phone number is valid (e.g. a valid US phone number), it will just check to see if a phone number was added. The phone number is typically provided by the customer and they are purchasing items in your online store. When enabled, you'll receive an email notification letting you know an order was imported if a phone number is not found.
- requireVendorName boolean
  
  Require vendor name
- routingPriorityOne Required / string
  
  Routing priority one
  
  Values are none, country, costPrice, and inStock. Default value is inStock.
- routingPriorityThree Required / string
  
  Routing priority three
  
  Values are none, country, costPrice, and inStock. Default value is none.
- routingPriorityTwo Required / string
  
  Routing priority two
  
  Values are none, country, costPrice, and inStock. Default value is none.
- saleCustomFields array[string]
  
  Select the names of the custom fields to be applied. E.g. vat_number, gift_note.
- saleCustomFieldsScope Required / string
  
  When importing sales from your channel, custom or meta fields may be applied. For example, the Customer VAT number of gift note. By default, none of the custom fields are applied to the dropship purchase order. You can optionally include all or a selection of the custom fields when dropship orders are raised.
  
  Values are all, selected, and none. Default value is none.
- saleLogging Required / boolean
  
  When connecting custom frontends to Jetti, it may be useful to log all incoming data for inspecting and validating. This will detail the payload send to Jetti and any errors encountered processing the data.
- saleLoggingEmail Required / string
  
  When importing data from your online store, you can be notified if an error is encountered. We'd recommend only using this for custom frontends, where developers are building a connector with Jetti.
  
  Values are none, initial, and all. Default value is none.
- saleMetaFieldFilter array[string]
  
  Create an allow list of meta field keys/names to import on orders. May be useful when you want to exclude metafields being added from 3rd party apps.
- saleMetaFields Required / string
  
  Select whether to import custom fields on orders. Currently, Shopify orders will import all custom fields.
  
  Values are all, selected, and none. Default value is none.
- salePrefix string
  
  Sale prefix
- sendShippingNotification Required / boolean
  
  This will trigger an email being sent to the customer within your online store. Jetti does not send the email. Instead, we'll notify your online store to send their default shipping email. For example, on Shopify, this will send the default shipping notification template.
  
  Default value is true.
- shippingInvoiceTemplate string
  
  Optional. Customize the reference for inclusion on commercial invoices. You can use {reference} for adding in the reference. E.g. "INVOICE_{reference}"
- shipstationConnectedAt string(date-time)
  
  Shipstation connected at
- shipstationPassword string
  
  Shipstation password
- shipstationTags array[string]
  
  Shipstation tags
- shipstationUrl
  
  Shipstation url
- shipstationUsername string
  
  Shipstation username
- skipLineItems Required / array[string]
  
  Skip line items
- skipTags Required / array[string]
  
  Skip tags
- skipVariantTags Required / array[string]
  
  Skip variant tags
- splitShipping Required / string
  
  Split shipping
  
  Values are quantity, value, equal, full, and first. Default value is full.
- syncAddressUpdates Required / boolean
  
  Sync address updates
  
  Default value is true.
- syncCostPrices Required / boolean
  
  Sync cost prices
- syncImages Required / boolean
  
  Sync images
  
  Default value is true.
- syncPricing Required / boolean
  
  Sync pricing
  
  Default value is true.
- syncQuickbookSalesAutomatically boolean
  
  Sync quickbook sales automatically
- syncWeightZero Required / boolean
  
  You may want to disable the syncing of weights if an item has no weight in your store. Otherwise, if you've manually adjusted the weight in Jetti or when fetching a dropship inventory feed, it might reset the weight back to zero again the next time the item is imported from your store.
- taxCalculation Required / string
  
  Tax calculation
  
  Values are channel, taxRate, and taxjar. Default value is channel.
- taxId string
  
  This will be added to the "ship from" address the commerical invoices when shipping labels are generated. If the dropship provider has added their tax id in their settings, their tax id will be used instead of the value here.
- taxIncluded Required / boolean
  
  Tax included
  
  Default value is true.
- taxShipping Required / boolean
  
  Tax shipping
  
  Default value is true.
- unallocatedDropship Required / string
  
  When finalizing an order, dropship items not allocated to a dropship provider. When this happens, you can either pause the order to resolve. Or, continue to finalize and process the order, allow the line item to be mapped later.
  
  Values are ignore and pause. Default value is pause.
- unassignedSaleItems Required / string
  
  Unassigned sale items
  
  Values are include, exclude, and block. Default value is include.
- unpublishNoInventory Required / boolean
  
  Unpublish no inventory
- updatedAt string(date-time)
  
  Updated at
- useOrderRoutingEndpoint Required / boolean
  
  Use the Jetti API to automatically route and select the appropriate dropship provider during checkout and when finalizing orders.
- variantImportScope Required / string
  
  Variant import scope
  
  Values are product and mapping. Default value is product.
- variantLogging Required / boolean
  
  Variant logging
- warehouseId Required / integer(int32)
  
  Warehouse
- warehouseSync Required / string
  
  Warehouse sync
  
  Values are default and all. Default value is default.
- weightUnit Required / string
  
  Weight unit
  
  Values are g, kg, oz, and lb. Default value is g.

Definition

GET http://api.example.com/v1/channels/{id}.json

cURL example

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

Response example (200)

{
  "addressValidationEndpoint": "string",
  "addressValidationFinalize": true,
  "aftershipError": "skip",
  "allocateDraftSales": "enabled",
  "allocatedShipments": "allow",
  "automaticallyCancelSales": true,
  "automaticallyFinalizeSales": true,
  "automaticallyPublish": true,
  "blendedPreference": "dropship",
  "checkoutString": "string",
  "collectionEndpoint": "string",
  "connectToFeed": true,
  "connectedAt": "2021-05-04T09:42:00+00:00",
  "createdAt": "2021-05-04T09:42:00+00:00",
  "disableVariantInventorySync": true,
  "dropshipProviderId": 42,
  "dropshipRouting": "default",
  "dropshipRoutingTags": [
    "string"
  ],
  "dropshipTags": [
    "string"
  ],
  "email": "string",
  "enableFreeShippingCountries": true,
  "exportToShipstation": true,
  "forceConnectToFeed": true,
  "freeShippingCode": "string",
  "freeShippingCountries": [
    "string"
  ],
  "freeShippingName": "string",
  "freeShippingOriginCountries": [
    "string"
  ],
  "freeShippingOverride": true,
  "freeShippingScope": "all",
  "freeShippingThreshold": 42.0,
  "hash": "string",
  "hideWhenNoCostPrice": true,
  "id": 42,
  "imageSync": "bidirectional",
  "importFromFeed": true,
  "importPaymentStatus": "unpaid",
  "importProductsSeconds": 42,
  "includeBackorderQuantity": true,
  "includeSaleTags": true,
  "inventoryFeedRemoved": "all",
  "inventoryFeedUnpublish": "none",
  "inventorySync": "all",
  "manualSaleItemRouting": "ignore",
  "maxShippingCost": true,
  "maxShippingCostThreshold": 42.0,
  "maximumExpectedShipping": "enabled",
  "maximumExpectedShippingDuration": 42,
  "name": "string",
  "negativeStock": "enabled",
  "negativeStockLevel": 42,
  "noRatesError": true,
  "orderRouting": "automated",
  "orderRoutingEndpoint": "string",
  "oversellingPrevention": "enabled",
  "parentChannel": "bigCommerce",
  "pdfLegal": "string",
  "phone": "string",
  "priceListId": 42,
  "productsImportedAt": "2021-05-04T09:42:00+00:00",
  "publishAdditionalTags": [
    "string"
  ],
  "publishMetaFields": true,
  "publishProducts": true,
  "publishProductsWithoutPrice": true,
  "publishTags": "all",
  "purchasePrefix": "string",
  "purchaseStatusId": 42,
  "rateLogging": true,
  "requirePhoneNumber": true,
  "requireVendorName": true,
  "routingPriorityOne": "none",
  "routingPriorityThree": "none",
  "routingPriorityTwo": "none",
  "saleCustomFields": [
    "string"
  ],
  "saleCustomFieldsScope": "all",
  "saleLogging": true,
  "saleLoggingEmail": "none",
  "saleMetaFieldFilter": [
    "string"
  ],
  "saleMetaFields": "all",
  "salePrefix": "string",
  "sendShippingNotification": true,
  "shippingInvoiceTemplate": "string",
  "shipstationConnectedAt": "2021-05-04T09:42:00+00:00",
  "shipstationPassword": "string",
  "shipstationTags": [
    "string"
  ],
  "shipstationUrl": "string",
  "shipstationUsername": "string",
  "skipLineItems": [
    "string"
  ],
  "skipTags": [
    "string"
  ],
  "skipVariantTags": [
    "string"
  ],
  "splitShipping": "quantity",
  "syncAddressUpdates": true,
  "syncCostPrices": true,
  "syncImages": true,
  "syncPricing": true,
  "syncQuickbookSalesAutomatically": true,
  "syncWeightZero": true,
  "taxCalculation": "channel",
  "taxId": "string",
  "taxIncluded": true,
  "taxShipping": true,
  "unallocatedDropship": "ignore",
  "unassignedSaleItems": "include",
  "unpublishNoInventory": true,
  "updatedAt": "2021-05-04T09:42:00+00:00",
  "useOrderRoutingEndpoint": true,
  "variantImportScope": "product",
  "variantLogging": true,
  "warehouseId": 42,
  "warehouseSync": "default",
  "weightUnit": "g"
}

PUT /channels/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Body

addressValidationEndpoint string

Address validation endpoint
addressValidationFinalize Required / boolean

Address validation finalize
aftershipError Required / string

When there is an error returned from AfterShip (e.g. if the carrier name was missing), you can select whether to pause sending the shipment notification to your store. Or, continue to sync the shipment with your online store despite the error.

Values are skip and error. Default value is skip.
allocateDraftSales Required / string

Allocate draft sales

Values are enabled and disabled. Default value is enabled.
allocatedShipments Required / string

If an item can not be allocated to a dropship provider or warehouse, you can either allow the customer to continue to checkout. Or, throw an error.

Values are allow and error. Default value is allow.
automaticallyCancelSales Required / boolean

Automatically cancel sales

Default value is true.
automaticallyFinalizeSales Required / boolean

Automatically finalize sales

Default value is true.
automaticallyPublish Required / boolean

Automatically publish

Default value is true.
blendedPreference Required / string

Blended preference

Values are dropship, inhouse, and routing. Default value is inhouse.
checkoutString string

Checkout string
collectionEndpoint string

Collection endpoint
connectToFeed boolean

Connect to feed
connectedAt string(date-time)

Connected at
createdAt string(date-time)

Created at
disableVariantInventorySync boolean

Disable variant inventory sync
dropshipProviderId integer(int32)

Dropship provider
dropshipRouting Required / string

Dropship routing

Values are default and custom. Default value is default.
dropshipRoutingTags array[string]

Dropship routing tags
dropshipTags Required / array[string]

Dropship tags
email string

Email
enableFreeShippingCountries Required / boolean

Enable free shipping countries
exportToShipstation boolean

Export to shipstation
forceConnectToFeed Required / boolean

Force connect to feed
freeShippingCode string

Free shipping code
freeShippingCountries array[string]

Free shipping countries
freeShippingName string

Free shipping name
freeShippingOriginCountries array[string]

Free shipping origin countries
freeShippingOverride boolean

Free shipping override
freeShippingScope Required / string

Free shipping scope

Values are all, domestic, and selected. Default value is all.
freeShippingThreshold number

Free shipping threshold
hash

Hash
hideWhenNoCostPrice boolean

Hide when no cost price
id integer(int32)

Id
imageSync Required / string

Image sync

Values are bidirectional, jetti, channel, and inventoryFeed. Default value is bidirectional.
importFromFeed boolean

Import from feed
importPaymentStatus Required / string

Import payment status

Values are unpaid, partiallyPaid, and paid. Default value is paid.
importProductsSeconds integer(int32)

Import products seconds
includeBackorderQuantity Required / boolean

Include backorder quantity

Default value is true.
includeSaleTags Required / boolean

Include sale tags
inventoryFeedRemoved Required / string

Inventory feed removed

Values are all and partial. Default value is all.
inventoryFeedUnpublish Required / string

If a vendor removes the item from their store. Or, the item becomes unavailable from their feed, you can automatically make the item unavailable in your channel. This is done by setting the inventory policy to deny and the available quantity to 0.

Values are none, unpublish, and unavailable. Default value is none.
inventorySync Required / string

Inventory sync

Values are all, inventory_feeds, and none. Default value is all.
manualSaleItemRouting Required / string

Some e-commerce platforms may add non-product items to orders. For example, a line item for the gift messaging with an associated price. Or, an order might be imported into Jetti with an item not yet connected to a product. When this happens, you may want to pause the processing of the order until the product can be associated with a dropship provider.

Values are ignore and pause. Default value is ignore.
maxShippingCost boolean

Max shipping cost
maxShippingCostThreshold number

Max shipping cost threshold
maximumExpectedShipping string

Dropship providers have the ability to change the expected delivery of an order. You can select whether this could be any date. Or, restrict the selection of the date so it's only within a specific number of days.

Values are enabled and disabled.
maximumExpectedShippingDuration Required / integer(int32)

Maximum expected shipping duration

Default value is 0.
name Required / string

Name
negativeStock Required / string

Negative stock

Values are enabled and disabled. Default value is enabled.
negativeStockLevel Required / integer(int32)

Negative stock level

Default value is 0.
noRatesError Required / boolean

No rates error
orderRouting Required / string

Order routing

Values are automated, manual, and ignore. Default value is automated.
orderRoutingEndpoint string

Order routing endpoint
oversellingPrevention Required / string

Overselling prevention

Values are enabled and disabled. Default value is disabled.
parentChannel Required / string

Parent channel

Values are bigCommerce, custom, duoplane, elasticPath, magento, manual, salesforce, shopify, and wooCommerce. Default value is manual.
pdfLegal string

Pdf legal
phone string

Phone
priceListId Required / integer(int32)

Price list
productsImportedAt string(date-time)

Products imported at
publishAdditionalTags Required / array[string]

When items are published to the channel, you can specify any additional tags to include.

Default value is ["jetti"].
publishMetaFields boolean

Publish meta fields
publishProducts Required / boolean

Publish products

Default value is true.
publishProductsWithoutPrice Required / boolean

Publish products without price

Default value is true.
publishTags Required / string

Publish tags

Values are all and none. Default value is all.
purchasePrefix string

Purchase prefix
purchaseStatusId integer(int32)

Purchase status
rateLogging Required / boolean

Rate logging
requirePhoneNumber Required / boolean

The order will not be able to be finalized and processed if a phone number was not supplied by the customer. Jetti won't check to see if the phone number is valid (e.g. a valid US phone number), it will just check to see if a phone number was added. The phone number is typically provided by the customer and they are purchasing items in your online store. When enabled, you'll receive an email notification letting you know an order was imported if a phone number is not found.
requireVendorName boolean

Require vendor name
routingPriorityOne Required / string

Routing priority one

Values are none, country, costPrice, and inStock. Default value is inStock.
routingPriorityThree Required / string

Routing priority three

Values are none, country, costPrice, and inStock. Default value is none.
routingPriorityTwo Required / string

Routing priority two

Values are none, country, costPrice, and inStock. Default value is none.
saleCustomFields array[string]

Select the names of the custom fields to be applied. E.g. vat_number, gift_note.
saleCustomFieldsScope Required / string

When importing sales from your channel, custom or meta fields may be applied. For example, the Customer VAT number of gift note. By default, none of the custom fields are applied to the dropship purchase order. You can optionally include all or a selection of the custom fields when dropship orders are raised.

Values are all, selected, and none. Default value is none.
saleLogging Required / boolean

When connecting custom frontends to Jetti, it may be useful to log all incoming data for inspecting and validating. This will detail the payload send to Jetti and any errors encountered processing the data.
saleLoggingEmail Required / string

When importing data from your online store, you can be notified if an error is encountered. We'd recommend only using this for custom frontends, where developers are building a connector with Jetti.

Values are none, initial, and all. Default value is none.
saleMetaFieldFilter array[string]

Create an allow list of meta field keys/names to import on orders. May be useful when you want to exclude metafields being added from 3rd party apps.
saleMetaFields Required / string

Select whether to import custom fields on orders. Currently, Shopify orders will import all custom fields.

Values are all, selected, and none. Default value is none.
salePrefix string

Sale prefix
sendShippingNotification Required / boolean

This will trigger an email being sent to the customer within your online store. Jetti does not send the email. Instead, we'll notify your online store to send their default shipping email. For example, on Shopify, this will send the default shipping notification template.

Default value is true.
shippingInvoiceTemplate string

Optional. Customize the reference for inclusion on commercial invoices. You can use {reference} for adding in the reference. E.g. "INVOICE_{reference}"
shipstationConnectedAt string(date-time)

Shipstation connected at
shipstationPassword string

Shipstation password
shipstationTags array[string]

Shipstation tags
shipstationUrl

Shipstation url
shipstationUsername string

Shipstation username
skipLineItems Required / array[string]

Skip line items
skipTags Required / array[string]

Skip tags
skipVariantTags Required / array[string]

Skip variant tags
splitShipping Required / string

Split shipping

Values are quantity, value, equal, full, and first. Default value is full.
syncAddressUpdates Required / boolean

Sync address updates

Default value is true.
syncCostPrices Required / boolean

Sync cost prices
syncImages Required / boolean

Sync images

Default value is true.
syncPricing Required / boolean

Sync pricing

Default value is true.
syncQuickbookSalesAutomatically boolean

Sync quickbook sales automatically
syncWeightZero Required / boolean

You may want to disable the syncing of weights if an item has no weight in your store. Otherwise, if you've manually adjusted the weight in Jetti or when fetching a dropship inventory feed, it might reset the weight back to zero again the next time the item is imported from your store.
taxCalculation Required / string

Tax calculation

Values are channel, taxRate, and taxjar. Default value is channel.
taxId string

This will be added to the "ship from" address the commerical invoices when shipping labels are generated. If the dropship provider has added their tax id in their settings, their tax id will be used instead of the value here.
taxIncluded Required / boolean

Tax included

Default value is true.
taxShipping Required / boolean

Tax shipping

Default value is true.
unallocatedDropship Required / string

When finalizing an order, dropship items not allocated to a dropship provider. When this happens, you can either pause the order to resolve. Or, continue to finalize and process the order, allow the line item to be mapped later.

Values are ignore and pause. Default value is pause.
unassignedSaleItems Required / string

Unassigned sale items

Values are include, exclude, and block. Default value is include.
unpublishNoInventory Required / boolean

Unpublish no inventory
updatedAt string(date-time)

Updated at
useOrderRoutingEndpoint Required / boolean

Use the Jetti API to automatically route and select the appropriate dropship provider during checkout and when finalizing orders.
variantImportScope Required / string

Variant import scope

Values are product and mapping. Default value is product.
variantLogging Required / boolean

Variant logging
warehouseId Required / integer(int32)

Warehouse
warehouseSync Required / string

Warehouse sync

Values are default and all. Default value is default.
weightUnit Required / string

Weight unit

Values are g, kg, oz, and lb. Default value is g.

Definition

PUT http://api.example.com/v1/channels/{id}.json

cURL example

curl \
 -X PUT http://api.example.com/v1/channels/{id}.json \
 -H "Content-Type: application/json" \
 -d '{"addressValidationEndpoint":"string","addressValidationFinalize":true,"aftershipError":"skip","allocateDraftSales":"enabled","allocatedShipments":"allow","automaticallyCancelSales":true,"automaticallyFinalizeSales":true,"automaticallyPublish":true,"blendedPreference":"dropship","checkoutString":"string","collectionEndpoint":"string","connectToFeed":true,"connectedAt":"2021-05-04T09:42:00+00:00","createdAt":"2021-05-04T09:42:00+00:00","disableVariantInventorySync":true,"dropshipProviderId":4...}'

Request payload example

{
  "addressValidationEndpoint": "string",
  "addressValidationFinalize": true,
  "aftershipError": "skip",
  "allocateDraftSales": "enabled",
  "allocatedShipments": "allow",
  "automaticallyCancelSales": true,
  "automaticallyFinalizeSales": true,
  "automaticallyPublish": true,
  "blendedPreference": "dropship",
  "checkoutString": "string",
  "collectionEndpoint": "string",
  "connectToFeed": true,
  "connectedAt": "2021-05-04T09:42:00+00:00",
  "createdAt": "2021-05-04T09:42:00+00:00",
  "disableVariantInventorySync": true,
  "dropshipProviderId": 42,
  "dropshipRouting": "default",
  "dropshipRoutingTags": [
    "string"
  ],
  "dropshipTags": [
    "string"
  ],
  "email": "string",
  "enableFreeShippingCountries": true,
  "exportToShipstation": true,
  "forceConnectToFeed": true,
  "freeShippingCode": "string",
  "freeShippingCountries": [
    "string"
  ],
  "freeShippingName": "string",
  "freeShippingOriginCountries": [
    "string"
  ],
  "freeShippingOverride": true,
  "freeShippingScope": "all",
  "freeShippingThreshold": 42.0,
  "hash": "string",
  "hideWhenNoCostPrice": true,
  "id": 42,
  "imageSync": "bidirectional",
  "importFromFeed": true,
  "importPaymentStatus": "unpaid",
  "importProductsSeconds": 42,
  "includeBackorderQuantity": true,
  "includeSaleTags": true,
  "inventoryFeedRemoved": "all",
  "inventoryFeedUnpublish": "none",
  "inventorySync": "all",
  "manualSaleItemRouting": "ignore",
  "maxShippingCost": true,
  "maxShippingCostThreshold": 42.0,
  "maximumExpectedShipping": "enabled",
  "maximumExpectedShippingDuration": 42,
  "name": "string",
  "negativeStock": "enabled",
  "negativeStockLevel": 42,
  "noRatesError": true,
  "orderRouting": "automated",
  "orderRoutingEndpoint": "string",
  "oversellingPrevention": "enabled",
  "parentChannel": "bigCommerce",
  "pdfLegal": "string",
  "phone": "string",
  "priceListId": 42,
  "productsImportedAt": "2021-05-04T09:42:00+00:00",
  "publishAdditionalTags": [
    "string"
  ],
  "publishMetaFields": true,
  "publishProducts": true,
  "publishProductsWithoutPrice": true,
  "publishTags": "all",
  "purchasePrefix": "string",
  "purchaseStatusId": 42,
  "rateLogging": true,
  "requirePhoneNumber": true,
  "requireVendorName": true,
  "routingPriorityOne": "none",
  "routingPriorityThree": "none",
  "routingPriorityTwo": "none",
  "saleCustomFields": [
    "string"
  ],
  "saleCustomFieldsScope": "all",
  "saleLogging": true,
  "saleLoggingEmail": "none",
  "saleMetaFieldFilter": [
    "string"
  ],
  "saleMetaFields": "all",
  "salePrefix": "string",
  "sendShippingNotification": true,
  "shippingInvoiceTemplate": "string",
  "shipstationConnectedAt": "2021-05-04T09:42:00+00:00",
  "shipstationPassword": "string",
  "shipstationTags": [
    "string"
  ],
  "shipstationUrl": "string",
  "shipstationUsername": "string",
  "skipLineItems": [
    "string"
  ],
  "skipTags": [
    "string"
  ],
  "skipVariantTags": [
    "string"
  ],
  "splitShipping": "quantity",
  "syncAddressUpdates": true,
  "syncCostPrices": true,
  "syncImages": true,
  "syncPricing": true,
  "syncQuickbookSalesAutomatically": true,
  "syncWeightZero": true,
  "taxCalculation": "channel",
  "taxId": "string",
  "taxIncluded": true,
  "taxShipping": true,
  "unallocatedDropship": "ignore",
  "unassignedSaleItems": "include",
  "unpublishNoInventory": true,
  "updatedAt": "2021-05-04T09:42:00+00:00",
  "useOrderRoutingEndpoint": true,
  "variantImportScope": "product",
  "variantLogging": true,
  "warehouseId": 42,
  "warehouseSync": "default",
  "weightUnit": "g"
}

DELETE /channels/{id}.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Definition

DELETE http://api.example.com/v1/channels/{id}.json

cURL example

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

POST /channels/{id}/rates.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Body

errors array[object]
- type string
- status number
- title string
days integer
missingRates boolean
unallocatedShipments boolean
totalPrice number
totalShipments integer
shipments array[object]
- dropshipProvider object
- shipping_rate object
- isDomestic boolean
- fromCountry string
- weight number
- dimensions object
  length number
  
  width number
  
  height number
  
  distanceUnit string
  
  Values are em and in.
  
  massUnit string
  
  Values are kg, g, oz, and lb.
- totalItems integer
- orderValue number
- price number
- provider string
- providerCode string
- providerId string
- days integer
- serviceLevel string
- serviceLevelToken string
- serviceLevelTerms string
- quoteHash string
- integration string
- serviceCode string
- handlingFee integer
- label string
- signatureRequired boolean
- fallback boolean
- freeShipping boolean
- saleItems array[object]
  quantity integer
  
  price number
  
  variant object
- errors array[object]
  type string
  
  status number
  
  title string
- alternatives array[object]
  price number
  
  provider string
  
  providerCode string
  
  providerId string
  
  days integer
  
  serviceLevel string
  
  serviceLevelToken string
  
  serviceLevelTerms string
  
  quoteHash string
  
  integration string
  
  serviceCode string
  
  handlingFee integer
  
  label string
  
  signatureRequired boolean
  
  fallback boolean
  
  freeShipping boolean

Responses

• 200 object

Successful response
- errors array[object]
  type string
  
  status number
  
  title string
- days integer
- missingRates boolean
- unallocatedShipments boolean
- totalPrice number
- totalShipments integer
- shipments array[object]
  dropshipProvider object
  
  shipping_rate object
  
  isDomestic boolean
  
  fromCountry string
  
  weight number
  
  dimensions object
  
  length number
  
  width number
  
  height number
  
  distanceUnit string
  
  Values are em and in.
  
  massUnit string
  
  Values are kg, g, oz, and lb.
  
  totalItems integer
  
  orderValue number
  
  price number
  
  provider string
  
  providerCode string
  
  providerId string
  
  days integer
  
  serviceLevel string
  
  serviceLevelToken string
  
  serviceLevelTerms string
  
  quoteHash string
  
  integration string
  
  serviceCode string
  
  handlingFee integer
  
  label string
  
  signatureRequired boolean
  
  fallback boolean
  
  freeShipping boolean
  
  saleItems array[object]
  
  quantity integer
  
  price number
  
  variant object
  
  errors array[object]
  
  type string
  
  status number
  
  title string
  
  alternatives array[object]
  
  price number
  
  provider string
  
  providerCode string
  
  providerId string
  
  days integer
  
  serviceLevel string
  
  serviceLevelToken string
  
  serviceLevelTerms string
  
  quoteHash string
  
  integration string
  
  serviceCode string
  
  handlingFee integer
  
  label string
  
  signatureRequired boolean
  
  fallback boolean
  
  freeShipping boolean

Definition

POST http://api.example.com/v1/channels/{id}/rates.json

cURL example

curl \
 -X POST http://api.example.com/v1/channels/{id}/rates.json \
 -H "Content-Type: application/json" \
 -d '{"errors":[{"type":"string","status":42.0,"title":"string"}],"days":42,"missingRates":true,"unallocatedShipments":true,"totalPrice":42.0,"totalShipments":42,"shipments":[{"dropshipProvider":{},"shipping_rate":{},"isDomestic":true,"fromCountry":"string","weight":42.0,"dimensions":{"length":42.0,"width":42.0,"height":42.0,"distanceUnit":"em","massUnit":"kg"},"totalItems":42,"orderValue":42.0,"price":42.0,"provider":"string","providerCode":"string","providerId":"string","days":42,"serviceLevel"...}'

Request payload example

{
  "errors": [
    {
      "type": "string",
      "status": 42.0,
      "title": "string"
    }
  ],
  "days": 42,
  "missingRates": true,
  "unallocatedShipments": true,
  "totalPrice": 42.0,
  "totalShipments": 42,
  "shipments": [
    {
      "dropshipProvider": {},
      "shipping_rate": {},
      "isDomestic": true,
      "fromCountry": "string",
      "weight": 42.0,
      "dimensions": {
        "length": 42.0,
        "width": 42.0,
        "height": 42.0,
        "distanceUnit": "em",
        "massUnit": "kg"
      },
      "totalItems": 42,
      "orderValue": 42.0,
      "price": 42.0,
      "provider": "string",
      "providerCode": "string",
      "providerId": "string",
      "days": 42,
      "serviceLevel": "string",
      "serviceLevelToken": "string",
      "serviceLevelTerms": "string",
      "quoteHash": "string",
      "integration": "string",
      "serviceCode": "string",
      "handlingFee": 42,
      "label": "string",
      "signatureRequired": true,
      "fallback": true,
      "freeShipping": true,
      "saleItems": [
        {
          "quantity": 42,
          "price": 42.0,
          "variant": {}
        }
      ],
      "errors": [
        {
          "type": "string",
          "status": 42.0,
          "title": "string"
        }
      ],
      "alternatives": [
        {
          "price": 42.0,
          "provider": "string",
          "providerCode": "string",
          "providerId": "string",
          "days": 42,
          "serviceLevel": "string",
          "serviceLevelToken": "string",
          "serviceLevelTerms": "string",
          "quoteHash": "string",
          "integration": "string",
          "serviceCode": "string",
          "handlingFee": 42,
          "label": "string",
          "signatureRequired": true,
          "fallback": true,
          "freeShipping": true
        }
      ]
    }
  ]
}

Response example (200)

{
  "errors": [
    {
      "type": "string",
      "status": 42.0,
      "title": "string"
    }
  ],
  "days": 42,
  "missingRates": true,
  "unallocatedShipments": true,
  "totalPrice": 42.0,
  "totalShipments": 42,
  "shipments": [
    {
      "dropshipProvider": {},
      "shipping_rate": {},
      "isDomestic": true,
      "fromCountry": "string",
      "weight": 42.0,
      "dimensions": {
        "length": 42.0,
        "width": 42.0,
        "height": 42.0,
        "distanceUnit": "em",
        "massUnit": "kg"
      },
      "totalItems": 42,
      "orderValue": 42.0,
      "price": 42.0,
      "provider": "string",
      "providerCode": "string",
      "providerId": "string",
      "days": 42,
      "serviceLevel": "string",
      "serviceLevelToken": "string",
      "serviceLevelTerms": "string",
      "quoteHash": "string",
      "integration": "string",
      "serviceCode": "string",
      "handlingFee": 42,
      "label": "string",
      "signatureRequired": true,
      "fallback": true,
      "freeShipping": true,
      "saleItems": [
        {
          "quantity": 42,
          "price": 42.0,
          "variant": {}
        }
      ],
      "errors": [
        {
          "type": "string",
          "status": 42.0,
          "title": "string"
        }
      ],
      "alternatives": [
        {
          "price": 42.0,
          "provider": "string",
          "providerCode": "string",
          "providerId": "string",
          "days": 42,
          "serviceLevel": "string",
          "serviceLevelToken": "string",
          "serviceLevelTerms": "string",
          "quoteHash": "string",
          "integration": "string",
          "serviceCode": "string",
          "handlingFee": 42,
          "label": "string",
          "signatureRequired": true,
          "fallback": true,
          "freeShipping": true
        }
      ]
    }
  ]
}

POST /channels/{id}/manual-sale.json

Path parameters

id Required / integer(int64)

Numeric ID of the instance

Minimum value is 1.

Body

adjustmentReasonId integer(int32)

Adjustment reason
adminNotes string

Admin notes
billingAddressLineOne string

Billing address line one
billingAddressLineTwo string

Billing address line two
billingAddressMessage string

Billing address message
billingCity string

Billing city
billingCountry string

Billing country
billingFirstName string

Billing first name
billingFullName

Billing full name