Jetti API documentation

GET /inventory-feeds/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Responses

• 200

Successful response
Hide response attributes Show response attributes object
- adminNotes string | null
  
  Admin notes
- allocateInventory boolean | null Required
  
  Allocate inventory
  
  Default value is false.
- allocationBuffer integer(int32) | null
  
  Allocation buffer
- authenticationSecret string | null
  
  Authentication secret
- authenticationToken string | null
  
  Authentication token
- automaticallyConnect boolean | null Required
  
  Automatically connect
  
  Default value is true.
- automaticallyConnectByBarcode boolean | null Required
  
  Automatically connect by barcode
  
  Default value is false.
- automaticallyConnectPrefix string | null Required
  
  Automatically connect prefix
  
  Values are both or prefixOnly. Default value is both.
- cacheImports boolean | null Required
  
  Cache imports
  
  Default value is false.
- caseInsensitiveSkus boolean | null Required
  
  Case insensitive skus
  
  Default value is false.
- connected integer(int32) | null Required
  
  Connected
  
  Default value is 0.
- createdAt string(date-time)
  
  Created at
- csvHasHeader boolean | null
  
  Csv has header
- currencyId integer(int32) | null
  
  Currency
- decimalNotation string | null Required
  
  Decimal notation
  
  Values are decimal or comma. Default value is decimal.
- delimiter string | null
  
  Delimiter
- dropshipProviderId integer(int32) Required
  
  Dropship provider
- enabled boolean | null Required
  
  Enabled
  
  Default value is true.
- excludeTags array[string] | null
  
  Enter the list of tags to check against when fetching items.
- externalIdStrategy string | null
  
  External id strategy
  
  Values are none or options.
- fetchCleanup string | null Required
  
  If a product is missing from the last time the feed was fetched, Jetti can automatically remove it from the feed. This will set the inventory to 0 in the store for that item.
  
  Values are enabled or disabled. Default value is enabled.
- fetchFrequency string | null Required
  
  Fetch frequency
  
  Values are never, hourly, or daily. Default value is hourly.
- fetchMetaFields boolean | null
  
  Fetch meta fields
- fetchProblem object | null | array | boolean | integer | number | string
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  
  Fetch problem
  
  Fetch problem
  
  Fetch problem
  
  Fetch problem
  
  Fetch problem
  
  Fetch problem
- fetched integer(int32) | null Required
  
  Fetched
  
  Default value is 0.
- googleSheetTab integer(int32) | null
  
  Google sheet tab
- handlePrefix string | null
  
  Handle prefix
- handleStrategy string | null Required
  
  Handle strategy
  
  Values are externalGroupId, externalGroupIdStart, or name. Default value is externalGroupId.
- id integer(int32)
  
  Id
- importSeconds integer(int32) | null Required
  
  Import seconds
  
  Default value is 0.
- importSecondsPartial integer(int32) | null Required
  
  Import seconds partial
  
  Default value is 0.
- importTags boolean | null Required
  
  Import tags
  
  Default value is true.
- individualProducts boolean | null Required
  
  Individual products
  
  Default value is false.
- intercomMessageId string | null
  
  Intercom message
- inventoryPolicy string | null Required
  
  Inventory policy
  
  Values are default, ignore, continue, or track. Default value is default.
- inventoryPolicySync boolean | null Required
  
  When enabled, the inventory policy from the vendor. For example, if the vendor changes the item from tracked to untracked, this will be reflected within your online store. We'd recommend keeping this enabled unless you are trying to cover a specific use case, such as selling the item into negative quantities if you have an agreement to oversell the item with the vendor.
  
  Default value is true.
- inventoryQuantityField string | null
  
  Inventory quantity field
- inventoryRestrictionLevel integer(int32) | null Required
  
  Inventory restriction level
  
  Default value is 0.
- inventorySync string | null Required
  
  Inventory sync
  
  Values are all, selected, or none. Default value is all.
- isBeta object | null | array | boolean | integer | number | string
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  
  Is beta
  
  Is beta
  
  Is beta
  
  Is beta
  
  Is beta
  
  Is beta
- isValid boolean | null Required
  
  Is valid
  
  Default value is true.
- jsonMapping string | null Required
  
  Json mapping
  
  Values are default or custom. Default value is default.
- jsonRoot string | null
  
  Json root
- jsonStructure string | null Required
  
  Select whether the feed has a nested or flat structure. A nested structure will have variants listed within a parent product object. Whereas a flat structure will list our all items individually.
  
  Values are nested or flat. Default value is nested.
- lastFetchedAt string(date-time) | null
  
  Last fetched at
- lastFetchedFile string | null
  
  Last fetched file
- locationIds array[string] | null
  
  Location ids
- magentoStoreId string | null
  
  Magento store
- manualFetchFequency string | null Required
  
  Manual fetch fequency
  
  Values are default, hourly, or daily. Default value is default.
- mapping string | null Required
  
  Mapping
  
  Values are inventory, inventory_pricing, shopify, custom, publishing, or channelEngine. Default value is inventory.
- mappingType string | null Required
  
  Mapping type
  
  Values are fetch or import. Default value is import.
