Jetti API Documentation
This is the documentation for version 1.0.0
of the API. Last update on Sep 8, 2021.
http://api.example.com/v1
Jetti API Documentation
This is the documentation for version 1.0.0
of the API. Last update on Sep 8, 2021.
http://api.example.com/v1
Dropship endpoint
Name
Replenishment endpoint
Sale endpoint
Successful response
Created at
Dropship endpoint
Id
Name
Replenishment endpoint
Sale endpoint
Updated at
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"}'
{
"dropshipEndpoint": "string",
"name": "string",
"replenishmentEndpoint": "string",
"saleEndpoint": "string"
}
{
"createdAt": "2022-05-04T09:42:00+00:00",
"dropshipEndpoint": "string",
"id": 42,
"name": "string",
"replenishmentEndpoint": "string",
"saleEndpoint": "string",
"updatedAt": "2022-05-04T09:42:00+00:00"
}
Numeric ID of the instance
Minimum value is 1
.
Successful response
Created at
Dropship endpoint
Id
Name
Replenishment endpoint
Sale endpoint
Updated at
curl \
-X GET http://api.example.com/v1/accounting-integrations/{id}.json
{
"createdAt": "2022-05-04T09:42:00+00:00",
"dropshipEndpoint": "string",
"id": 42,
"name": "string",
"replenishmentEndpoint": "string",
"saleEndpoint": "string",
"updatedAt": "2022-05-04T09:42:00+00:00"
}
Numeric ID of the instance
Minimum value is 1
.
Created at
Dropship endpoint
Id
Name
Replenishment endpoint
Sale endpoint
Updated at
curl \
-X PUT http://api.example.com/v1/accounting-integrations/{id}.json \
-H "Content-Type: application/json" \
-d '{"createdAt":"2022-05-04T09:42:00+00:00","dropshipEndpoint":"string","id":42,"name":"string","replenishmentEndpoint":"string","saleEndpoint":"string","updatedAt":"2022-05-04T09:42:00+00:00"}'
{
"createdAt": "2022-05-04T09:42:00+00:00",
"dropshipEndpoint": "string",
"id": 42,
"name": "string",
"replenishmentEndpoint": "string",
"saleEndpoint": "string",
"updatedAt": "2022-05-04T09:42:00+00:00"
}
Numeric ID of the instance
Minimum value is 1
.
curl \
-X DELETE http://api.example.com/v1/accounting-integrations/{id}.json
Accounting integration
Payload
Purchase invoice
Response
Sale invoice
Source
Values are quickbooks
, xero
, or custom
.
Status
Values are success
or error
.
Successful response
Accounting integration
Created at
Id
Payload
Purchase invoice
Response
Sale invoice
Source
Values are quickbooks
, xero
, or custom
.
Status
Values are success
or error
.
Updated at
curl \
-X POST http://api.example.com/v1/accounting-payloads.json \
-H "Content-Type: application/json" \
-d '{"accountingIntegrationId":42,"payload":{},"purchaseInvoiceId":42,"response":{},"saleInvoiceId":42,"source":"quickbooks","status":"success"}'
{
"accountingIntegrationId": 42,
"payload": {},
"purchaseInvoiceId": 42,
"response": {},
"saleInvoiceId": 42,
"source": "quickbooks",
"status": "success"
}
{
"accountingIntegrationId": 42,
"createdAt": "2022-05-04T09:42:00+00:00",
"id": 42,
"payload": {},
"purchaseInvoiceId": 42,
"response": {},
"saleInvoiceId": 42,
"source": "quickbooks",
"status": "success",
"updatedAt": "2022-05-04T09:42:00+00:00"
}
Numeric ID of the instance
Minimum value is 1
.
Successful response
Accounting integration
Created at
Id
Payload
Purchase invoice
Response
Sale invoice
Source
Values are quickbooks
, xero
, or custom
.
Status
Values are success
or error
.
Updated at
curl \
-X GET http://api.example.com/v1/accounting-payloads/{id}.json
{
"accountingIntegrationId": 42,
"createdAt": "2022-05-04T09:42:00+00:00",
"id": 42,
"payload": {},
"purchaseInvoiceId": 42,
"response": {},
"saleInvoiceId": 42,
"source": "quickbooks",
"status": "success",
"updatedAt": "2022-05-04T09:42:00+00:00"
}
Numeric ID of the instance
Minimum value is 1
.
Accounting integration
Created at
Id
Payload
Purchase invoice
Response
Sale invoice
Source
Values are quickbooks
, xero
, or custom
.
Status
Values are success
or error
.
Updated at
curl \
-X PUT http://api.example.com/v1/accounting-payloads/{id}.json \
-H "Content-Type: application/json" \
-d '{"accountingIntegrationId":42,"createdAt":"2022-05-04T09:42:00+00:00","id":42,"payload":{},"purchaseInvoiceId":42,"response":{},"saleInvoiceId":42,"source":"quickbooks","status":"success","updatedAt":"2022-05-04T09:42:00+00:00"}'
{
"accountingIntegrationId": 42,
"createdAt": "2022-05-04T09:42:00+00:00",
"id": 42,
"payload": {},
"purchaseInvoiceId": 42,
"response": {},
"saleInvoiceId": 42,
"source": "quickbooks",
"status": "success",
"updatedAt": "2022-05-04T09:42:00+00:00"
}
Numeric ID of the instance
Minimum value is 1
.
curl \
-X DELETE http://api.example.com/v1/accounting-payloads/{id}.json
Channel
Payload
Response
Sale
Source
Values are other
, custom
, or shippo
. Default value is other
.
Successful response
Channel
Created at
Id
Payload
Response
Sale
Source
Values are other
, custom
, or shippo
. Default value is other
.
Updated at
curl \
-X POST http://api.example.com/v1/address-validations.json \
-H "Content-Type: application/json" \
-d '{"channelId":42,"payload":{},"response":{},"saleId":42,"source":"other"}'
{
"channelId": 42,
"payload": {},
"response": {},
"saleId": 42,
"source": "other"
}
{
"channelId": 42,
"createdAt": "2022-05-04T09:42:00+00:00",
"id": 42,
"payload": {},
"response": {},
"saleId": 42,
"source": "other",
"updatedAt": "2022-05-04T09:42:00+00:00"
}
Numeric ID of the instance
Minimum value is 1
.
Successful response
Channel
Created at
Id
Payload
Response
Sale
Source
Values are other
, custom
, or shippo
. Default value is other
.
Updated at
curl \
-X GET http://api.example.com/v1/address-validations/{id}.json
{
"channelId": 42,
"createdAt": "2022-05-04T09:42:00+00:00",
"id": 42,
"payload": {},
"response": {},
"saleId": 42,
"source": "other",
"updatedAt": "2022-05-04T09:42:00+00:00"
}
Numeric ID of the instance
Minimum value is 1
.
Channel
Created at
Id
Payload
Response
Sale
Source
Values are other
, custom
, or shippo
. Default value is other
.
Updated at
curl \
-X PUT http://api.example.com/v1/address-validations/{id}.json \
-H "Content-Type: application/json" \
-d '{"channelId":42,"createdAt":"2022-05-04T09:42:00+00:00","id":42,"payload":{},"response":{},"saleId":42,"source":"other","updatedAt":"2022-05-04T09:42:00+00:00"}'
{
"channelId": 42,
"createdAt": "2022-05-04T09:42:00+00:00",
"id": 42,
"payload": {},
"response": {},
"saleId": 42,
"source": "other",
"updatedAt": "2022-05-04T09:42:00+00:00"
}
Numeric ID of the instance
Minimum value is 1
.
curl \
-X DELETE http://api.example.com/v1/address-validations/{id}.json
Adjustment reason
Automated import
Default value is false
.
Cost price
Default value is 0
.
Data import
Notes
Quantity
Stock take item
User
Variant
Warehouse
Xero
Successful response
Adjustment reason
Automated import
Default value is false
.
Cost price
Default value is 0
.
Created at
Data import
Id
Notes
Quantity
Stock take item
Updated at
User
Variant
Warehouse
Xero
curl \
-X POST http://api.example.com/v1/adjustments.json \
-H "Content-Type: application/json" \
-d '{"adjustmentReasonId":42,"automatedImport":false,"costPrice":0,"dataImportId":42,"notes":"string","quantity":42,"stockTakeItemId":42,"userId":42,"variantId":42,"warehouseId":42,"xeroId":"string"}'
{
"adjustmentReasonId": 42,
"automatedImport": false,
"costPrice": 0,
"dataImportId": 42,
"notes": "string",
"quantity": 42,
"stockTakeItemId": 42,
"userId": 42,
"variantId": 42,
"warehouseId": 42,
"xeroId": "string"
}
{
"adjustmentReasonId": 42,
"automatedImport": false,
"costPrice": 0,
"createdAt": "2022-05-04T09:42:00+00:00",
"dataImportId": 42,
"id": 42,
"notes": "string",
"quantity": 42,
"stockTakeItemId": 42,
"updatedAt": "2022-05-04T09:42:00+00:00",
"userId": 42,
"variantId": 42,
"warehouseId": 42,
"xeroId": "string"
}
Numeric ID of the instance
Minimum value is 1
.
Successful response
Adjustment reason
Automated import
Default value is false
.
Cost price
Default value is 0
.
Created at
Data import
Id
Notes
Quantity
Stock take item
Updated at
User
Variant
Warehouse
Xero
curl \
-X GET http://api.example.com/v1/adjustments/{id}.json
{
"adjustmentReasonId": 42,
"automatedImport": false,
"costPrice": 0,
"createdAt": "2022-05-04T09:42:00+00:00",
"dataImportId": 42,
"id": 42,
"notes": "string",
"quantity": 42,
"stockTakeItemId": 42,
"updatedAt": "2022-05-04T09:42:00+00:00",
"userId": 42,
"variantId": 42,
"warehouseId": 42,
"xeroId": "string"
}
Numeric ID of the instance
Minimum value is 1
.
Adjustment reason
Automated import
Default value is false
.
Cost price
Default value is 0
.
Created at
Data import
Id
Notes
Quantity
Stock take item
Updated at
User
Variant
Warehouse
Xero
curl \
-X PUT http://api.example.com/v1/adjustments/{id}.json \
-H "Content-Type: application/json" \
-d '{"adjustmentReasonId":42,"automatedImport":false,"costPrice":0,"createdAt":"2022-05-04T09:42:00+00:00","dataImportId":42,"id":42,"notes":"string","quantity":42,"stockTakeItemId":42,"updatedAt":"2022-05-04T09:42:00+00:00","userId":42,"variantId":42,"warehouseId":42,"xeroId":"string"}'
{
"adjustmentReasonId": 42,
"automatedImport": false,
"costPrice": 0,
"createdAt": "2022-05-04T09:42:00+00:00",
"dataImportId": 42,
"id": 42,
"notes": "string",
"quantity": 42,
"stockTakeItemId": 42,
"updatedAt": "2022-05-04T09:42:00+00:00",
"userId": 42,
"variantId": 42,
"warehouseId": 42,
"xeroId": "string"
}
Numeric ID of the instance
Minimum value is 1
.
curl \
-X DELETE http://api.example.com/v1/adjustments/{id}.json
Code
Name
Show in returns portal
Default value is true
.
curl \
-X POST http://api.example.com/v1/adjustment-reasons.json \
-H "Content-Type: application/json" \
-d '{"code":"string","name":"string","showInReturnsPortal":true}'
{
"code": "string",
"name": "string",
"showInReturnsPortal": true
}
{
"code": "string",
"createdAt": "2022-05-04T09:42:00+00:00",
"id": 42,
"name": "string",
"showInReturnsPortal": true,
"updatedAt": "2022-05-04T09:42:00+00:00"
}
Numeric ID of the instance
Minimum value is 1
.
curl \
-X GET http://api.example.com/v1/adjustment-reasons/{id}.json
{
"code": "string",
"createdAt": "2022-05-04T09:42:00+00:00",
"id": 42,
"name": "string",
"showInReturnsPortal": true,
"updatedAt": "2022-05-04T09:42:00+00:00"
}
Numeric ID of the instance
Minimum value is 1
.
curl \
-X PUT http://api.example.com/v1/adjustment-reasons/{id}.json \
-H "Content-Type: application/json" \
-d '{"code":"string","createdAt":"2022-05-04T09:42:00+00:00","id":42,"name":"string","showInReturnsPortal":true,"updatedAt":"2022-05-04T09:42:00+00:00"}'
{
"code": "string",
"createdAt": "2022-05-04T09:42:00+00:00",
"id": 42,
"name": "string",
"showInReturnsPortal": true,
"updatedAt": "2022-05-04T09:42:00+00:00"
}
Numeric ID of the instance
Minimum value is 1
.
curl \
-X DELETE http://api.example.com/v1/adjustment-reasons/{id}.json
Files
Files required
Default value is false
.
Instructions
Name
Status
Values are draft
, active
, or archived
. Default value is draft
.
Successful response
Created at
Files
Files required
Default value is false
.
Id
Instructions
Name
Status
Values are draft
, active
, or archived
. Default value is draft
.
Updated at
curl \
-X POST http://api.example.com/v1/agreements.json \
-H "Content-Type: application/json" \
-d '{"files":{},"filesRequired":false,"instructions":"string","name":"string","status":"draft"}'
{
"files": {},
"filesRequired": false,
"instructions": "string",
"name": "string",
"status": "draft"
}
{
"createdAt": "2022-05-04T09:42:00+00:00",
"files": {},
"filesRequired": false,
"id": 42,
"instructions": "string",
"name": "string",
"status": "draft",
"updatedAt": "2022-05-04T09:42:00+00:00"
}
Numeric ID of the instance
Minimum value is 1
.
Successful response
Created at
Files
Files required
Default value is false
.
Id
Instructions
Name
Status
Values are draft
, active
, or archived
. Default value is draft
.
Updated at
curl \
-X GET http://api.example.com/v1/agreements/{id}.json
{
"createdAt": "2022-05-04T09:42:00+00:00",
"files": {},
"filesRequired": false,
"id": 42,
"instructions": "string",
"name": "string",
"status": "draft",
"updatedAt": "2022-05-04T09:42:00+00:00"
}
Numeric ID of the instance
Minimum value is 1
.
Created at
Files
Files required
Default value is false
.
Id
Instructions
Name
Status
Values are draft
, active
, or archived
. Default value is draft
.
Updated at
curl \
-X PUT http://api.example.com/v1/agreements/{id}.json \
-H "Content-Type: application/json" \
-d '{"createdAt":"2022-05-04T09:42:00+00:00","files":{},"filesRequired":false,"id":42,"instructions":"string","name":"string","status":"draft","updatedAt":"2022-05-04T09:42:00+00:00"}'
{
"createdAt": "2022-05-04T09:42:00+00:00",
"files": {},
"filesRequired": false,
"id": 42,
"instructions": "string",
"name": "string",
"status": "draft",
"updatedAt": "2022-05-04T09:42:00+00:00"
}
Numeric ID of the instance
Minimum value is 1
.
curl \
-X DELETE http://api.example.com/v1/agreements/{id}.json
Successful response
Created at
Id
Resource
Values are all
, customers
, dropshipments
, dropshipProviders
, fulfillments
, goodsReceipts
, purchases
, resellers
, saleReturns
, or sales
. Default value is all
.
Tag
Updated at
curl \
-X POST http://api.example.com/v1/allowed-tags.json \
-H "Content-Type: application/json" \
-d '{"resource":"all","tag":"string"}'
{
"resource": "all",
"tag": "string"
}
{
"createdAt": "2022-05-04T09:42:00+00:00",
"id": 42,
"resource": "all",
"tag": "string",
"updatedAt": "2022-05-04T09:42:00+00:00"
}
Numeric ID of the instance
Minimum value is 1
.
Successful response
Created at
Id
Resource
Values are all
, customers
, dropshipments
, dropshipProviders
, fulfillments
, goodsReceipts
, purchases
, resellers
, saleReturns
, or sales
. Default value is all
.
Tag
Updated at
curl \
-X GET http://api.example.com/v1/allowed-tags/{id}.json
{
"createdAt": "2022-05-04T09:42:00+00:00",
"id": 42,
"resource": "all",
"tag": "string",
"updatedAt": "2022-05-04T09:42:00+00:00"
}
Numeric ID of the instance
Minimum value is 1
.
Created at
Id
Resource
Values are all
, customers
, dropshipments
, dropshipProviders
, fulfillments
, goodsReceipts
, purchases
, resellers
, saleReturns
, or sales
. Default value is all
.
Tag
Updated at
curl \
-X PUT http://api.example.com/v1/allowed-tags/{id}.json \
-H "Content-Type: application/json" \
-d '{"createdAt":"2022-05-04T09:42:00+00:00","id":42,"resource":"all","tag":"string","updatedAt":"2022-05-04T09:42:00+00:00"}'
{
"createdAt": "2022-05-04T09:42:00+00:00",
"id": 42,
"resource": "all",
"tag": "string",
"updatedAt": "2022-05-04T09:42:00+00:00"
}
Numeric ID of the instance
Minimum value is 1
.
curl \
-X DELETE http://api.example.com/v1/allowed-tags/{id}.json
Auth token
Channel
Marketplace
Name
Seller
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"}'
{
"authToken": "string",
"channelId": 42,
"marketplaceId": "string",
"name": "string",
"sellerId": "string"
}
{
"authToken": "string",
"channelId": 42,
"createdAt": "2022-05-04T09:42:00+00:00",
"id": 42,
"marketplaceId": "string",
"name": "string",
"sellerId": "string",
"updatedAt": "2022-05-04T09:42:00+00:00"
}
Numeric ID of the instance
Minimum value is 1
.
curl \
-X GET http://api.example.com/v1/amazon-accounts/{id}.json
{
"authToken": "string",
"channelId": 42,
"createdAt": "2022-05-04T09:42:00+00:00",
"id": 42,
"marketplaceId": "string",
"name": "string",
"sellerId": "string",
"updatedAt": "2022-05-04T09:42:00+00:00"
}
Numeric ID of the instance
Minimum value is 1
.
curl \
-X PUT http://api.example.com/v1/amazon-accounts/{id}.json \
-H "Content-Type: application/json" \
-d '{"authToken":"string","channelId":42,"createdAt":"2022-05-04T09:42:00+00:00","id":42,"marketplaceId":"string","name":"string","sellerId":"string","updatedAt":"2022-05-04T09:42:00+00:00"}'
{
"authToken": "string",
"channelId": 42,
"createdAt": "2022-05-04T09:42:00+00:00",
"id": 42,
"marketplaceId": "string",
"name": "string",
"sellerId": "string",
"updatedAt": "2022-05-04T09:42:00+00:00"
}
Numeric ID of the instance
Minimum value is 1
.
curl \
-X DELETE http://api.example.com/v1/amazon-accounts/{id}.json
Amazon account
Report