Jetti API documentation

POST /shopify-stores.json

application/json

Body Required

accessToken string | null

Access token
apiKey string | null

Api key
authenticationType string | null Required

Authentication type

Values are public or private. Default value is public.
backorderMetafield boolean | null

Backorder metafield
carrierServiceId string | null

Carrier service
channelId integer(int32) Required

Channel
closed boolean | null Required

Closed

Default value is false.
connectedAt string(date-time) | null

Connected at
delayOrderImport boolean | null Required

Delay order import

Default value is false.
enabled boolean | null Required

Enabled

Default value is true.
externalFulfillmentServices array[string] | null Required

External fulfillment services

Default value is [] (empty).
fetchRecentProducts boolean | null

Fetch recent products
importDraftOrders boolean | null Required

Import draft orders from your store. These will need to be removed from Jetti once they are finalized and turned into full orders within Shopify.

Default value is false.
importingProducts boolean Required

Importing products

Default value is false.
importingSales boolean Required

Importing sales

Default value is false.
inventoryFeedLocation string | null

Inventory feed location
inventoryFeedLocationType string | null Required

Inventory feed location type

Values are default or selected. Default value is default.
inventoryFeedMetafield boolean | null

Inventory feed metafield
inventoryLocations string | null Required

Inventory locations

Values are default or multiple. Default value is default.
inventoryMigration boolean | null Required

Inventory migration

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

Last sales import
locationId string | null

Location
name string | null

Name
orderImportDelayMinutes integer(int32) | null Required

Order import delay minutes

Default value is 0.
orderMetafields boolean | null Required

Order metafields

Default value is false.
orderMetafieldsKey string | null

Order metafields key
orderMetafieldsValue string | null

Order metafields value
password string | null

Password
sendShipmentNotifications boolean Required

Send shipment notifications to your customers when items are marked as shipped in Jetti. This will use the template settings within your Shopify store.

Default value is true.
setupComplete boolean Required

Setup complete

Default value is false.
shop string Required

Shop
showDays boolean | null Required

Show days

Default value is true.
sso boolean | null Required

Sso

Default value is true.
throttle boolean | null Required

Throttle

Default value is true.

Responses

• 200

Successful response
Hide response attributes Show response attributes object
- accessToken string | null
  
  Access token
- apiKey string | null
  
  Api key
- authenticationType string | null Required
  
  Authentication type
  
  Values are public or private. Default value is public.
- backorderMetafield boolean | null
  
  Backorder metafield
- carrierServiceId string | null
  
  Carrier service
- channelId integer(int32) Required
  
  Channel
- closed boolean | null Required
  
  Closed
  
  Default value is false.
- connectedAt string(date-time) | null
  
  Connected at
- createdAt string(date-time)
  
  Created at
- delayOrderImport boolean | null Required
  
  Delay order import
  
  Default value is false.
- enabled boolean | null Required
  
  Enabled
  
  Default value is true.
- externalFulfillmentServices array[string] | null Required
  
  External fulfillment services
  
  Default value is [] (empty).
- fetchRecentProducts boolean | null
  
  Fetch recent products
- id integer(int32)
  
  Id
- importDraftOrders boolean | null Required
  
  Import draft orders from your store. These will need to be removed from Jetti once they are finalized and turned into full orders within Shopify.
  
  Default value is false.
- importingProducts boolean Required
  
  Importing products
  
  Default value is false.
- importingSales boolean Required
  
  Importing sales
  
  Default value is false.
- inventoryFeedLocation string | null
  
  Inventory feed location
- inventoryFeedLocationType string | null Required
  
  Inventory feed location type
  
  Values are default or selected. Default value is default.
- inventoryFeedMetafield boolean | null
  
  Inventory feed metafield
- inventoryLocations string | null Required
  
  Inventory locations
  
  Values are default or multiple. Default value is default.
- inventoryMigration boolean | null Required
  
  Inventory migration
  
  Default value is true.
- lastSalesImport string(date-time) | null Required
  
  Last sales import
- locationId string | null
  
  Location
- name string | null
  
  Name
- orderImportDelayMinutes integer(int32) | null Required
  
  Order import delay minutes
  
  Default value is 0.
- orderMetafields boolean | null Required
  
  Order metafields
  
  Default value is false.