- minimumInventoryQuantity integer(int32) | null
  
  Minimum inventory quantity
- muteError boolean | null Required
  
  Mute error
  
  Default value is false.
- name string Required
  
  Name
- overrideVendorName boolean | null Required
  
  Override vendor name
  
  Default value is true.
- overwriteTags boolean | null Required
  
  Overwrite tags
  
  Default value is false.
- parseWebhookEndpoint string | null
  
  Parse webhook endpoint
- prefixHandle boolean | null Required
  
  Prefix handle
  
  Default value is false.
- prefixName boolean | null Required
  
  Prefix name
  
  Default value is false.
- prefixSeperator string | null
  
  Prefix seperator
- prefixSku boolean | null Required
  
  Prefix sku
  
  Default value is false.
- prestaShopLegacy boolean | null Required
  
  Presta shop legacy
  
  Default value is false.
- priceChangeBase string | null Required
  
  Price change base
  
  Values are retail_price or cost_price. Default value is retail_price.
- priceField string | null
  
  Price field
- priceListId integer(int32) | null
  
  Price list
- processType string | null Required
  
  Process type
  
  Values are default or push. Default value is default.
- publishChangesAutomatically boolean | null Required
  
  Publish changes automatically
  
  Default value is false.
- publishProducts boolean | null Required
  
  Publish products
  
  Default value is false.
- purpose string | null Required
  
  Purpose
  
  Values are publishing or inventory. Default value is publishing.
- requireBarcode boolean | null Required
  
  Require barcode
  
  Default value is false.
- resourceLocation string | null
  
  Resource location
- resourcePath string | null
  
  Resource path
- resourceType string Required
  
  Resource type
  
  Values are api, bigCommerce, channelEngine, channelEngineCsv, etsy, ftpCsv, googleDrive, json, magento, magentoLegacy, manual, prestaShop, salesforce, selz, shopify_csv, shopify, squareSpace, tradeGecko, upload, webhook, wooCommerce, wooCommerceLegacy, wix, or xml.
- restrictInventoryImport boolean | null Required
  
  Restrict inventory import
  
  Default value is false.
- retailPriceChange number | null Required
  
  Retail price change
  
  Default value is 0.
- retailPriceChangeType string | null Required
  
  Retail price change type
  
  Values are percentage or fixed. Default value is percentage.
- reviewChanges boolean | null Required
  
  Review changes
  
  Default value is false.
- sendNotification boolean | null Required
  
  Send a notification email whenever new items are discovered in the feed. Currently, this will not specify new items, only alert you that items have been added.
  
  Default value is false.
- sendWebhook boolean | null Required
  
  Send webhook
  
  Default value is false.
- skipped integer(int32) | null Required
  
  Skipped
  
  Default value is 0.
- skuExempt boolean | null
  
  Sku exempt
- skuField string | null
  
  Sku field
- skuPrefix string | null
  
  Sku prefix
- stripTags boolean | null Required
  
  Strip tags
  
  Default value is false.
- strippedTags array[string] | null
  
  Jetti will automatically import tags from your vendors, alongside adding additional tags automatically. However, your search or product page may automatically show any new tags from products published through Jetti. This will lead to unwanted tags appearing to customers. You can specify any tags you do not wanted imported here.
- syncAllPriceLists boolean | null Required
  
  Sync all price lists
  
  Default value is true.
- syncCostPrices boolean | null Required
  
  Sync cost prices
  
  Default value is false.
- syncDescription boolean | null Required
  
  Sync description
  
  Default value is false.
- syncImages boolean | null Required
  
  Sync images
  
  Default value is false.
- syncName boolean | null Required
  
  Sync name
  
  Default value is false.
- syncOptions boolean | null Required
  
  Sync options
  
  Default value is false.
- syncPricing boolean | null Required
  
  Sync pricing
  
  Default value is false.
- syncProductType boolean | null Required
  
  Sync product type
  
  Default value is false.
- syncSalePrices boolean | null Required
  
  Sync sale prices
  
  Default value is true.
- syncTags boolean | null Required
  
  Sync tags
  
  Default value is false.
- syncWeight boolean | null Required
  
  Sync weight
  
  Default value is false.
- syncWeightZero boolean | null Required
  
  You may want to disable the syncing of weights if an item has no weight in the inventory feed. Otherwise, if you've manually adjusted the weight in Jetti or your store, it might reset the weight back to zero again the next time the feed is refetched
  
  Default value is false.
- tagRestriction string | null Required
  
  Values are deny or allow. Default value is deny.
- tags array[string] | null
  
  Tags
- taxableOverride string | null Required
  
  Change whether the item should use the taxable status of the item when importer. Or, whether you want to override this. This may be useful if you wanted to publish the items as non-taxable for example, when the dropship provider has them flagged as taxable.
  
  Values are default, taxable, or notTaxable. Default value is default.
- transformImageTemplate string | null
  
  Transform image template
- transformImages boolean | null
  
  Transform images
- transformTags string | null Required
  
  Transform tags
  
  Values are unchanged, uppercase, lowercase, humanize, or dasherize. Default value is unchanged.
- unpublishRemovedItems boolean | null Required
  
  Unpublish removed items
  
  Default value is false.
- unpublishedProducts boolean | null
  
  Unpublished products
- updatedAt string(date-time)
  
  Updated at
- uploadPricing boolean | null
  
  Upload pricing
- useParseWebhookEndpoint boolean | null
  
  Use parse webhook endpoint
- useProxy boolean | null
  
  Use proxy
- validationMessage array[string] | null
  
  Validation message
- vendorName string | null
  
  Vendor name
- vendorNameMetafields boolean | null
  
  Vendor name metafields
- webhookEndpoint string | null
  
  Webhook endpoint
- weightUnit string | null Required
  
  Weight unit
  
  Values are g, kg, oz, or lb. Default value is g.
- xmlMapping string | null Required
  
  Xml mapping
  
  Values are custom or google. Default value is google.
- xmlPath string | null
  
  Xml path
- zeroNullPrices boolean | null Required
  
  Zero null prices
  
  Default value is false.

GET /inventory-feeds/{id}.json

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

Response examples (200)

{
  "adminNotes": "string",
  "allocateInventory": false,
  "allocationBuffer": 42,
  "authenticationSecret": "string",
  "authenticationToken": "string",
  "automaticallyConnect": true,
  "automaticallyConnectByBarcode": false,
  "automaticallyConnectPrefix": "both",
  "cacheImports": false,
  "caseInsensitiveSkus": false,
  "connected": 0,
  "createdAt": "2023-05-04T09:42:00+00:00",
  "csvHasHeader": true,
  "currencyId": 42,
  "decimalNotation": "decimal",
  "delimiter": "string",
  "dropshipProviderId": 42,
  "enabled": true,
  "excludeTags": [
    "string"
  ],
  "externalIdStrategy": "none",
  "fetchCleanup": "enabled",
  "fetchFrequency": "hourly",
  "fetchMetaFields": true,
  "fetchProblem": {},
  "fetched": 0,
  "googleSheetTab": 42,
  "handlePrefix": "string",
  "handleStrategy": "externalGroupId",
  "id": 42,
  "importSeconds": 0,
  "importSecondsPartial": 0,
  "importTags": true,
  "individualProducts": false,
  "intercomMessageId": "string",
  "inventoryPolicy": "default",
  "inventoryPolicySync": true,
  "inventoryQuantityField": "string",
  "inventoryRestrictionLevel": 0,
  "inventorySync": "all",
  "isBeta": {},
  "isValid": true,
  "jsonMapping": "default",
  "jsonRoot": "string",
  "jsonStructure": "nested",
  "lastFetchedAt": "2023-05-04T09:42:00+00:00",
  "lastFetchedFile": "string",
  "locationIds": [
    "string"
  ],
  "magentoStoreId": "string",
  "manualFetchFequency": "default",
  "mapping": "inventory",
  "mappingType": "import",
  "minimumInventoryQuantity": 42,
  "muteError": false,
  "name": "string",
  "overrideVendorName": true,
  "overwriteTags": false,
  "parseWebhookEndpoint": "string",
  "prefixHandle": false,
  "prefixName": false,
  "prefixSeperator": "string",
  "prefixSku": false,
  "prestaShopLegacy": false,
  "priceChangeBase": "retail_price",
  "priceField": "string",
  "priceListId": 42,
  "processType": "default",
  "publishChangesAutomatically": false,
  "publishProducts": false,
  "purpose": "publishing",
  "requireBarcode": false,
  "resourceLocation": "string",
  "resourcePath": "string",
  "resourceType": "api",
  "restrictInventoryImport": false,
  "retailPriceChange": 0,
  "retailPriceChangeType": "percentage",
  "reviewChanges": false,
  "sendNotification": false,
  "sendWebhook": false,
  "skipped": 0,
  "skuExempt": true,
  "skuField": "string",
  "skuPrefix": "string",
  "stripTags": false,
  "strippedTags": [
    "string"
  ],
  "syncAllPriceLists": true,
  "syncCostPrices": false,
  "syncDescription": false,
  "syncImages": false,
  "syncName": false,
  "syncOptions": false,
  "syncPricing": false,
  "syncProductType": false,
  "syncSalePrices": true,
  "syncTags": false,
  "syncWeight": false,
  "syncWeightZero": false,
  "tagRestriction": "deny",
  "tags": [
    "string"
  ],
  "taxableOverride": "default",
  "transformImageTemplate": "string",
  "transformImages": true,
  "transformTags": "unchanged",
  "unpublishRemovedItems": false,
  "unpublishedProducts": true,
  "updatedAt": "2023-05-04T09:42:00+00:00",
  "uploadPricing": true,
  "useParseWebhookEndpoint": true,
  "useProxy": true,
  "validationMessage": [
    "string"
  ],
  "vendorName": "string",
  "vendorNameMetafields": true,
  "webhookEndpoint": "string",
  "weightUnit": "g",
  "xmlMapping": "google",
  "xmlPath": "string",
  "zeroNullPrices": false
}