- orderMetafieldsKey string | null
  
  Order metafields key
- orderMetafieldsValue string | null
  
  Order metafields value
- password string | null
  
  Password
- sendShipmentNotifications boolean Required
  
  Send shipment notifications to your customers when items are marked as shipped in Jetti. This will use the template settings within your Shopify store.
  
  Default value is true.
- setupComplete boolean Required
  
  Setup complete
  
  Default value is false.
- shop string Required
  
  Shop
- showDays boolean | null Required
  
  Show days
  
  Default value is true.
- sso boolean | null Required
  
  Sso
  
  Default value is true.
- throttle boolean | null Required
  
  Throttle
  
  Default value is true.
- updatedAt string(date-time)
  
  Updated at

POST /shopify-stores.json

curl \
 -X POST http://api.example.com/v1/shopify-stores.json \
 -H "Content-Type: application/json" \
 -d '{"accessToken":"string","apiKey":"string","authenticationType":"public","backorderMetafield":true,"carrierServiceId":"string","channelId":42,"closed":false,"connectedAt":"2023-05-04T09:42:00+00:00","delayOrderImport":false,"enabled":true,"externalFulfillmentServices":[],"fetchRecentProducts":true,"importDraftOrders":false,"importingProducts":false,"importingSales":false,"inventoryFeedLocation":"string","inventoryFeedLocationType":"default","inventoryFeedMetafield":true,"inventoryLocations":"default","inventoryMigration":true,"lastSalesImport":"2023-05-04T09:42:00+00:00","locationId":"string","name":"string","orderImportDelayMinutes":0,"orderMetafields":false,"orderMetafieldsKey":"string","orderMetafieldsValue":"string","password":"string","sendShipmentNotifications":true,"setupComplete":false,"shop":"string","showDays":true,"sso":true,"throttle":true}'

Request example

{
  "accessToken": "string",
  "apiKey": "string",
  "authenticationType": "public",
  "backorderMetafield": true,
  "carrierServiceId": "string",
  "channelId": 42,
  "closed": false,
  "connectedAt": "2023-05-04T09:42:00+00:00",
  "delayOrderImport": false,
  "enabled": true,
  "externalFulfillmentServices": [],
  "fetchRecentProducts": true,
  "importDraftOrders": false,
  "importingProducts": false,
  "importingSales": false,
  "inventoryFeedLocation": "string",
  "inventoryFeedLocationType": "default",
  "inventoryFeedMetafield": true,
  "inventoryLocations": "default",
  "inventoryMigration": true,
  "lastSalesImport": "2023-05-04T09:42:00+00:00",
  "locationId": "string",
  "name": "string",
  "orderImportDelayMinutes": 0,
  "orderMetafields": false,
  "orderMetafieldsKey": "string",
  "orderMetafieldsValue": "string",
  "password": "string",
  "sendShipmentNotifications": true,
  "setupComplete": false,
  "shop": "string",
  "showDays": true,
  "sso": true,
  "throttle": true
}

Response examples (200)

{
  "accessToken": "string",
  "apiKey": "string",
  "authenticationType": "public",
  "backorderMetafield": true,
  "carrierServiceId": "string",
  "channelId": 42,
  "closed": false,
  "connectedAt": "2023-05-04T09:42:00+00:00",
  "createdAt": "2023-05-04T09:42:00+00:00",
  "delayOrderImport": false,
  "enabled": true,
  "externalFulfillmentServices": [],
  "fetchRecentProducts": true,
  "id": 42,
  "importDraftOrders": false,
  "importingProducts": false,
  "importingSales": false,
  "inventoryFeedLocation": "string",
  "inventoryFeedLocationType": "default",
  "inventoryFeedMetafield": true,
  "inventoryLocations": "default",
  "inventoryMigration": true,
  "lastSalesImport": "2023-05-04T09:42:00+00:00",
  "locationId": "string",
  "name": "string",
  "orderImportDelayMinutes": 0,
  "orderMetafields": false,
  "orderMetafieldsKey": "string",
  "orderMetafieldsValue": "string",
  "password": "string",
  "sendShipmentNotifications": true,
  "setupComplete": false,
  "shop": "string",
  "showDays": true,
  "sso": true,
  "throttle": true,
  "updatedAt": "2023-05-04T09:42:00+00:00"
}