{"_id":"56fd2bf327b4321900186ee5","createdAt":"2015-10-26T13:09:09.153Z","githubsync":"","link_url":"","project":"562e25f2e01a430d00c2c91e","user":"562e25d24376430d006f1769","__v":9,"body":"This site provides documentation for integrating directly to Jet's merchant API.  If you have not yet been approved to sell on Jet, please refer to our [Partner Landing Page](partner.jet.com) to apply.  If you would like to sell on Jet but would not like to build a direct API integration, please consider one of our [integration partners](https://jetsupport.desk.com/customer/portal/articles/2540700-jet-api-integration-options?b_id=12876).\n\nTo help you get started:\n  * If you would like to learn how to be a successful partner on Jet, we recommend reviewing our [onboarding guide](https://www.dropbox.com/s/sfkqds8vwrpz4wa/Jet%20Onboarding%20Guide.pdf?dl=0).\n  * If you are new to APIs, we recommend looking at our [integration videos](https://jet-api-documentation.readme.io/v1.0/page/integration-videos).\n  * If you have watched the above videos and would like to learn more about Jet's unified product catalog please reference our [Product Listings Reference Guide](https://www.dropbox.com/s/ttebmi2a6216nrp/Jet%20Product%20Listing%20Do%E2%80%99s%20and%20Dont%E2%80%99s.pdf?dl=0a).\n  * All API updates will be published in our [API Release Schedule](https://jet-api-documentation.readme.io/v1.0/page/api-release-schedule).","parentDoc":null,"title":"Welcome to the Jet Developer Portal","type":"basic","api":{"auth":"required","params":[],"results":{"codes":[{"language":"json","status":200,"name":"","code":"{}"},{"status":400,"name":"","code":"{}","language":"json"}]},"settings":"","url":""},"excerpt":"","order":0,"slug":"getting-started","sync_unique":"","updates":["57685a1b138f8c1900a87551","57968089fa1ff60e006a126a","57dc20edb68b500e00d373dc","5856c483ac08070f00bc0003","59c34f2fc99a7d0010b48490","59c9a7b43741b30010508a0b"],"category":"56fd2bf327b4321900186ec7","hidden":false,"isReference":false,"link_external":false,"next":{"pages":[],"description":""},"version":"56fd2bf327b4321900186ec6","childrenPages":[]}

Welcome to the Jet Developer Portal


This site provides documentation for integrating directly to Jet's merchant API. If you have not yet been approved to sell on Jet, please refer to our [Partner Landing Page](partner.jet.com) to apply. If you would like to sell on Jet but would not like to build a direct API integration, please consider one of our [integration partners](https://jetsupport.desk.com/customer/portal/articles/2540700-jet-api-integration-options?b_id=12876). To help you get started: * If you would like to learn how to be a successful partner on Jet, we recommend reviewing our [onboarding guide](https://www.dropbox.com/s/sfkqds8vwrpz4wa/Jet%20Onboarding%20Guide.pdf?dl=0). * If you are new to APIs, we recommend looking at our [integration videos](https://jet-api-documentation.readme.io/v1.0/page/integration-videos). * If you have watched the above videos and would like to learn more about Jet's unified product catalog please reference our [Product Listings Reference Guide](https://www.dropbox.com/s/ttebmi2a6216nrp/Jet%20Product%20Listing%20Do%E2%80%99s%20and%20Dont%E2%80%99s.pdf?dl=0a). * All API updates will be published in our [API Release Schedule](https://jet-api-documentation.readme.io/v1.0/page/api-release-schedule).
View all 39 endpoints
This site provides documentation for integrating directly to Jet's merchant API. If you have not yet been approved to sell on Jet, please refer to our [Partner Landing Page](partner.jet.com) to apply. If you would like to sell on Jet but would not like to build a direct API integration, please consider one of our [integration partners](https://jetsupport.desk.com/customer/portal/articles/2540700-jet-api-integration-options?b_id=12876). To help you get started: * If you would like to learn how to be a successful partner on Jet, we recommend reviewing our [onboarding guide](https://www.dropbox.com/s/sfkqds8vwrpz4wa/Jet%20Onboarding%20Guide.pdf?dl=0). * If you are new to APIs, we recommend looking at our [integration videos](https://jet-api-documentation.readme.io/v1.0/page/integration-videos). * If you have watched the above videos and would like to learn more about Jet's unified product catalog please reference our [Product Listings Reference Guide](https://www.dropbox.com/s/ttebmi2a6216nrp/Jet%20Product%20Listing%20Do%E2%80%99s%20and%20Dont%E2%80%99s.pdf?dl=0a). * All API updates will be published in our [API Release Schedule](https://jet-api-documentation.readme.io/v1.0/page/api-release-schedule).
{"_id":"56fd2bf327b4321900186ee6","category":"56fd2bf327b4321900186ec7","link_url":"","isReference":false,"order":1,"slug":"jet-api-responses-and-errors","project":"562e25f2e01a430d00c2c91e","link_external":false,"type":"basic","createdAt":"2015-12-15T18:42:37.269Z","githubsync":"","sync_unique":"","hidden":false,"body":"## Summary\nThe below messages outline the types of responses you will receive from the API. We use [standard HTTP responses](http://www.w3schools.com/tags/ref_httpmessages.asp)\n\n**2xx**\n\nThe request was successfully received, understood, and accepted\n\n**3xx**\n\nFurther action needs to be taken by the user agent in order to fulfill the request\n\n**4xx**\n\nAn error in the request.\n\n**5xx**\n\nThe request looked good but something went wrong with Jet\n\n\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Jet API Response Codes\"\n}\n[/block]\nThe following table lists out all codes returned by the JET API:\n[block:parameters]\n{\n  \"data\": {\n    \"0-1\": \"success\",\n    \"0-0\": \"200\",\n    \"1-0\": \"201\",\n    \"2-0\": \"202\",\n    \"3-0\": \"204\",\n    \"4-0\": \"400\",\n    \"5-0\": \"401\",\n    \"6-0\": \"403\",\n    \"7-0\": \"404\",\n    \"8-0\": \"405\",\n    \"9-0\": \"500\",\n    \"10-0\": \"503\",\n    \"1-1\": \"created\",\n    \"2-1\": \"accepted\",\n    \"3-1\": \"no_content\",\n    \"4-1\": \"bad_request\",\n    \"5-1\": \"unauthorized\",\n    \"6-1\": \"forbidden\",\n    \"7-1\": \"not_found\",\n    \"8-1\": \"method_not_allowed\",\n    \"9-1\": \"internal_server_error\",\n    \"10-1\": \"unavailable\",\n    \"h-0\": \"Code\",\n    \"h-1\": \"Status\"\n  },\n  \"cols\": 2,\n  \"rows\": 11\n}\n[/block]","title":"Responses and Errors","__v":1,"parentDoc":null,"user":"562e25d24376430d006f1769","version":"56fd2bf327b4321900186ec6","updates":["5937055db128db001b4f15df"],"api":{"auth":"required","params":[],"url":"","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"status":400,"name":"","code":"{}","language":"json"}]},"settings":""},"excerpt":"","next":{"pages":[]},"childrenPages":[]}

Responses and Errors


## Summary The below messages outline the types of responses you will receive from the API. We use [standard HTTP responses](http://www.w3schools.com/tags/ref_httpmessages.asp) **2xx** The request was successfully received, understood, and accepted **3xx** Further action needs to be taken by the user agent in order to fulfill the request **4xx** An error in the request. **5xx** The request looked good but something went wrong with Jet [block:api-header] { "type": "basic", "title": "Jet API Response Codes" } [/block] The following table lists out all codes returned by the JET API: [block:parameters] { "data": { "0-1": "success", "0-0": "200", "1-0": "201", "2-0": "202", "3-0": "204", "4-0": "400", "5-0": "401", "6-0": "403", "7-0": "404", "8-0": "405", "9-0": "500", "10-0": "503", "1-1": "created", "2-1": "accepted", "3-1": "no_content", "4-1": "bad_request", "5-1": "unauthorized", "6-1": "forbidden", "7-1": "not_found", "8-1": "method_not_allowed", "9-1": "internal_server_error", "10-1": "unavailable", "h-0": "Code", "h-1": "Status" }, "cols": 2, "rows": 11 } [/block]
## Summary The below messages outline the types of responses you will receive from the API. We use [standard HTTP responses](http://www.w3schools.com/tags/ref_httpmessages.asp) **2xx** The request was successfully received, understood, and accepted **3xx** Further action needs to be taken by the user agent in order to fulfill the request **4xx** An error in the request. **5xx** The request looked good but something went wrong with Jet [block:api-header] { "type": "basic", "title": "Jet API Response Codes" } [/block] The following table lists out all codes returned by the JET API: [block:parameters] { "data": { "0-1": "success", "0-0": "200", "1-0": "201", "2-0": "202", "3-0": "204", "4-0": "400", "5-0": "401", "6-0": "403", "7-0": "404", "8-0": "405", "9-0": "500", "10-0": "503", "1-1": "created", "2-1": "accepted", "3-1": "no_content", "4-1": "bad_request", "5-1": "unauthorized", "6-1": "forbidden", "7-1": "not_found", "8-1": "method_not_allowed", "9-1": "internal_server_error", "10-1": "unavailable", "h-0": "Code", "h-1": "Status" }, "cols": 2, "rows": 11 } [/block]
{"_id":"56fd2bf327b4321900186efb","githubsync":"","hidden":false,"project":"562e25f2e01a430d00c2c91e","slug":"retrieving-a-token","__v":3,"order":0,"updates":["58644e9779c43b2d006a7e5c","58644eb4a0b2262f0090a419"],"createdAt":"2015-11-30T22:29:08.722Z","isReference":false,"next":{"description":"","pages":[]},"parentDoc":null,"type":"post","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request Body\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**user**\\n\\n*string*\",\n    \"1-0\": \"**pass**\\n\\n*string*\",\n    \"0-1\": \"The API user generated in the Jet.com merchant portal. The API user can be found by clicking 'Get API keys' in the API Integration section of the merchant portal.\",\n    \"1-1\": \"This field can be found by clicking 'Get API keys' in the Jet.com merchant portal. The value for this field is generated next to the word 'Secret'.\",\n    \"0-2\": \"\",\n    \"1-2\": \"\",\n    \"h-3\": \"\",\n    \"0-3\": \"\",\n    \"1-3\": \"\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\nBelow are the fields required for the request body\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**id_token** \\n\\n*string*\",\n    \"0-1\": \"The token to be used in subsequent headers\",\n    \"0-2\": \"\",\n    \"1-0\": \"**token_type** \\n\\n*string*\",\n    \"1-1\": \"The type of security token being returned\",\n    \"1-2\": \"\",\n    \"2-0\": \"**expires_on** \\n\\n*string*\",\n    \"2-1\": \"The date-time that the token expires. Tokens last for **10 hours** and **need not be re-requested until the Jet merchant API returns an HTTP status code of 401.** \",\n    \"2-2\": \"\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"API Keys\",\n  \"body\": \"Each account has two sets of API keys, one for our \\\"test\\\" (also referred to as sandbox) environment and another for our \\\"live\\\" environment\"\n}\n[/block]","link_url":"","excerpt":"","link_external":false,"sync_unique":"","title":"Retrieve Token","user":"562e25d24376430d006f1769","version":"56fd2bf327b4321900186ec6","api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6ImEzck1VZ01Gdjl0UGNsTGE2eUYzekFrZnF1RSJ9.eyJpcm9ubWFuX3BvcnRhbF91c2VyX2lkIjoiYmE2OTQ1NjRjNzM2NGRiY2FkNTFkMzEwZWY5NGJjOGMiLCJpc19zYW5kYm94X3VpZCI6IlRydWUiLCJtZXJjaGFudF9pZCI6IjZiYThmOWUzZjFhYjQ5MmQ4MWRhNzk1MGYyYTNjNGM5IiwicGFydG5lcl90eXBlIjoiTWVyY2hhbnQiLCJzY29wZSI6Imlyb25tYW4tYXBpIiwiaXNzIjoiamV0LmNvbSIsImV4cCI6MTQ1MDI0MTY5NSwibmJmIjoxNDUwMjA1Njk1fQ.Cx_L1n2smHOsPfbjoOBPz_k4NFg_QSAz6cxJi6Z_cm_i1yKE7uiciF3fHvv7Y5MIsGbqDSEMP2GDHrJDrMYgPlYZvf42AX90ZLUak_QG17WWpwTtia1kkRN8SBYTgUvG-biBepvxmLnf-hty-Hj20c7j1TZH8qFblbMSDm3ximVY9Xw2As5OfyEoZZcswPfO_VgLwks6sz-uTociFgvGwxpS_Nn6LPSaj6KUqCWgSnbs5cLc0ux23brvWW7S8ZgJuEPHECSFo_ivyHyh55oPlXrCtOFnN-S9ny7Azgl7szFAFCCTAq01moAQBE5yYee07NO1EAJNsOEjFiHDsqvzow\",\n  \"token_type\": \"Bearer\",\n  \"expires_on\": \"2015-12-16T04:54:55Z\"\n}"},{"code":"{\n  \"errors\": [\n    \"Bad Request\"\n  ]\n}","language":"json","status":400}]},"settings":"","url":"/token","auth":"never","examples":{"codes":[{"language":"json","code":"{\n  \"user\": \"5AF8F18CC1F635F34015EA871D3482351282CE37\",\n  \"pass\": \"TRMct3xCvJX3P+SIMH4/CyJH3M9giFPtvRqRr8uNgPJz\"\n}","name":"Token Request"}]},"method":"post","params":[]},"category":"56fd2bf327b4321900186ec8","childrenPages":[]}

postRetrieve Token


[block:api-header] { "type": "basic", "title": "Request Body" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**user**\n\n*string*", "1-0": "**pass**\n\n*string*", "0-1": "The API user generated in the Jet.com merchant portal. The API user can be found by clicking 'Get API keys' in the API Integration section of the merchant portal.", "1-1": "This field can be found by clicking 'Get API keys' in the Jet.com merchant portal. The value for this field is generated next to the word 'Secret'.", "0-2": "", "1-2": "", "h-3": "", "0-3": "", "1-3": "" }, "cols": 3, "rows": 2 } [/block] Below are the fields required for the request body [block:api-header] { "type": "basic", "title": "Response Body" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**id_token** \n\n*string*", "0-1": "The token to be used in subsequent headers", "0-2": "", "1-0": "**token_type** \n\n*string*", "1-1": "The type of security token being returned", "1-2": "", "2-0": "**expires_on** \n\n*string*", "2-1": "The date-time that the token expires. Tokens last for **10 hours** and **need not be re-requested until the Jet merchant API returns an HTTP status code of 401.** ", "2-2": "" }, "cols": 3, "rows": 3 } [/block] [block:callout] { "type": "danger", "title": "API Keys", "body": "Each account has two sets of API keys, one for our \"test\" (also referred to as sandbox) environment and another for our \"live\" environment" } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "basic", "title": "Request Body" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**user**\n\n*string*", "1-0": "**pass**\n\n*string*", "0-1": "The API user generated in the Jet.com merchant portal. The API user can be found by clicking 'Get API keys' in the API Integration section of the merchant portal.", "1-1": "This field can be found by clicking 'Get API keys' in the Jet.com merchant portal. The value for this field is generated next to the word 'Secret'.", "0-2": "", "1-2": "", "h-3": "", "0-3": "", "1-3": "" }, "cols": 3, "rows": 2 } [/block] Below are the fields required for the request body [block:api-header] { "type": "basic", "title": "Response Body" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**id_token** \n\n*string*", "0-1": "The token to be used in subsequent headers", "0-2": "", "1-0": "**token_type** \n\n*string*", "1-1": "The type of security token being returned", "1-2": "", "2-0": "**expires_on** \n\n*string*", "2-1": "The date-time that the token expires. Tokens last for **10 hours** and **need not be re-requested until the Jet merchant API returns an HTTP status code of 401.** ", "2-2": "" }, "cols": 3, "rows": 3 } [/block] [block:callout] { "type": "danger", "title": "API Keys", "body": "Each account has two sets of API keys, one for our \"test\" (also referred to as sandbox) environment and another for our \"live\" environment" } [/block]
{"_id":"56fd2bf327b4321900186efc","body":"The following headers are required when making any call through the merchant API unless otherwise specified. The {id_token} will be returned after completing the \"retrieve token\" step\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Header\",\n    \"h-1\": \"Value\",\n    \"0-0\": \"Content-Type\",\n    \"0-1\": \"application/json\",\n    \"1-0\": \"Authorization\",\n    \"1-1\": \"bearer {id_token}\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]","link_url":"","slug":"api-headers","title":"API Headers","updates":["57d949783916800e003ddec8","57f39b93ab0ee12000bef92a","57f39bebab0ee12000bef92c","57f39c78aa5c4f2b0084c909","57f39ddbaa5c4f2b0084c90b"],"version":"56fd2bf327b4321900186ec6","hidden":false,"isReference":false,"project":"562e25f2e01a430d00c2c91e","__v":5,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"link_external":false,"order":1,"parentDoc":null,"sync_unique":"","user":"562e25d24376430d006f1769","category":"56fd2bf327b4321900186ec8","createdAt":"2015-12-07T23:22:23.767Z","excerpt":"","githubsync":"","type":"basic","childrenPages":[]}

API Headers


The following headers are required when making any call through the merchant API unless otherwise specified. The {id_token} will be returned after completing the "retrieve token" step [block:parameters] { "data": { "h-0": "Header", "h-1": "Value", "0-0": "Content-Type", "0-1": "application/json", "1-0": "Authorization", "1-1": "bearer {id_token}" }, "cols": 2, "rows": 2 } [/block]
The following headers are required when making any call through the merchant API unless otherwise specified. The {id_token} will be returned after completing the "retrieve token" step [block:parameters] { "data": { "h-0": "Header", "h-1": "Value", "0-0": "Content-Type", "0-1": "application/json", "1-0": "Authorization", "1-1": "bearer {id_token}" }, "cols": 2, "rows": 2 } [/block]
{"_id":"56fd2bf327b4321900186ed5","api":{"url":"","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"status":400,"name":"","code":"{}","language":"json"}]},"settings":"","auth":"required","params":[]},"slug":"overview","sync_unique":"","version":"56fd2bf327b4321900186ec6","body":"The Products API is used to perform specific actions to a single product and is good for isolated changes.  For retailers with large catalogs, please use the Bulk JSON File Upload.","category":"56fd2bf327b4321900186ec9","link_url":"","project":"562e25f2e01a430d00c2c91e","title":"Products API v. File Upload","__v":1,"createdAt":"2016-01-22T15:22:01.411Z","order":0,"type":"basic","updates":["58bd8cf6816ab10f00d4601d"],"excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"parentDoc":null,"user":"562e25d24376430d006f1769","childrenPages":[]}

Products API v. File Upload


The Products API is used to perform specific actions to a single product and is good for isolated changes. For retailers with large catalogs, please use the Bulk JSON File Upload.
The Products API is used to perform specific actions to a single product and is good for isolated changes. For retailers with large catalogs, please use the Bulk JSON File Upload.
{"_id":"56fd2bf327b4321900186ed8","body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"If we receive multiple, contradictory updates for a given level (e.g. universal, fulfillment node) of a SKU's price, the last of the updates will be reflected for this level.\\n\\nContradictory updates across levels are permissible and expected.\",\n  \"title\": \"Contradictory Updates in the Same Message\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request Body\"\n}\n[/block]\nAt Jet, the price the retailer sets is not the same as the price the customer pays.  The price set for a SKU will be the price the retailer gets paid for selling the products.  However, the price that is set will influence how competitive your product offer matches up compared to other product offers for the same SKU.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"**price***\\n\\n*float*\",\n    \"0-1\": \"The overall price that the merchant SKU is priced at. Note that this is the item price, and generally will not contain in it the shipping charge.\",\n    \"0-3\": \"\",\n    \"1-0\": \"**fulfillment_nodes**\\n\\n*fulfillment_nodes object array*\",\n    \"1-1\": \"The price a retailer would like to set for this SKU sold at a fulfillment node\",\n    \"1-2\": \"\",\n    \"2-0\": \"fulfillment_node_id\",\n    \"3-0\": \"fulfillment_node_price\",\n    \"2-1\": \"string\",\n    \"3-1\": \"price\",\n    \"2-3\": \"The fulfillment node assigned in the Jet Merchant Portal for a merchant fulfillment node.\",\n    \"3-3\": \"The price of the merchant SKU at the fulfillment node level.\",\n    \"h-4\": \"Required\",\n    \"0-4\": \"yes\",\n    \"1-4\": \"\",\n    \"1-3\": \"\",\n    \"0-2\": \"A number >= 0.01\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\\* denotes the field is required\n\n**fulfillment_nodes object** - The following fields define a fulfillment_nodes object:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**fulfillment_node_id***\\n\\n*string*\",\n    \"1-0\": \"**fulfillment_node_price***\\n\\n*integer*\",\n    \"0-1\": \"The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.\",\n    \"1-1\": \"The price of the merchant SKU at the fulfillment node level.\",\n    \"0-3\": \"\",\n    \"1-3\": \"\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"\",\n    \"h-0\": \"Field\",\n    \"h-4\": \"Required\",\n    \"0-4\": \"Required as part of fulfillment_nodes array\",\n    \"1-4\": \"Required as part of fulfillment_nodes array\",\n    \"0-2\": \"Must be a valid fulfillment node ID set up by the merchant\",\n    \"1-2\": \"A number >= 0.01\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\\* denotes the field is required if a fulfillment_nodes object is provided\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use Cases\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Example request bodies\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"price\\\": 29.99\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Price\"\n    },\n    {\n      \"code\": \"{\\n  \\\"price\\\": 29.99,\\n  \\\"fulfillment_nodes\\\": [\\n    {\\n      \\\"fulfillment_node_id\\\": \\\"XISNDKSANDSFNCSJKFDNFKJHFJD\\\",\\n      \\\"fulfillment_node_price\\\": 29.99\\n    },\\n    {\\n      \\\"fulfillment_node_id\\\": \\\"AKSDKDJIJDISJFIDFJIDSIFFISI\\\",\\n      \\\"fulfillment_node_price\\\": 30.5\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Price by Fulfillment Node\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","editedParams":true,"link_external":false,"api":{"url":"/merchant-skus/{user_defined_sku_id}/price","auth":"required","examples":{"codes":[]},"method":"put","params":[{"_id":"5829e545a2bf061b0019c540","ref":"","in":"path","required":true,"desc":"The identifier you used to track and update your merchant SKU.","default":"","type":"string","name":"user_defined_sku_id"}],"results":{"codes":[{"status":204,"code":"","language":"json"},{"status":400,"language":"json","code":""}]},"settings":""},"link_url":"","title":"Price Upload","user":"562e25d24376430d006f1769","slug":"merchant-sku-price","sync_unique":"","type":"put","createdAt":"2015-10-26T20:46:25.136Z","editedParams2":true,"githubsync":"","next":{"description":"","pages":[]},"updates":[],"order":1,"parentDoc":null,"project":"562e25f2e01a430d00c2c91e","__v":1,"category":"56fd2bf327b4321900186ec9","excerpt":"","hidden":false,"isReference":false,"version":"56fd2bf327b4321900186ec6","childrenPages":[]}

putPrice Upload


Path Params

user_defined_sku_id:
required
string
The identifier you used to track and update your merchant SKU.
[block:callout] { "type": "warning", "body": "If we receive multiple, contradictory updates for a given level (e.g. universal, fulfillment node) of a SKU's price, the last of the updates will be reflected for this level.\n\nContradictory updates across levels are permissible and expected.", "title": "Contradictory Updates in the Same Message" } [/block] [block:api-header] { "type": "basic", "title": "Request Body" } [/block] At Jet, the price the retailer sets is not the same as the price the customer pays. The price set for a SKU will be the price the retailer gets paid for selling the products. However, the price that is set will influence how competitive your product offer matches up compared to other product offers for the same SKU. [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**price***\n\n*float*", "0-1": "The overall price that the merchant SKU is priced at. Note that this is the item price, and generally will not contain in it the shipping charge.", "0-3": "", "1-0": "**fulfillment_nodes**\n\n*fulfillment_nodes object array*", "1-1": "The price a retailer would like to set for this SKU sold at a fulfillment node", "1-2": "", "2-0": "fulfillment_node_id", "3-0": "fulfillment_node_price", "2-1": "string", "3-1": "price", "2-3": "The fulfillment node assigned in the Jet Merchant Portal for a merchant fulfillment node.", "3-3": "The price of the merchant SKU at the fulfillment node level.", "h-4": "Required", "0-4": "yes", "1-4": "", "1-3": "", "0-2": "A number >= 0.01" }, "cols": 3, "rows": 2 } [/block] \* denotes the field is required **fulfillment_nodes object** - The following fields define a fulfillment_nodes object: [block:parameters] { "data": { "0-0": "**fulfillment_node_id***\n\n*string*", "1-0": "**fulfillment_node_price***\n\n*integer*", "0-1": "The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.", "1-1": "The price of the merchant SKU at the fulfillment node level.", "0-3": "", "1-3": "", "h-1": "Description", "h-2": "Validation", "h-3": "", "h-0": "Field", "h-4": "Required", "0-4": "Required as part of fulfillment_nodes array", "1-4": "Required as part of fulfillment_nodes array", "0-2": "Must be a valid fulfillment node ID set up by the merchant", "1-2": "A number >= 0.01" }, "cols": 3, "rows": 2 } [/block] \* denotes the field is required if a fulfillment_nodes object is provided [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Example request bodies", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"price\": 29.99\n}", "language": "json", "name": "Price" }, { "code": "{\n \"price\": 29.99,\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"XISNDKSANDSFNCSJKFDNFKJHFJD\",\n \"fulfillment_node_price\": 29.99\n },\n {\n \"fulfillment_node_id\": \"AKSDKDJIJDISJFIDFJIDSIFFISI\",\n \"fulfillment_node_price\": 30.5\n }\n ]\n}", "language": "json", "name": "Price by Fulfillment Node" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


[block:callout] { "type": "warning", "body": "If we receive multiple, contradictory updates for a given level (e.g. universal, fulfillment node) of a SKU's price, the last of the updates will be reflected for this level.\n\nContradictory updates across levels are permissible and expected.", "title": "Contradictory Updates in the Same Message" } [/block] [block:api-header] { "type": "basic", "title": "Request Body" } [/block] At Jet, the price the retailer sets is not the same as the price the customer pays. The price set for a SKU will be the price the retailer gets paid for selling the products. However, the price that is set will influence how competitive your product offer matches up compared to other product offers for the same SKU. [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**price***\n\n*float*", "0-1": "The overall price that the merchant SKU is priced at. Note that this is the item price, and generally will not contain in it the shipping charge.", "0-3": "", "1-0": "**fulfillment_nodes**\n\n*fulfillment_nodes object array*", "1-1": "The price a retailer would like to set for this SKU sold at a fulfillment node", "1-2": "", "2-0": "fulfillment_node_id", "3-0": "fulfillment_node_price", "2-1": "string", "3-1": "price", "2-3": "The fulfillment node assigned in the Jet Merchant Portal for a merchant fulfillment node.", "3-3": "The price of the merchant SKU at the fulfillment node level.", "h-4": "Required", "0-4": "yes", "1-4": "", "1-3": "", "0-2": "A number >= 0.01" }, "cols": 3, "rows": 2 } [/block] \* denotes the field is required **fulfillment_nodes object** - The following fields define a fulfillment_nodes object: [block:parameters] { "data": { "0-0": "**fulfillment_node_id***\n\n*string*", "1-0": "**fulfillment_node_price***\n\n*integer*", "0-1": "The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.", "1-1": "The price of the merchant SKU at the fulfillment node level.", "0-3": "", "1-3": "", "h-1": "Description", "h-2": "Validation", "h-3": "", "h-0": "Field", "h-4": "Required", "0-4": "Required as part of fulfillment_nodes array", "1-4": "Required as part of fulfillment_nodes array", "0-2": "Must be a valid fulfillment node ID set up by the merchant", "1-2": "A number >= 0.01" }, "cols": 3, "rows": 2 } [/block] \* denotes the field is required if a fulfillment_nodes object is provided [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Example request bodies", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"price\": 29.99\n}", "language": "json", "name": "Price" }, { "code": "{\n \"price\": 29.99,\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"XISNDKSANDSFNCSJKFDNFKJHFJD\",\n \"fulfillment_node_price\": 29.99\n },\n {\n \"fulfillment_node_id\": \"AKSDKDJIJDISJFIDFJIDSIFFISI\",\n \"fulfillment_node_price\": 30.5\n }\n ]\n}", "language": "json", "name": "Price by Fulfillment Node" } ], "sidebar": true } [/block]
{"_id":"56fd2bf327b4321900186ed9","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Requests without All Configured Fulfillment Nodes\",\n  \"body\": \"The current behavior of the inventory PUT request is such that if a fulfillment node is not included in the request, **quantity at that node will be zeroed**. \\n\\nTo update inventory incrementally by fulfillment node, please use a PATCH request.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"If we receive multiple, contradictory inventory updates for a given fulfillment node, the last of the updates will be reflected.\",\n  \"title\": \"Contradictory Updates in the Same Message\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request Body\"\n}\n[/block]\nInventory must be uploaded in a call separate from a product upload. You will identify the SKU for which you are updating inventory by including the user_defined_sku_id in the endpoint URL. \n\nInventory must be set on a fulfillment center level so that our proprietary algorithm can determine which merchants should fulfill orders for which members based on location. \n\nThe below table indicates the required fields:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"**fulfillment_nodes** \\n\\n*fulfillment_nodes object array*\",\n    \"0-1\": \"An array of fulfillment nodes to set inventory\",\n    \"0-2\": \"\",\n    \"0-3\": \"\",\n    \"1-0\": \"fulfillment_node_id\",\n    \"1-1\": \"string\",\n    \"2-0\": \"quantity\",\n    \"2-1\": \"integer\",\n    \"2-3\": \"The quantity of inventory for the given SKU in a given fulfillment node.\",\n    \"1-3\": \"The fulfillment node assigned partner.jet.com for a merchant fulfillment node.\",\n    \"h-4\": \"Required\",\n    \"0-4\": \"\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n**fulfillment_nodes object** - The following fields are part of the fulfillment_nodes object\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**fulfillment_node_id***\\n\\n*string*\",\n    \"1-0\": \"**quantity***\\n\\n*integer*\",\n    \"0-1\": \"The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.\",\n    \"1-1\": \"The quantity of inventory for the given SKU in a given fulfillment node.\",\n    \"0-3\": \"\",\n    \"1-3\": \"\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"h-1\": \"Description\",\n    \"h-0\": \"Field\",\n    \"h-4\": \"Required\",\n    \"0-4\": \"\",\n    \"1-4\": \"\",\n    \"1-2\": \"An integer >= 0\",\n    \"0-2\": \"Must be a valid fulfillment node ID set up by the merchant\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use Cases\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"The following use cases are sample requests \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"fulfillment_nodes\\\": [\\n    {\\n      \\\"fulfillment_node_id\\\": \\\"XISNDKSANDSFNCSJKFDNFKJHFJD\\\",\\n      \\\"quantity\\\": 100\\n    },\\n    {\\n      \\\"fulfillment_node_id\\\": \\\"AKSDKDJIJDISJFIDFJIDSIFFISI\\\",\\n      \\\"quantity\\\": 20\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Upload Inventory\"\n    },\n    {\n      \"code\": \"{\\n  \\\"fulfillment_nodes\\\":[] \\n}\",\n      \"language\": \"json\",\n      \"name\": \"Clear Inventory: Empty array\"\n    },\n    {\n      \"code\": \"{\\n  \\\"fulfillment_nodes\\\": [\\n    {\\n      \\\"fulfillment_node_id\\\": \\\"XISNDKSANDSFNCSJKFDNFKJHFJD\\\",\\n      \\\"quantity\\\": 0\\n    },\\n    {\\n      \\\"fulfillment_node_id\\\": \\\"AKSDKDJIJDISJFIDFJIDSIFFISI\\\",\\n      \\\"quantity\\\": 0\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Clear Inventory: Explicit\"\n    },\n    {\n      \"code\": \"{}\",\n      \"language\": \"json\",\n      \"name\": \"Clear Inventory: Empty JSON object\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"56fd2bf327b4321900186ec9","createdAt":"2015-10-26T20:44:37.333Z","editedParams":true,"excerpt":"","next":{"description":"","pages":[]},"order":2,"user":"562e25d24376430d006f1769","link_external":false,"type":"put","__v":2,"api":{"url":"/merchant-skus/{user_defined_sku_id}/Inventory","auth":"required","examples":{"codes":[]},"method":"put","params":[{"type":"string","_id":"562e8e1419e7b40d00b7c723","default":"","desc":"The identifier you used to track and update your merchant SKU","in":"path","name":"user_defined_sku_id","ref":"","required":true}],"results":{"codes":[{"status":204,"code":"","language":"json"}]},"settings":""},"editedParams2":true,"hidden":false,"isReference":false,"link_url":"","project":"562e25f2e01a430d00c2c91e","slug":"merchant-sku-inventory","sync_unique":"","title":"Inventory Upload","githubsync":"","parentDoc":null,"updates":["583e67df4ced340f00b05a29"],"version":"56fd2bf327b4321900186ec6","childrenPages":[]}

putInventory Upload


Path Params

user_defined_sku_id:
required
string
The identifier you used to track and update your merchant SKU
[block:callout] { "type": "info", "title": "Requests without All Configured Fulfillment Nodes", "body": "The current behavior of the inventory PUT request is such that if a fulfillment node is not included in the request, **quantity at that node will be zeroed**. \n\nTo update inventory incrementally by fulfillment node, please use a PATCH request." } [/block] [block:callout] { "type": "warning", "body": "If we receive multiple, contradictory inventory updates for a given fulfillment node, the last of the updates will be reflected.", "title": "Contradictory Updates in the Same Message" } [/block] [block:api-header] { "type": "basic", "title": "Request Body" } [/block] Inventory must be uploaded in a call separate from a product upload. You will identify the SKU for which you are updating inventory by including the user_defined_sku_id in the endpoint URL. Inventory must be set on a fulfillment center level so that our proprietary algorithm can determine which merchants should fulfill orders for which members based on location. The below table indicates the required fields: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**fulfillment_nodes** \n\n*fulfillment_nodes object array*", "0-1": "An array of fulfillment nodes to set inventory", "0-2": "", "0-3": "", "1-0": "fulfillment_node_id", "1-1": "string", "2-0": "quantity", "2-1": "integer", "2-3": "The quantity of inventory for the given SKU in a given fulfillment node.", "1-3": "The fulfillment node assigned partner.jet.com for a merchant fulfillment node.", "h-4": "Required", "0-4": "" }, "cols": 3, "rows": 1 } [/block] **fulfillment_nodes object** - The following fields are part of the fulfillment_nodes object [block:parameters] { "data": { "0-0": "**fulfillment_node_id***\n\n*string*", "1-0": "**quantity***\n\n*integer*", "0-1": "The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.", "1-1": "The quantity of inventory for the given SKU in a given fulfillment node.", "0-3": "", "1-3": "", "h-2": "Validation", "h-3": "Description", "h-1": "Description", "h-0": "Field", "h-4": "Required", "0-4": "", "1-4": "", "1-2": "An integer >= 0", "0-2": "Must be a valid fulfillment node ID set up by the merchant" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "The following use cases are sample requests ", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"XISNDKSANDSFNCSJKFDNFKJHFJD\",\n \"quantity\": 100\n },\n {\n \"fulfillment_node_id\": \"AKSDKDJIJDISJFIDFJIDSIFFISI\",\n \"quantity\": 20\n }\n ]\n}", "language": "json", "name": "Upload Inventory" }, { "code": "{\n \"fulfillment_nodes\":[] \n}", "language": "json", "name": "Clear Inventory: Empty array" }, { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"XISNDKSANDSFNCSJKFDNFKJHFJD\",\n \"quantity\": 0\n },\n {\n \"fulfillment_node_id\": \"AKSDKDJIJDISJFIDFJIDSIFFISI\",\n \"quantity\": 0\n }\n ]\n}", "language": "json", "name": "Clear Inventory: Explicit" }, { "code": "{}", "language": "json", "name": "Clear Inventory: Empty JSON object" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


[block:callout] { "type": "info", "title": "Requests without All Configured Fulfillment Nodes", "body": "The current behavior of the inventory PUT request is such that if a fulfillment node is not included in the request, **quantity at that node will be zeroed**. \n\nTo update inventory incrementally by fulfillment node, please use a PATCH request." } [/block] [block:callout] { "type": "warning", "body": "If we receive multiple, contradictory inventory updates for a given fulfillment node, the last of the updates will be reflected.", "title": "Contradictory Updates in the Same Message" } [/block] [block:api-header] { "type": "basic", "title": "Request Body" } [/block] Inventory must be uploaded in a call separate from a product upload. You will identify the SKU for which you are updating inventory by including the user_defined_sku_id in the endpoint URL. Inventory must be set on a fulfillment center level so that our proprietary algorithm can determine which merchants should fulfill orders for which members based on location. The below table indicates the required fields: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**fulfillment_nodes** \n\n*fulfillment_nodes object array*", "0-1": "An array of fulfillment nodes to set inventory", "0-2": "", "0-3": "", "1-0": "fulfillment_node_id", "1-1": "string", "2-0": "quantity", "2-1": "integer", "2-3": "The quantity of inventory for the given SKU in a given fulfillment node.", "1-3": "The fulfillment node assigned partner.jet.com for a merchant fulfillment node.", "h-4": "Required", "0-4": "" }, "cols": 3, "rows": 1 } [/block] **fulfillment_nodes object** - The following fields are part of the fulfillment_nodes object [block:parameters] { "data": { "0-0": "**fulfillment_node_id***\n\n*string*", "1-0": "**quantity***\n\n*integer*", "0-1": "The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.", "1-1": "The quantity of inventory for the given SKU in a given fulfillment node.", "0-3": "", "1-3": "", "h-2": "Validation", "h-3": "Description", "h-1": "Description", "h-0": "Field", "h-4": "Required", "0-4": "", "1-4": "", "1-2": "An integer >= 0", "0-2": "Must be a valid fulfillment node ID set up by the merchant" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "The following use cases are sample requests ", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"XISNDKSANDSFNCSJKFDNFKJHFJD\",\n \"quantity\": 100\n },\n {\n \"fulfillment_node_id\": \"AKSDKDJIJDISJFIDFJIDSIFFISI\",\n \"quantity\": 20\n }\n ]\n}", "language": "json", "name": "Upload Inventory" }, { "code": "{\n \"fulfillment_nodes\":[] \n}", "language": "json", "name": "Clear Inventory: Empty array" }, { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"XISNDKSANDSFNCSJKFDNFKJHFJD\",\n \"quantity\": 0\n },\n {\n \"fulfillment_node_id\": \"AKSDKDJIJDISJFIDFJIDSIFFISI\",\n \"quantity\": 0\n }\n ]\n}", "language": "json", "name": "Clear Inventory: Explicit" }, { "code": "{}", "language": "json", "name": "Clear Inventory: Empty JSON object" } ], "sidebar": true } [/block]
{"_id":"56fd2bf327b4321900186eda","hidden":false,"slug":"merchant-sku-variation","version":"56fd2bf327b4321900186ec6","editedParams":true,"excerpt":"","link_external":false,"link_url":"","sync_unique":"","category":"56fd2bf327b4321900186ec9","createdAt":"2015-10-29T00:22:52.256Z","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request Body\"\n}\n[/block]\nThe variation request is used to create a variation-type relationship between several SKUs. To use this request, one must have already uploaded all the SKUs in question ; they should then choose one \"parent\" SKU and make the variation request to that SKU, adding as \"children\" any SKUs they want considered part of the relationship.\n\nTo denote the particular variation refinements, one must have uploaded one or more attributes in the product call for all the SKUs in question; finally, they are expected to list these attributes in the variation request. \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"**relationship*** \\n\\n*string*\",\n    \"0-1\": \"This field is required if you are setting up a Variation relationship between a set merchant SKUs.\\n\\nValid Values:\\n* 'Variation' - Products in a group vary by a few attributes\",\n    \"0-2\": \"Must be the following value:\\n* Variation\",\n    \"0-3\": \"\",\n    \"1-0\": \"**variation_refinements***\\n\\n*integer array*\",\n    \"2-0\": \"**children_skus***\\n\\n*string array*\",\n    \"1-3\": \"\",\n    \"2-3\": \"\",\n    \"1-1\": \"The attribute IDs associated with the characteristic the parent-children SKUs relate on.\",\n    \"1-2\": \"A Jet attribute or attributes that were uploaded for the products associated with the variation.  These attributes must exist on all products in the group\\n\\nEach integer must be > 0\",\n    \"2-1\": \"The merchant SKUs that are the child SKUs.\",\n    \"2-2\": \"Must be an uploaded merchant SKU\\n\\nAll SKUs in the group must have the same brand\",\n    \"h-4\": \"Required\",\n    \"0-4\": \"Yes\",\n    \"1-4\": \"Yes\",\n    \"2-4\": \"Yes\",\n    \"3-0\": \"**group_title** \\n\\n*string*\",\n    \"3-1\": \"The title for the variation group  to be shown as the title on the product detail page\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\\* denotes the field is required\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Grouping for Clothing Category\",\n  \"body\": \"Grouping for the clothing category is required.  Clothing products that are grouped have a higher chance of being listed.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Unique Attribute Values\",\n  \"body\": \"Attribute values for variation_refinements being grouped must be unique.  For example, if SKU A and SKU B vary on the color attribute (attribute 119) but have the same attribute value (red) one of the SKUs in the group will be excluded from the group.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use Cases\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Example request bodies\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"relationship\\\": \\\"Variation\\\",\\n  \\\"variation_refinements\\\": [12, 34],\\n  \\\"children_skus\\\": [\\n    \\\"abcd\\\",\\n    \\\"efgh\\\"\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Group with multiple attributes\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","editedParams2":true,"isReference":false,"next":{"description":"","pages":[]},"order":3,"project":"562e25f2e01a430d00c2c91e","api":{"method":"put","params":[{"desc":"The identifier you used to track and update your merchant SKU","default":"","type":"string","name":"user_defined_sku_id","_id":"5829e5816a1d1f0f00b94514","ref":"","in":"path","required":true}],"results":{"codes":[{"language":"json","code":"","status":204},{"code":"","language":"json","status":400}]},"settings":"","url":"/merchant-skus/{user_defined_sku_id}/variation","auth":"required","examples":{"codes":[]}},"user":"562e25d24376430d006f1769","type":"put","updates":[],"parentDoc":null,"title":"Variation Upload","__v":1,"githubsync":"","childrenPages":[]}

putVariation Upload


Path Params

user_defined_sku_id:
required
string
The identifier you used to track and update your merchant SKU
[block:api-header] { "type": "basic", "title": "Request Body" } [/block] The variation request is used to create a variation-type relationship between several SKUs. To use this request, one must have already uploaded all the SKUs in question ; they should then choose one "parent" SKU and make the variation request to that SKU, adding as "children" any SKUs they want considered part of the relationship. To denote the particular variation refinements, one must have uploaded one or more attributes in the product call for all the SKUs in question; finally, they are expected to list these attributes in the variation request. [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**relationship*** \n\n*string*", "0-1": "This field is required if you are setting up a Variation relationship between a set merchant SKUs.\n\nValid Values:\n* 'Variation' - Products in a group vary by a few attributes", "0-2": "Must be the following value:\n* Variation", "0-3": "", "1-0": "**variation_refinements***\n\n*integer array*", "2-0": "**children_skus***\n\n*string array*", "1-3": "", "2-3": "", "1-1": "The attribute IDs associated with the characteristic the parent-children SKUs relate on.", "1-2": "A Jet attribute or attributes that were uploaded for the products associated with the variation. These attributes must exist on all products in the group\n\nEach integer must be > 0", "2-1": "The merchant SKUs that are the child SKUs.", "2-2": "Must be an uploaded merchant SKU\n\nAll SKUs in the group must have the same brand", "h-4": "Required", "0-4": "Yes", "1-4": "Yes", "2-4": "Yes", "3-0": "**group_title** \n\n*string*", "3-1": "The title for the variation group to be shown as the title on the product detail page" }, "cols": 3, "rows": 4 } [/block] \* denotes the field is required [block:callout] { "type": "warning", "title": "Grouping for Clothing Category", "body": "Grouping for the clothing category is required. Clothing products that are grouped have a higher chance of being listed." } [/block] [block:callout] { "type": "warning", "title": "Unique Attribute Values", "body": "Attribute values for variation_refinements being grouped must be unique. For example, if SKU A and SKU B vary on the color attribute (attribute 119) but have the same attribute value (red) one of the SKUs in the group will be excluded from the group." } [/block] [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Example request bodies", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"relationship\": \"Variation\",\n \"variation_refinements\": [12, 34],\n \"children_skus\": [\n \"abcd\",\n \"efgh\"\n ]\n}", "language": "json", "name": "Group with multiple attributes" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


[block:api-header] { "type": "basic", "title": "Request Body" } [/block] The variation request is used to create a variation-type relationship between several SKUs. To use this request, one must have already uploaded all the SKUs in question ; they should then choose one "parent" SKU and make the variation request to that SKU, adding as "children" any SKUs they want considered part of the relationship. To denote the particular variation refinements, one must have uploaded one or more attributes in the product call for all the SKUs in question; finally, they are expected to list these attributes in the variation request. [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**relationship*** \n\n*string*", "0-1": "This field is required if you are setting up a Variation relationship between a set merchant SKUs.\n\nValid Values:\n* 'Variation' - Products in a group vary by a few attributes", "0-2": "Must be the following value:\n* Variation", "0-3": "", "1-0": "**variation_refinements***\n\n*integer array*", "2-0": "**children_skus***\n\n*string array*", "1-3": "", "2-3": "", "1-1": "The attribute IDs associated with the characteristic the parent-children SKUs relate on.", "1-2": "A Jet attribute or attributes that were uploaded for the products associated with the variation. These attributes must exist on all products in the group\n\nEach integer must be > 0", "2-1": "The merchant SKUs that are the child SKUs.", "2-2": "Must be an uploaded merchant SKU\n\nAll SKUs in the group must have the same brand", "h-4": "Required", "0-4": "Yes", "1-4": "Yes", "2-4": "Yes", "3-0": "**group_title** \n\n*string*", "3-1": "The title for the variation group to be shown as the title on the product detail page" }, "cols": 3, "rows": 4 } [/block] \* denotes the field is required [block:callout] { "type": "warning", "title": "Grouping for Clothing Category", "body": "Grouping for the clothing category is required. Clothing products that are grouped have a higher chance of being listed." } [/block] [block:callout] { "type": "warning", "title": "Unique Attribute Values", "body": "Attribute values for variation_refinements being grouped must be unique. For example, if SKU A and SKU B vary on the color attribute (attribute 119) but have the same attribute value (red) one of the SKUs in the group will be excluded from the group." } [/block] [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Example request bodies", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"relationship\": \"Variation\",\n \"variation_refinements\": [12, 34],\n \"children_skus\": [\n \"abcd\",\n \"efgh\"\n ]\n}", "language": "json", "name": "Group with multiple attributes" } ], "sidebar": true } [/block]
{"_id":"56fd2bf327b4321900186edb","link_external":false,"project":"562e25f2e01a430d00c2c91e","sync_unique":"","body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Designating Items 'Freight'\",\n  \"body\": \"For any product that always ships freight, please set up a shipping exception.  A freight designation will signal to the customer that the product may take 5-10 business days.  Please refer to the 'freight' example for more information.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Items with longer lead times\",\n  \"body\": \"The following service_level values will display different fulfillment expectations to customers at checkout:\\n* Scheduled (freight) -- will display freight delivery with 5 to 10 day delivery expectation\\n* Scheduled (freight 11 to 20 day) -- will display freight delivery with 11 to 20 day delivery expectation\\n* Scheduled (freight 21 to 30 day) -- will display freight delivery with 21 to 30 day delivery expectation\\n* 5 to 10 Day -- will display ground delivery with 5 to 10 Day delivery expectation\\n* 11 to 20 Day -- will display ground delivery with 11 to 20 Day delivery expectation\\n* 21 to 30 Day -- will display ground delivery with 21 to 30 Day delivery expectation\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request Body\"\n}\n[/block]\nThe shipping exceptions call is used to set up specific methods and costs for individual SKUs that will override your default settings, with the ability to drill down to the fulfillment node level.\n\nNote: Beginning May 29, 2017, tor the sake of clarity and efficiency, shipping exceptions must adhere to the following rules:\n\n- Restricted exceptions must be associated with methods that are enabled by the merchant at the fulfillment node\n- A merchant cannot restrict all methods at a fulfillment node\n- If an Exclusive exception is specified at a node, then an Include exception cannot be listed at that same fulfillment node\n- If an Exclusive exception is specified at a node, then a Restricted exception cannot be listed at that same fulfillment node\n\nThe fields for shipping exceptions are outlined below:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"**fulfillment_nodes** \\n\\n*fulfillment_nodes object array*\",\n    \"0-1\": \"This is an array of fulfillment nodes. Please see our fulfillment nodes array table below.\",\n    \"0-3\": \"\",\n    \"h-4\": \"Required\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n**fulfillment_nodes array** - The fields below are part of a fulfillment_nodes object\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"h-4\": \"Required\",\n    \"0-0\": \"**fulfillment_node_id**\\n\\n*string*\",\n    \"0-1\": \"The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.\",\n    \"0-3\": \"\",\n    \"0-4\": \"\",\n    \"1-4\": \"\",\n    \"1-3\": \"\",\n    \"1-1\": \"This array contains all fields below. There can be multiple shipping exception arrays in a fulfillment node array.\",\n    \"1-0\": \"**shipping_exceptions**\\n\\n*shipping_exceptions object array*\",\n    \"0-2\": \"Must be a valid fulfillment node ID set up by the merchant\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n**shipping_exceptions object** - The fields below are part of the shipping_exceptions object\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"\",\n    \"0-0\": \"**service_level** \\n\\n*string*\",\n    \"0-1\": \"This field should be used if you are defining your shipping options by service_level.  This is not carrier specific\",\n    \"0-2\": \"Either service_level or shipping_method must be provided\\n\\nMust be one of the following values:\\n* Second Day\\n* Next Day\\n* Priority\\n* Expedited\\n* Standard\\n* Scheduled (freight)\\n* 5 to 10 Day\\n* 11 to 20 Day\\n* 21 to 30 Day\\n* Scheduled (freight 11 to 20 day)\\n* Scheduled (freight 21 to 30 day)\",\n    \"0-3\": \"\",\n    \"1-0\": \"**shipping_method** \\n\\n*string*\",\n    \"1-1\": \"A specific shipping method e.g. UPS Ground, UPS Next Day Air, FedEx Home, Freight.\",\n    \"1-2\": \"Either service_level or shipping_method must be provided\\n\\nMust be one of the following values:\\n\\n  * DHL Global Mail\\n  * FedEx 2 Day\\n  * FedEx Express Saver\\n  * FedEx First Overnight\\n  * FedEx Ground\\n  * FedEx Home Delivery\\n  * FedEx Priority Overnight\\n  * FedEx Smart Post\\n  * FedEx Standard Overnight\\n  * Freight\\n  * Ontrac Ground\\n  * UPS 2nd Day Air AM\\n  * UPS 2nd Day Air\\n  * UPS 3 Day Select\\n  * UPS Ground\\n  * UPS Mail Innovations\\n  * UPS Next Day Air Saver\\n  * UPS Next Day Air\\n  * UPS SurePost\\n  * USPS First Class Mail\\n  * USPS Media Mail\\n  * USPS Priority Mail Express\\n  * USPS Priority Mail\\n  * USPS Standard Post\",\n    \"1-3\": \"\",\n    \"2-0\": \"**override_type** \\n\\n*string*\",\n    \"2-1\": \"Override charge - A charge that overrides the default shipping charge.\\n\\nAdditional charge - A charge that is added to the default shipping charge.\",\n    \"2-2\": \"Must be one of the following values:\\n* Override charge\\n* Additional charge\\n\\nIf shipping_exception_type is \\\"restricted\\\", override_type and shipping_charge_amount should not be provided\\n\\nIf the override_type is \\\"Additional charge\\\" the shipping method or service level provided must exist on the fulfillment node\",\n    \"2-3\": \"\",\n    \"3-0\": \"**shipping_charge_amount**\\n\\n*float*\",\n    \"3-1\": \"The amount added to your default shipping charge when override_type = \\\"Additional charge\\\" \\n\\nThe total amount charged when override_type = \\\"Override charge\\\"\",\n    \"3-3\": \"\",\n    \"4-0\": \"**shipping_exception_type*** \\n\\n*string*\",\n    \"4-1\": \"Indicates if you want the product to be shipped exclusively (only with) or restrictively (not including) via the shipping level of shipping method provided\\n\\nValid Values\\n* restricted - The product cannot be shipped using the shipping method or shipping level provided.  \\n\\nThere can be many restricted shipping methods per fulfillment node.\\n\\n* exclusive - The product should only be shipped using the shipping method or shipping level provided.  \\n\\nThere can only be one exclusive shipping method per fulfillment node.\\n\\n* include - The product will be priced normally under the Jet.com pricing algorithm.  \\n\\nIf the shipping method                    determined for the order has an exception on it, the appropriate override_type will be applied\",\n    \"4-2\": \"Must be one of the following values:\\n* exclusive \\n* restricted\\n* include\",\n    \"4-3\": \"\",\n    \"h-4\": \"\",\n    \"3-2\": \"A number >= 0\\n\\nRequired if override_type is provided\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n\\* denotes that field is required\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use Cases\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Example request bodies below\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"fulfillment_nodes\\\": [\\n    {\\n      \\\"fulfillment_node_id\\\": \\\"XISNDKSANDSFNCSJKFDNFKJHFJD\\\",\\n      \\\"shipping_exceptions\\\": [\\n        {\\n          \\\"service_level\\\": \\\"Standard\\\",\\n          \\\"shipping_exception_type\\\": \\\"restricted\\\"\\n        },\\n        {\\n          \\\"service_level\\\": \\\"NextDay\\\",\\n          \\\"shipping_exception_type\\\": \\\"restricted\\\"\\n        }\\n      ]\\n    },\\n    {\\n      \\\"fulfillment_node_id\\\": \\\"1234DKSANDSFNCSJKFDNFKJHFAZ\\\",\\n      \\\"shipping_exceptions\\\": [\\n        {\\n          \\\"service_level\\\": \\\"Standard\\\",\\n          \\\"override_type\\\": \\\"Additional charge\\\",\\n          \\\"shipping_charge_amount\\\": 3.25,\\n          \\\"shipping_exception_type\\\": \\\"exclusive\\\"\\n        }\\n      ]\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Mixed Example\"\n    },\n    {\n      \"code\": \"{\\n  \\\"fulfillment_nodes\\\": [\\n    {\\n      \\\"fulfillment_node_id\\\": \\\"1234DKSANDSFNCSJKFDNFKJHFAZ\\\",\\n      \\\"shipping_exceptions\\\": [\\n        {\\n          \\\"shipping_method\\\": \\\"Freight\\\",\\n          \\\"override_type\\\": \\\"Additional charge\\\",\\n          \\\"shipping_charge_amount\\\": 3.25,\\n          \\\"shipping_exception_type\\\": \\\"exclusive\\\"\\n        }\\n      ]\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Exclusive\"\n    },\n    {\n      \"code\": \"{\\n  \\\"fulfillment_nodes\\\": [\\n    {\\n      \\\"fulfillment_node_id\\\": \\\"XISNDKSANDSFNCSJKFDNFKJHFJD\\\",\\n      \\\"shipping_exceptions\\\": [\\n        {\\n          \\\"service_level\\\": \\\"Standard\\\",\\n          \\\"shipping_exception_type\\\": \\\"restricted\\\"\\n        },\\n        {\\n          \\\"shipping_method\\\": \\\"UPS Ground\\\",\\n          \\\"shipping_exception_type\\\": \\\"restricted\\\"\\n        }\\n      ]\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Multiple Restricted\"\n    },\n    {\n      \"code\": \"{}\",\n      \"language\": \"json\",\n      \"name\": \"Empty JSON object clear\"\n    },\n    {\n      \"code\": \"{\\n\\t\\\"fulfillment_nodes\\\":[]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Empty fulfillment_nodes array clear\"\n    },\n    {\n      \"code\": \"{\\n  \\\"fulfillment_nodes\\\": [\\n    {\\n      \\\"fulfillment_node_id\\\": \\\"1234DKSANDSFNCSJKFDNFKJHFAZ\\\",\\n      \\\"shipping_exceptions\\\": [\\n        {\\n          \\\"shipping_method\\\": \\\"FedEx Home Delivery\\\", //if FedEx Home Delivery is chosen as the shipping method for the order, we'll add an additional $1\\n          \\\"override_type\\\": \\\"Additional charge\\\",\\n          \\\"shipping_charge_amount\\\": 1,\\n          \\\"shipping_exception_type\\\": \\\"include\\\"\\n        },\\n        {\\n          \\\"shipping_method\\\": \\\"UPS Next Day Air\\\", \\n          \\\"override_type\\\": \\\"Override charge\\\",\\n          \\\"shipping_charge_amount\\\": 100,\\n          \\\"shipping_exception_type\\\": \\\"include\\\"\\n        }\\n      ]\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Include Exception Type\"\n    },\n    {\n      \"code\": \"{\\n  \\\"fulfillment_nodes\\\": [\\n    {\\n      \\\"fulfillment_node_id\\\": \\\"1234DKSANDSFNCSJKFDNFKJHFAZ\\\",\\n      \\\"shipping_exceptions\\\": [\\n        {\\n          \\\"shipping_method\\\": \\\"Freight\\\",\\n          \\\"override_type\\\": \\\"Override charge\\\",\\n          \\\"shipping_charge_amount\\\": 100,\\n          \\\"shipping_exception_type\\\": \\\"exclusive\\\"\\n        }\\n      ]\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Freight Example\"\n    },\n    {\n      \"code\": \"{\\n  \\\"fulfillment_nodes\\\": [\\n    {\\n      \\\"fulfillment_node_id\\\": \\\"1234DKSANDSFNCSJKFDNFKJHFAZ\\\",\\n      \\\"shipping_exceptions\\\": [\\n        {\\n          \\\"service_level\\\": \\\"5 to 10 Day\\\",\\n          \\\"override_type\\\": \\\"Override charge\\\",\\n          \\\"shipping_charge_amount\\\": 1,\\n          \\\"shipping_exception_type\\\": \\\"exclusive\\\"\\n        }\\n      ]\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"5 to 10 Day\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","editedParams2":true,"isReference":false,"editedParams":true,"githubsync":"","title":"Shipping Exception Upload","__v":2,"api":{"settings":"","url":"/merchant-skus/{user_defined_sku_id}/shippingexception","auth":"required","examples":{"codes":[]},"method":"put","params":[{"_id":"562e8e1419e7b40d00b7c723","ref":"","in":"path","required":true,"desc":"The identifier you used to track and update your merchant SKU.","default":"","type":"string","name":"user_defined_sku_id"}],"results":{"codes":[{"language":"json","status":204,"code":""}]}},"category":"56fd2bf327b4321900186ec9","updates":[],"user":"562e25d24376430d006f1769","next":{"description":"","pages":[]},"order":4,"link_url":"","parentDoc":null,"slug":"merchant-sku-shipping-exception","type":"put","version":"56fd2bf327b4321900186ec6","createdAt":"2015-10-26T20:48:42.748Z","excerpt":"","hidden":false,"childrenPages":[]}

putShipping Exception Upload


Path Params

user_defined_sku_id:
required
string
The identifier you used to track and update your merchant SKU.
[block:callout] { "type": "warning", "title": "Designating Items 'Freight'", "body": "For any product that always ships freight, please set up a shipping exception. A freight designation will signal to the customer that the product may take 5-10 business days. Please refer to the 'freight' example for more information." } [/block] [block:callout] { "type": "warning", "title": "Items with longer lead times", "body": "The following service_level values will display different fulfillment expectations to customers at checkout:\n* Scheduled (freight) -- will display freight delivery with 5 to 10 day delivery expectation\n* Scheduled (freight 11 to 20 day) -- will display freight delivery with 11 to 20 day delivery expectation\n* Scheduled (freight 21 to 30 day) -- will display freight delivery with 21 to 30 day delivery expectation\n* 5 to 10 Day -- will display ground delivery with 5 to 10 Day delivery expectation\n* 11 to 20 Day -- will display ground delivery with 11 to 20 Day delivery expectation\n* 21 to 30 Day -- will display ground delivery with 21 to 30 Day delivery expectation" } [/block] [block:api-header] { "type": "basic", "title": "Request Body" } [/block] The shipping exceptions call is used to set up specific methods and costs for individual SKUs that will override your default settings, with the ability to drill down to the fulfillment node level. Note: Beginning May 29, 2017, tor the sake of clarity and efficiency, shipping exceptions must adhere to the following rules: - Restricted exceptions must be associated with methods that are enabled by the merchant at the fulfillment node - A merchant cannot restrict all methods at a fulfillment node - If an Exclusive exception is specified at a node, then an Include exception cannot be listed at that same fulfillment node - If an Exclusive exception is specified at a node, then a Restricted exception cannot be listed at that same fulfillment node The fields for shipping exceptions are outlined below: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**fulfillment_nodes** \n\n*fulfillment_nodes object array*", "0-1": "This is an array of fulfillment nodes. Please see our fulfillment nodes array table below.", "0-3": "", "h-4": "Required" }, "cols": 3, "rows": 1 } [/block] **fulfillment_nodes array** - The fields below are part of a fulfillment_nodes object [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "h-4": "Required", "0-0": "**fulfillment_node_id**\n\n*string*", "0-1": "The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.", "0-3": "", "0-4": "", "1-4": "", "1-3": "", "1-1": "This array contains all fields below. There can be multiple shipping exception arrays in a fulfillment node array.", "1-0": "**shipping_exceptions**\n\n*shipping_exceptions object array*", "0-2": "Must be a valid fulfillment node ID set up by the merchant" }, "cols": 3, "rows": 2 } [/block] **shipping_exceptions object** - The fields below are part of the shipping_exceptions object [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "", "0-0": "**service_level** \n\n*string*", "0-1": "This field should be used if you are defining your shipping options by service_level. This is not carrier specific", "0-2": "Either service_level or shipping_method must be provided\n\nMust be one of the following values:\n* Second Day\n* Next Day\n* Priority\n* Expedited\n* Standard\n* Scheduled (freight)\n* 5 to 10 Day\n* 11 to 20 Day\n* 21 to 30 Day\n* Scheduled (freight 11 to 20 day)\n* Scheduled (freight 21 to 30 day)", "0-3": "", "1-0": "**shipping_method** \n\n*string*", "1-1": "A specific shipping method e.g. UPS Ground, UPS Next Day Air, FedEx Home, Freight.", "1-2": "Either service_level or shipping_method must be provided\n\nMust be one of the following values:\n\n * DHL Global Mail\n * FedEx 2 Day\n * FedEx Express Saver\n * FedEx First Overnight\n * FedEx Ground\n * FedEx Home Delivery\n * FedEx Priority Overnight\n * FedEx Smart Post\n * FedEx Standard Overnight\n * Freight\n * Ontrac Ground\n * UPS 2nd Day Air AM\n * UPS 2nd Day Air\n * UPS 3 Day Select\n * UPS Ground\n * UPS Mail Innovations\n * UPS Next Day Air Saver\n * UPS Next Day Air\n * UPS SurePost\n * USPS First Class Mail\n * USPS Media Mail\n * USPS Priority Mail Express\n * USPS Priority Mail\n * USPS Standard Post", "1-3": "", "2-0": "**override_type** \n\n*string*", "2-1": "Override charge - A charge that overrides the default shipping charge.\n\nAdditional charge - A charge that is added to the default shipping charge.", "2-2": "Must be one of the following values:\n* Override charge\n* Additional charge\n\nIf shipping_exception_type is \"restricted\", override_type and shipping_charge_amount should not be provided\n\nIf the override_type is \"Additional charge\" the shipping method or service level provided must exist on the fulfillment node", "2-3": "", "3-0": "**shipping_charge_amount**\n\n*float*", "3-1": "The amount added to your default shipping charge when override_type = \"Additional charge\" \n\nThe total amount charged when override_type = \"Override charge\"", "3-3": "", "4-0": "**shipping_exception_type*** \n\n*string*", "4-1": "Indicates if you want the product to be shipped exclusively (only with) or restrictively (not including) via the shipping level of shipping method provided\n\nValid Values\n* restricted - The product cannot be shipped using the shipping method or shipping level provided. \n\nThere can be many restricted shipping methods per fulfillment node.\n\n* exclusive - The product should only be shipped using the shipping method or shipping level provided. \n\nThere can only be one exclusive shipping method per fulfillment node.\n\n* include - The product will be priced normally under the Jet.com pricing algorithm. \n\nIf the shipping method determined for the order has an exception on it, the appropriate override_type will be applied", "4-2": "Must be one of the following values:\n* exclusive \n* restricted\n* include", "4-3": "", "h-4": "", "3-2": "A number >= 0\n\nRequired if override_type is provided" }, "cols": 3, "rows": 5 } [/block] \* denotes that field is required [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Example request bodies below", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"XISNDKSANDSFNCSJKFDNFKJHFJD\",\n \"shipping_exceptions\": [\n {\n \"service_level\": \"Standard\",\n \"shipping_exception_type\": \"restricted\"\n },\n {\n \"service_level\": \"NextDay\",\n \"shipping_exception_type\": \"restricted\"\n }\n ]\n },\n {\n \"fulfillment_node_id\": \"1234DKSANDSFNCSJKFDNFKJHFAZ\",\n \"shipping_exceptions\": [\n {\n \"service_level\": \"Standard\",\n \"override_type\": \"Additional charge\",\n \"shipping_charge_amount\": 3.25,\n \"shipping_exception_type\": \"exclusive\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "Mixed Example" }, { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"1234DKSANDSFNCSJKFDNFKJHFAZ\",\n \"shipping_exceptions\": [\n {\n \"shipping_method\": \"Freight\",\n \"override_type\": \"Additional charge\",\n \"shipping_charge_amount\": 3.25,\n \"shipping_exception_type\": \"exclusive\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "Exclusive" }, { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"XISNDKSANDSFNCSJKFDNFKJHFJD\",\n \"shipping_exceptions\": [\n {\n \"service_level\": \"Standard\",\n \"shipping_exception_type\": \"restricted\"\n },\n {\n \"shipping_method\": \"UPS Ground\",\n \"shipping_exception_type\": \"restricted\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "Multiple Restricted" }, { "code": "{}", "language": "json", "name": "Empty JSON object clear" }, { "code": "{\n\t\"fulfillment_nodes\":[]\n}", "language": "json", "name": "Empty fulfillment_nodes array clear" }, { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"1234DKSANDSFNCSJKFDNFKJHFAZ\",\n \"shipping_exceptions\": [\n {\n \"shipping_method\": \"FedEx Home Delivery\", //if FedEx Home Delivery is chosen as the shipping method for the order, we'll add an additional $1\n \"override_type\": \"Additional charge\",\n \"shipping_charge_amount\": 1,\n \"shipping_exception_type\": \"include\"\n },\n {\n \"shipping_method\": \"UPS Next Day Air\", \n \"override_type\": \"Override charge\",\n \"shipping_charge_amount\": 100,\n \"shipping_exception_type\": \"include\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "Include Exception Type" }, { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"1234DKSANDSFNCSJKFDNFKJHFAZ\",\n \"shipping_exceptions\": [\n {\n \"shipping_method\": \"Freight\",\n \"override_type\": \"Override charge\",\n \"shipping_charge_amount\": 100,\n \"shipping_exception_type\": \"exclusive\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "Freight Example" }, { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"1234DKSANDSFNCSJKFDNFKJHFAZ\",\n \"shipping_exceptions\": [\n {\n \"service_level\": \"5 to 10 Day\",\n \"override_type\": \"Override charge\",\n \"shipping_charge_amount\": 1,\n \"shipping_exception_type\": \"exclusive\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "5 to 10 Day" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


[block:callout] { "type": "warning", "title": "Designating Items 'Freight'", "body": "For any product that always ships freight, please set up a shipping exception. A freight designation will signal to the customer that the product may take 5-10 business days. Please refer to the 'freight' example for more information." } [/block] [block:callout] { "type": "warning", "title": "Items with longer lead times", "body": "The following service_level values will display different fulfillment expectations to customers at checkout:\n* Scheduled (freight) -- will display freight delivery with 5 to 10 day delivery expectation\n* Scheduled (freight 11 to 20 day) -- will display freight delivery with 11 to 20 day delivery expectation\n* Scheduled (freight 21 to 30 day) -- will display freight delivery with 21 to 30 day delivery expectation\n* 5 to 10 Day -- will display ground delivery with 5 to 10 Day delivery expectation\n* 11 to 20 Day -- will display ground delivery with 11 to 20 Day delivery expectation\n* 21 to 30 Day -- will display ground delivery with 21 to 30 Day delivery expectation" } [/block] [block:api-header] { "type": "basic", "title": "Request Body" } [/block] The shipping exceptions call is used to set up specific methods and costs for individual SKUs that will override your default settings, with the ability to drill down to the fulfillment node level. Note: Beginning May 29, 2017, tor the sake of clarity and efficiency, shipping exceptions must adhere to the following rules: - Restricted exceptions must be associated with methods that are enabled by the merchant at the fulfillment node - A merchant cannot restrict all methods at a fulfillment node - If an Exclusive exception is specified at a node, then an Include exception cannot be listed at that same fulfillment node - If an Exclusive exception is specified at a node, then a Restricted exception cannot be listed at that same fulfillment node The fields for shipping exceptions are outlined below: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**fulfillment_nodes** \n\n*fulfillment_nodes object array*", "0-1": "This is an array of fulfillment nodes. Please see our fulfillment nodes array table below.", "0-3": "", "h-4": "Required" }, "cols": 3, "rows": 1 } [/block] **fulfillment_nodes array** - The fields below are part of a fulfillment_nodes object [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "h-4": "Required", "0-0": "**fulfillment_node_id**\n\n*string*", "0-1": "The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.", "0-3": "", "0-4": "", "1-4": "", "1-3": "", "1-1": "This array contains all fields below. There can be multiple shipping exception arrays in a fulfillment node array.", "1-0": "**shipping_exceptions**\n\n*shipping_exceptions object array*", "0-2": "Must be a valid fulfillment node ID set up by the merchant" }, "cols": 3, "rows": 2 } [/block] **shipping_exceptions object** - The fields below are part of the shipping_exceptions object [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "", "0-0": "**service_level** \n\n*string*", "0-1": "This field should be used if you are defining your shipping options by service_level. This is not carrier specific", "0-2": "Either service_level or shipping_method must be provided\n\nMust be one of the following values:\n* Second Day\n* Next Day\n* Priority\n* Expedited\n* Standard\n* Scheduled (freight)\n* 5 to 10 Day\n* 11 to 20 Day\n* 21 to 30 Day\n* Scheduled (freight 11 to 20 day)\n* Scheduled (freight 21 to 30 day)", "0-3": "", "1-0": "**shipping_method** \n\n*string*", "1-1": "A specific shipping method e.g. UPS Ground, UPS Next Day Air, FedEx Home, Freight.", "1-2": "Either service_level or shipping_method must be provided\n\nMust be one of the following values:\n\n * DHL Global Mail\n * FedEx 2 Day\n * FedEx Express Saver\n * FedEx First Overnight\n * FedEx Ground\n * FedEx Home Delivery\n * FedEx Priority Overnight\n * FedEx Smart Post\n * FedEx Standard Overnight\n * Freight\n * Ontrac Ground\n * UPS 2nd Day Air AM\n * UPS 2nd Day Air\n * UPS 3 Day Select\n * UPS Ground\n * UPS Mail Innovations\n * UPS Next Day Air Saver\n * UPS Next Day Air\n * UPS SurePost\n * USPS First Class Mail\n * USPS Media Mail\n * USPS Priority Mail Express\n * USPS Priority Mail\n * USPS Standard Post", "1-3": "", "2-0": "**override_type** \n\n*string*", "2-1": "Override charge - A charge that overrides the default shipping charge.\n\nAdditional charge - A charge that is added to the default shipping charge.", "2-2": "Must be one of the following values:\n* Override charge\n* Additional charge\n\nIf shipping_exception_type is \"restricted\", override_type and shipping_charge_amount should not be provided\n\nIf the override_type is \"Additional charge\" the shipping method or service level provided must exist on the fulfillment node", "2-3": "", "3-0": "**shipping_charge_amount**\n\n*float*", "3-1": "The amount added to your default shipping charge when override_type = \"Additional charge\" \n\nThe total amount charged when override_type = \"Override charge\"", "3-3": "", "4-0": "**shipping_exception_type*** \n\n*string*", "4-1": "Indicates if you want the product to be shipped exclusively (only with) or restrictively (not including) via the shipping level of shipping method provided\n\nValid Values\n* restricted - The product cannot be shipped using the shipping method or shipping level provided. \n\nThere can be many restricted shipping methods per fulfillment node.\n\n* exclusive - The product should only be shipped using the shipping method or shipping level provided. \n\nThere can only be one exclusive shipping method per fulfillment node.\n\n* include - The product will be priced normally under the Jet.com pricing algorithm. \n\nIf the shipping method determined for the order has an exception on it, the appropriate override_type will be applied", "4-2": "Must be one of the following values:\n* exclusive \n* restricted\n* include", "4-3": "", "h-4": "", "3-2": "A number >= 0\n\nRequired if override_type is provided" }, "cols": 3, "rows": 5 } [/block] \* denotes that field is required [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Example request bodies below", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"XISNDKSANDSFNCSJKFDNFKJHFJD\",\n \"shipping_exceptions\": [\n {\n \"service_level\": \"Standard\",\n \"shipping_exception_type\": \"restricted\"\n },\n {\n \"service_level\": \"NextDay\",\n \"shipping_exception_type\": \"restricted\"\n }\n ]\n },\n {\n \"fulfillment_node_id\": \"1234DKSANDSFNCSJKFDNFKJHFAZ\",\n \"shipping_exceptions\": [\n {\n \"service_level\": \"Standard\",\n \"override_type\": \"Additional charge\",\n \"shipping_charge_amount\": 3.25,\n \"shipping_exception_type\": \"exclusive\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "Mixed Example" }, { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"1234DKSANDSFNCSJKFDNFKJHFAZ\",\n \"shipping_exceptions\": [\n {\n \"shipping_method\": \"Freight\",\n \"override_type\": \"Additional charge\",\n \"shipping_charge_amount\": 3.25,\n \"shipping_exception_type\": \"exclusive\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "Exclusive" }, { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"XISNDKSANDSFNCSJKFDNFKJHFJD\",\n \"shipping_exceptions\": [\n {\n \"service_level\": \"Standard\",\n \"shipping_exception_type\": \"restricted\"\n },\n {\n \"shipping_method\": \"UPS Ground\",\n \"shipping_exception_type\": \"restricted\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "Multiple Restricted" }, { "code": "{}", "language": "json", "name": "Empty JSON object clear" }, { "code": "{\n\t\"fulfillment_nodes\":[]\n}", "language": "json", "name": "Empty fulfillment_nodes array clear" }, { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"1234DKSANDSFNCSJKFDNFKJHFAZ\",\n \"shipping_exceptions\": [\n {\n \"shipping_method\": \"FedEx Home Delivery\", //if FedEx Home Delivery is chosen as the shipping method for the order, we'll add an additional $1\n \"override_type\": \"Additional charge\",\n \"shipping_charge_amount\": 1,\n \"shipping_exception_type\": \"include\"\n },\n {\n \"shipping_method\": \"UPS Next Day Air\", \n \"override_type\": \"Override charge\",\n \"shipping_charge_amount\": 100,\n \"shipping_exception_type\": \"include\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "Include Exception Type" }, { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"1234DKSANDSFNCSJKFDNFKJHFAZ\",\n \"shipping_exceptions\": [\n {\n \"shipping_method\": \"Freight\",\n \"override_type\": \"Override charge\",\n \"shipping_charge_amount\": 100,\n \"shipping_exception_type\": \"exclusive\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "Freight Example" }, { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"1234DKSANDSFNCSJKFDNFKJHFAZ\",\n \"shipping_exceptions\": [\n {\n \"service_level\": \"5 to 10 Day\",\n \"override_type\": \"Override charge\",\n \"shipping_charge_amount\": 1,\n \"shipping_exception_type\": \"exclusive\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "5 to 10 Day" } ], "sidebar": true } [/block]
{"_id":"56fd2bf327b4321900186ed6","updates":["58903b8a11d5c11b00f43d22","58d18d0a5db32e25001b4130"],"editedParams":true,"excerpt":"","order":5,"parentDoc":null,"version":"56fd2bf327b4321900186ec6","__v":4,"next":{"description":"","pages":[]},"createdAt":"2015-10-26T20:33:24.308Z","githubsync":"","link_url":"","sync_unique":"","title":"SKU Upload","type":"put","api":{"results":{"codes":[{"code":"","language":"json","status":204},{"code":"","language":"json","status":400}]},"settings":"","url":"/merchant-skus/{user_defined_sku_id}","auth":"required","examples":{"codes":[]},"method":"put","params":[{"desc":"The identifier you will use to track and update your merchant SKU. Maximum of 64 chars.","default":"","type":"string","name":"user_defined_sku_id","_id":"562e8e1419e7b40d00b7c723","ref":"","in":"path","required":true}]},"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"user_defined_sku_id acceptable characters\",\n  \"body\": \"The user_defined_sku_id should be between one (inclusive) and 64 characters (exclusive).\\n\\nSpecial characters outside the ASCII character set are acceptable but will later need to be encoded in accordance with UTF-8 for retrieval of these SKUs' information, as in the following case: \\n\\nGET https://merchant-api.jet.com/api/merchant-skus?sku={test/special*characters}\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request Body\"\n}\n[/block]\n##  Required Data\n\nJet.com maps all product offers to a universal catalog using the following data:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-2\": \"Validation\",\n    \"h-1\": \"Description\",\n    \"h-4\": \"Defined By\",\n    \"1-0\": \"**multipack_quantity***\\n\\n*integer*\",\n    \"1-1\": \"Number of items with the given Standard Product Code that makes up your merchant SKU (product offer).\",\n    \"1-4\": \"Merchant\",\n    \"2-2\": \"Required if ASIN not provided\",\n    \"2-0\": \"**standard_product_codes**\\n\\n*standard_product_codes object array*\",\n    \"2-1\": \"This is an array of product codes. Please see our product code array table below.\",\n    \"2-4\": \"Merchant\",\n    \"3-0\": \"**ASIN** \\n\\n*string*\",\n    \"3-1\": \"Amazon standard identification number for this merchant SKU if available.\",\n    \"3-2\": \"Required if standard_product_codes not provided\\nAlphanumeric\\nlength of 10\",\n    \"3-4\": \"Merchant\",\n    \"0-0\": \"**product_title***\\n\\n*string*\",\n    \"0-2\": \"5 to 500 characters\",\n    \"0-1\": \"The title of a given merchant sku.\",\n    \"h-5\": \"Required\",\n    \"0-5\": \"Yes\",\n    \"1-5\": \"Yes\",\n    \"2-5\": \"Required if ASIN not provided\",\n    \"3-5\": \"Required if standard product codes not provided\",\n    \"1-2\": \"1 to 128\",\n    \"4-0\": \"**brand***\\n\\n*string*\",\n    \"4-1\": \"The brand for your merchant SKU\",\n    \"4-2\": \"1 to 100 characters\",\n    \"5-0\": \"**main_image_url***\\n\\n*string*\",\n    \"5-1\": \"URL location where Jet.com can access the image. The images should be 40,000 pixels or larger, There is no limit to image size.\\n\\n* the only unsupported image file formats are multi-layer png and gif.\\n* all images' areas must be at least 40000 pixels (ie 200x200)\\n* one side must be at least 100 pixels\",\n    \"5-2\": \"A valid image URL.  Jet.com will not be able to accept broken image links, or \\\"no image\\\" images.\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Image Processing Failures\",\n  \"body\": \"In some cases, Jet's API may accept a valid image URL only to find that processing will fail downstream.  Our image processor may fail to process the following kinds of images:\\n* Images with a \\\"No Image Available\\\" message\\n* Blank Images\\n* Logos\\n* Watermarked Images\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Using ASIN as an Identifier\",\n  \"body\": \"If you are sending an ASIN as a unique product identifier, please include the actual ASIN, not the parent ASIN.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Multipack Quantity Errors\",\n  \"body\": \"Multipack quantity is NOT the same as product count.  As a rule of thumb, multipack quantity is the number of barcodes that make up your product offer.\"\n}\n[/block]\n**standard_product_codes object** - The following fields are part of the standard_product_codes object:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**standard_product_code_type** \\n\\n*string*\",\n    \"h-0\": \"Field\",\n    \"h-2\": \"Validation\",\n    \"h-1\": \"Description\",\n    \"0-2\": \"Must be one of the following values:\\n* GTIN-14\\n* EAN\\n* ISBN-10\\n* ISBN-13\\n* UPC\",\n    \"1-2\": \"If standard product code = \\n  * 'GTIN-14' - 14 digits\\n  * 'EAN' -       13 digits\\n  * 'ISBN-10' - 10 digits\\n  * 'ISBN-13' - 13 digits \\n  * 'UPC'-       12 digits\",\n    \"1-0\": \"**standard_product_code** \\n\\n*string*\",\n    \"0-1\": \"The type of standard product code that is being provided\",\n    \"1-1\": \"The standard product code associated with the type provided\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n##  Minimum Listing Data\n\nOn Jet.com, product offers across merchants are mapped to a universal product listing.  Jet chooses the best pieces from each listing to create a unified listing.  If a product offer matches to an existing product in our catalog, the retailer may need to provide little to no additional information than what is expected above.  If the product is not available already, the fields below may be required.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-2\": \"Validation\",\n    \"1-0\": \"**manufacturer** \\n\\n*string*\",\n    \"h-1\": \"Description\",\n    \"h-4\": \"Defined By:\",\n    \"1-2\": \"1 to 100 characters\",\n    \"1-1\": \"Manufacturer of the merchant SKU.\",\n    \"1-4\": \"Merchant\",\n    \"3-0\": \"**bullets**\\n\\n*string array*\",\n    \"3-1\": \"Merchant SKU feature description. Jet currently allows for up to 5 bullets.\",\n    \"3-2\": \"1 to 500 characters\\nMax 5 strings\",\n    \"3-4\": \"Merchant\",\n    \"4-4\": \"Merchant\",\n    \"5-4\": \"Merchant\",\n    \"6-4\": \"Merchant\",\n    \"0-0\": \"**product_description** \\n\\n*string*\",\n    \"0-2\": \"1 to 2000 characters\",\n    \"2-0\": \"**mfr_part_number** \\n\\n*string*\",\n    \"2-2\": \"1 to 50 characters\",\n    \"2-1\": \"Part number provided by the original manufacturer of the merchant SKU.\",\n    \"2-4\": \"Merchant\",\n    \"4-0\": \"**shipping_weight_pounds** \\n\\n*float*\",\n    \"4-2\": \"Must be >= 0.01\",\n    \"4-1\": \"Weight of the merchant SKU when in its shippable configuration.\",\n    \"5-0\": \"**map_price** \\n\\n*float*\",\n    \"5-2\": \"Must be >= 0.01\",\n    \"6-1\": \"Price policy rule that determines allowed item pricing and Jet member savings shown to the consumer.  Please note that this field name is misleading as it is used for all price policies and not just a MAP policy.  These settings only apply to what the consumer is shown and have no impact on what a retailer is paid for an item.\\n\\n'101' = no restrictions on displayed product pricing or Jet member savings on the product.  This setting is the normal setting used for most products.\\n\\n'102' = Jet member savings for the product are never advertised and are only visible to logged in Jet members after they specifically request to reveal savings.  This value can be used when complying with a manufacturer's Minimum Advertised Price (MAP) policy.  The API map_price field must also be used when using this setting as it is needed to display a price for advertising and initial presentation to the consumer. \\n\\n'103' = Jet member savings never applied to product and product orders never awarded to retailer if Jet item price is below item price sent by retailer.  This value can be used when complying with a manufacturer's Unilateral Minimum Retail Price Policy.  This policy setting will restrict the ability to win an order for a product if the retailer item price sent is above Jet's item price shown to the consumer.\",\n    \"5-1\": \"Minimum Advertised Price (MAP) for the product.  This price is used as the display or reference price when price policy value 102 is used via the map_implementation field.\",\n    \"6-0\": \"**map_implementation** \\n\\n*string*\",\n    \"6-2\": \"Must be one of the following values:\\n* 103\\n* 102\\n* 101\",\n    \"h-5\": \"Required\",\n    \"4-5\": \"Required if shipping rates for fulfillment nodes are set up \\\"per pound\\\"\",\n    \"5-5\": \"Required if map_implementation field = '102'\",\n    \"7-0\": \"**jet_browse_node_id** \\n\\n*integer*\",\n    \"7-1\": \"The unique ID that defines where the product will be found in the Jet.com browse structure. This can be found using the Jet Taxonomy API.\",\n    \"7-2\": \"This must be a valid jet_browse_node_id. Note: Beginning May 29, 2017, the \\\"jet_browse_node_id\\\" uploaded in a merchant SKU payload must be a real node in the Jet taxonomy. The field will remain optional.\",\n    \"8-0\": \"**attributes_node_specific**\\n\\n*attributes_node_specific array*\",\n    \"8-1\": \"Attributes associated with the category provided\",\n    \"8-2\": \"Minimum 1 attributes_node_specific object required if this field is provided Maximum 50 attributes_node_specific object required if this field is provided\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]\n**attributes_node_specific** - The following fields are a part of the attributes_node_specific object\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-2\": \"Validation\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"**attribute_id** \\n\\n*int64*\",\n    \"0-1\": \"The node attribute ID number that you get from the [Jet Taxonomy](https://www.dropbox.com/s/18wn56zutquey8m/Jet_Taxonomy.xlsx?dl=0) that corresponds with the attribute you are passing.\",\n    \"1-0\": \"**attribute_value**\\n\\n*string*\",\n    \"0-2\": \"Must be > 0\",\n    \"2-0\": \"**attribute_value_unit**\\n\\n*string*\",\n    \"1-1\": \"The value for the attribute. For example, if the attribute is size you may pass 'large' or if the the attribute is weight, you may pass '22'. For attributes like weight the unit will be passed in the next field.\",\n    \"2-1\": \"If the attribute_value requires a unit, then you pass the unit here.\",\n    \"1-2\": \"Must have a length between 1 and 100\\nCannot be an image URL\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Size Attribute: Clothing\",\n  \"body\": \"The size attribute is required for all clothing SKUs.  The size attribute may depend on category.\"\n}\n[/block]\n##  Additional Fields\n\nThe fields listed below are encouraged to be used when adding a sku to Jet.com. The unified catalog that Jet may need this data to list your product.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-2\": \"Validation\",\n    \"h-1\": \"Description\",\n    \"h-4\": \"Defined By\",\n    \"0-0\": \"**amazon_item_type_keyword** \\n\\n*string*\",\n    \"0-2\": \"\",\n    \"0-1\": \"ItemType allows customers to find your products as they browse to the most specific item types.\",\n    \"2-0\": \"**number_units_for_price_per_unit** \\n\\n*integer*\",\n    \"2-2\": \"\",\n    \"2-1\": \"For Price Per Unit calculations, the number of units included in the merchant SKU. The unit of measure must be specified in order to indicate what is being measured by the unit-count.\",\n    \"3-0\": \"**type_of_unit_for_price_per_unit** \\n\\n*string*\",\n    \"3-1\": \"The type_of_unit_for_price_per_unit attribute is a label for the number_units_for_price_per_unit. The price per unit can then be constructed by dividing the selling price by the number of units and appending the text \\\"per unit value.\\\" For example, for a six-pack of soda, number_units_for_price_per_unit= 6, type_of_unit_for_price_per_unit= can, price per unit = price per can.\",\n    \"4-0\": \"**package_length_inches** \\n\\n*float*\",\n    \"4-2\": \"A number >= 0.01\",\n    \"4-1\": \"Length of the merchant SKU when in its shippable configuration.\",\n    \"5-0\": \"**package_width_inches** \\n\\n*float*\",\n    \"5-2\": \"A number >= 0.01\",\n    \"5-1\": \"Width of the merchant SKU when in its shippable configuration.\",\n    \"6-0\": \"**package_height_inches** \\n\\n*float*\",\n    \"6-1\": \"Height of the merchant SKU when in its shippable configuration.\",\n    \"6-2\": \"A number >= 0.01\",\n    \"7-0\": \"**display_length_inches** \\n\\n*float*\",\n    \"7-2\": \"A number >= 0.01\",\n    \"8-0\": \"**display_width_inches** \\n\\n*float*\",\n    \"7-1\": \"Length of the merchant SKU when in its fully assembled/usable condition.\",\n    \"8-2\": \"A number >= 0.01\",\n    \"9-0\": \"**display_height_inches** \\n\\n*float*\",\n    \"9-2\": \"A number >= 0.01\",\n    \"9-1\": \"Height of the merchant SKU when in its fully assembled/usable condition.\",\n    \"8-1\": \"Width of the merchant SKU when in its fully assembled/usable condition.\",\n    \"10-0\": \"**prop_65** \\n\\n*boolean*\",\n    \"10-1\": \"You must tell us if your product is subject to Proposition 65 rules and regulations. Proposition 65 requires merchants to provide California consumers with special warnings for products that contain chemicals known to cause cancer, birth defects, or other reproductive harm, if those products expose consumers to such materials above certain threshold levels. The default value for this is \\\"false,\\\" so if you do not populate this column, we will assume your product is not subject to this rule. Please view this website for more information: http://www.oehha.ca.gov/.\",\n    \"10-2\": \"\",\n    \"11-0\": \"**legal_disclaimer_description** \\n\\n*string*\",\n    \"11-1\": \"Any legal language required to be displayed with the product.\",\n    \"12-0\": \"**cpsia_cautionary_statements **\\n\\n*string array*\",\n    \"12-1\": \"Use this field to indicate if a cautionary statement relating to the choking hazards of children's toys and games applies to your product. These cautionary statements are defined in Section 24 of the Federal Hazardous Substances Act and Section 105 of the Consumer Product Safety Improvement Act of 2008. They must be displayed on the product packaging and in certain online and catalog advertisements. You are responsible for determining if a cautionary statement applies to the product. This can be verified by contacting the product manufacturer or checking the product packaging. Cautionary statements that you select will be displayed on the product detail page. If no cautionary statement applies to the product, select \\\"no warning applicable\\\".\",\n    \"12-2\": \"Must be one of the following values:\\n* no warning applicable\\n* choking hazard small parts\\n* choking hazard is a small ball\\n* choking hazard is a marble\\n* choking hazard contains a small ball\\n* choking hazard contains a marble\\n* choking hazard balloon\\n\\nCannot have 'no warning applicable' and another reason submitted together\",\n    \"13-0\": \"**country_of_origin** \\n\\n*string*\",\n    \"13-1\": \"The country that the item was manufactured in.\",\n    \"14-0\": \"**safety_warning** \\n\\n*string*\",\n    \"13-2\": \"Maximum 50 characters\",\n    \"14-1\": \"If applicable, use to supply any associated warnings for your product.\",\n    \"15-0\": \"**product_tax_code** \\n\\n*string*\",\n    \"15-2\": \"Must be one of the following values:\\n* 'Toilet Paper'\\n* 'Thermometers'\\n* 'Sweatbands'\\n* 'SPF Suncare Products'\\n* 'Sparkling Water'\\n* 'Smoking Cessation'\\n* 'Shoe Insoles'\\n* 'Safety Clothing'\\n* 'Pet Foods'\\n* 'Paper Products'\\n* 'OTC Pet Meds'\\n* 'OTC Medication'\\n* 'Oral Care Products'\\n* 'Non-Motorized Boats'\\n* 'Non Taxable Product'\\n* 'Mobility Equipment'\\n* 'Medicated Personal Care Items'\\n* 'Infant Clothing'\\n* 'Helmets'\\n* 'Handkerchiefs'\\n* 'Generic Taxable Product'\\n* 'General Grocery Items'\\n* 'General Clothing'\\n* 'Fluoride Toothpaste'\\n* 'Feminine Hygiene Products'\\n* 'Durable Medical Equipment'\\n* 'Drinks under 50 Percent Juice'\\n* 'Disposable Wipes'\\n* 'Disposable Infant Diapers'\\n* 'Dietary Supplements'\\n* 'Diabetic Supplies'\\n* 'Costumes'\\n* 'Contraceptives'\\n* 'Contact Lens Solution'\\n* 'Carbonated Soft Drinks'\\n* 'Car Seats'\\n* 'Candy with Flour'\\n* 'Candy'\\n* 'Breast Pumps'\\n* 'Braces and Supports'\\n* 'Bottled Water Plain'\\n* 'Beverages with 51 to 99 Percent Juice'\\n* 'Bathing Suits'\\n* 'Bandages and First Aid Kits'\\n* 'Baby Supplies'\\n* 'Athletic Clothing'\\n* 'Adult Diapers'\",\n    \"15-1\": \"Jet's standard code for the tax properties of a given product.\",\n    \"14-2\": \"Maximum 2000 characters\",\n    \"16-0\": \"**msrp** \\n\\n*float*\",\n    \"16-2\": \"A number >= 0.01\",\n    \"16-1\": \"The manufacturer's suggested retail price or list price for the product\",\n    \"17-0\": \"**alternate_images**\\n\\n*alternate_images object*\",\n    \"17-1\": \"Any additional images you would like to include for the product\",\n    \"1-0\": \"**category_path**\\n\\n*string*\",\n    \"1-1\": \"The category path for where this product is located in your categorization structure\\n\\ne.g. A laptop bag might belong in Electronics/Computers/Laptops/Accessories/Bags in your product's category\"\n  },\n  \"cols\": 3,\n  \"rows\": 18\n}\n[/block]\n**alternate_images** - The following fields are a part of the alternate_images object\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**image_slot_id**\\n\\n*integer*\",\n    \"0-1\": \"The slot that the alternate image should be uploaded to. Jet.com supports up to 8 images (or 8 image slots).\",\n    \"0-2\": \"* 1 to 8\\n* Required if alternate images array is provided\\n* Image slots cannot be duplicated\",\n    \"1-0\": \"**image_url** \\n\\n*string*\",\n    \"1-1\": \"URL location where Jet.com can access the image. The images should be 1500 x 1500 pixels or larger, but anything 500 x 500 pixels or larger is acceptable. There is no limit to image size.\\n\\n* the only unsupported image file formats are multi-layer png and gif.\\n* all images' areas must be at least 40000 pixels (ie 200x200)\\n* one side must be at least 100 pixels\",\n    \"1-2\": \"* A valid image URL.  Jet.com will not be able to accept broken image links, or \\\"no image\\\" images.\\n* Required if alternate images array is provided\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use Cases\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Examples request bodies\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n\\\"product_title\\\": \\\"My Product\\\",\\n\\\"jet_browse_node_id\\\": 1000001,\\n\\\"standard_product_codes\\\": [\\n  {\\n  \\\"standard_product_code\\\": \\\"123456789012\\\",\\n  \\\"standard_product_code_type\\\": \\\"UPC\\\"\\n  }\\n],\\n\\\"multipack_quantity\\\": 6,\\n\\\"brand\\\": \\\"My Product's Brand\\\",\\n\\\"manufacturer\\\": \\\"My Product's Manufacturer\\\",\\n\\\"mfr_part_number\\\": \\\"AB-9874\\\",\\n\\\"product_description\\\": \\\"This is a terrific product that everyone should own.\\\",\\n\\\"bullets\\\": [\\n  \\\"This is bullet line 1\\\",\\n  \\\"This is bullet line 2\\\"\\n],\\n\\\"number_units_for_price_per_unit\\\": 1,\\n\\\"type_of_unit_for_price_per_unit\\\": \\\"each\\\",\\n\\\"shipping_weight_pounds\\\": 10,\\n\\\"package_length_inches\\\": 12,\\n\\\"package_width_inches\\\": 12,\\n\\\"package_height_inches\\\": 12,\\n\\\"display_length_inches\\\": 15,\\n\\\"display_width_inches\\\": 12,\\n\\\"display_height_inches\\\": 14,\\n\\\"prop_65\\\": true,\\n\\\"legal_disclaimer_description\\\": \\\"Legal stuff goes here\\\",\\n\\\"cpsia_cautionary_statements\\\": [\\n  \\\"choking hazard balloon\\\",\\n  \\\"choking hazard small parts\\\"\\n],\\n\\\"country_of_origin\\\": \\\"U.S.A.\\\",\\n\\\"safety_warning\\\": \\\"warning text goes here\\\",\\n\\\"msrp\\\": 6.99,\\n\\\"map_price\\\": 6.49,\\n\\\"map_implementation\\\": \\\"102\\\",\\n\\\"product_tax_code\\\": \\\"Generic Taxable Product\\\",\\n\\\"attributes_node_specific\\\": [\\n  {\\n  \\\"attribute_id\\\": 95,\\n  \\\"attribute_value\\\": \\\"80\\\",\\n  \\\"attribute_value_unit\\\": \\\"Count\\\"\\n  },\\n  {\\n  \\\"attribute_id\\\": 119,\\n  \\\"attribute_value\\\": \\\"Aqua\\\"\\n  },\\n  {\\n  \\\"attribute_id\\\": 2,\\n  \\\"attribute_value\\\": \\\"Blue\\\"\\n  }\\n],\\n\\\"main_image_url\\\": \\\"http://www.mydomain.com/images/myImage.png\\\",\\n\\\"swatch_image_url\\\": \\\"http://www.mydomain.com/images/myImage.png\\\",\\n\\\"alternate_images\\\": [\\n  {\\n  \\\"image_slot_id\\\": 1,\\n  \\\"image_url\\\": \\\"http://www.mydomain.com/images/myImage.png\\\"\\n  },\\n  {\\n  \\\"image_slot_id\\\": 2,\\n  \\\"image_url\\\": \\\"http://www.mydomain.com/images/myImage.png\\\"\\n  }\\n]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"All fields\"\n    },\n    {\n      \"code\": \"{\\n\\\"product_title\\\": \\\"My Product\\\",\\n\\\"standard_product_codes\\\": // required if ASIN not provided\\n [\\n  {\\n  \\\"standard_product_code\\\": \\\"123456789012\\\",\\n  \\\"standard_product_code_type\\\": \\\"UPC\\\"\\n  }\\n],\\n\\\"multipack_quantity\\\": 6,\\n\\\"ASIN\\\":\\\"12345ABCDE\\\" //required if standard product codes array not provided\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Required Fields\"\n    },\n    {\n      \"code\": \"{\\n\\\"product_title\\\": \\\"My Product\\\",\\n\\\"jet_browse_node_id\\\": 1000001,\\n\\\"standard_product_codes\\\": [\\n  {\\n  \\\"standard_product_code\\\": \\\"123456789012\\\",\\n  \\\"standard_product_code_type\\\": \\\"UPC\\\"\\n  }\\n],\\n\\\"multipack_quantity\\\": 6,\\n\\\"brand\\\": \\\"My Product's Brand\\\",\\n\\\"manufacturer\\\": \\\"My Product's Manufacturer\\\",\\n\\\"mfr_part_number\\\": \\\"AB-9874\\\",\\n\\\"product_description\\\": \\\"This is a terrific product that everyone should own.\\\",\\n\\\"bullets\\\": [\\n  \\\"This is bullet line 1\\\",\\n  \\\"This is bullet line 2\\\"\\n],\\n\\n\\\"shipping_weight_pounds\\\": 10,\\n\\\"map_price\\\": 6.49,\\n\\\"map_implementation\\\": \\\"102\\\",\\n\\\"product_tax_code\\\": \\\"General Taxable Product\\\",\\n\\\"attributes_node_specific\\\": [\\n  {\\n  \\\"attribute_id\\\": 95,\\n  \\\"attribute_value\\\": \\\"80\\\",\\n  \\\"attribute_value_unit\\\": \\\"count\\\"\\n  },\\n  {\\n  \\\"attribute_id\\\": 119,\\n  \\\"attribute_value\\\": \\\"aqua\\\"\\n  },\\n  {\\n  \\\"attribute_id\\\": 2,\\n  \\\"attribute_value\\\": \\\"blue\\\"\\n  }\\n],\\n\\\"main_image_url\\\": \\\"http://www.mydomain.com/images/myImage.png\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Required and Recommended Fields\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","editedParams2":true,"hidden":false,"isReference":false,"link_external":false,"project":"562e25f2e01a430d00c2c91e","slug":"merchant-sku","category":"56fd2bf327b4321900186ec9","user":"562e25d24376430d006f1769","childrenPages":[]}

putSKU Upload


Path Params

user_defined_sku_id:
required
string
The identifier you will use to track and update your merchant SKU. Maximum of 64 chars.
[block:callout] { "type": "info", "title": "user_defined_sku_id acceptable characters", "body": "The user_defined_sku_id should be between one (inclusive) and 64 characters (exclusive).\n\nSpecial characters outside the ASCII character set are acceptable but will later need to be encoded in accordance with UTF-8 for retrieval of these SKUs' information, as in the following case: \n\nGET https://merchant-api.jet.com/api/merchant-skus?sku={test/special*characters}" } [/block] [block:api-header] { "type": "basic", "title": "Request Body" } [/block] ## Required Data Jet.com maps all product offers to a universal catalog using the following data: [block:parameters] { "data": { "h-0": "Field", "h-2": "Validation", "h-1": "Description", "h-4": "Defined By", "1-0": "**multipack_quantity***\n\n*integer*", "1-1": "Number of items with the given Standard Product Code that makes up your merchant SKU (product offer).", "1-4": "Merchant", "2-2": "Required if ASIN not provided", "2-0": "**standard_product_codes**\n\n*standard_product_codes object array*", "2-1": "This is an array of product codes. Please see our product code array table below.", "2-4": "Merchant", "3-0": "**ASIN** \n\n*string*", "3-1": "Amazon standard identification number for this merchant SKU if available.", "3-2": "Required if standard_product_codes not provided\nAlphanumeric\nlength of 10", "3-4": "Merchant", "0-0": "**product_title***\n\n*string*", "0-2": "5 to 500 characters", "0-1": "The title of a given merchant sku.", "h-5": "Required", "0-5": "Yes", "1-5": "Yes", "2-5": "Required if ASIN not provided", "3-5": "Required if standard product codes not provided", "1-2": "1 to 128", "4-0": "**brand***\n\n*string*", "4-1": "The brand for your merchant SKU", "4-2": "1 to 100 characters", "5-0": "**main_image_url***\n\n*string*", "5-1": "URL location where Jet.com can access the image. The images should be 40,000 pixels or larger, There is no limit to image size.\n\n* the only unsupported image file formats are multi-layer png and gif.\n* all images' areas must be at least 40000 pixels (ie 200x200)\n* one side must be at least 100 pixels", "5-2": "A valid image URL. Jet.com will not be able to accept broken image links, or \"no image\" images." }, "cols": 3, "rows": 6 } [/block] [block:callout] { "type": "warning", "title": "Image Processing Failures", "body": "In some cases, Jet's API may accept a valid image URL only to find that processing will fail downstream. Our image processor may fail to process the following kinds of images:\n* Images with a \"No Image Available\" message\n* Blank Images\n* Logos\n* Watermarked Images" } [/block] [block:callout] { "type": "warning", "title": "Using ASIN as an Identifier", "body": "If you are sending an ASIN as a unique product identifier, please include the actual ASIN, not the parent ASIN." } [/block] [block:callout] { "type": "danger", "title": "Multipack Quantity Errors", "body": "Multipack quantity is NOT the same as product count. As a rule of thumb, multipack quantity is the number of barcodes that make up your product offer." } [/block] **standard_product_codes object** - The following fields are part of the standard_product_codes object: [block:parameters] { "data": { "0-0": "**standard_product_code_type** \n\n*string*", "h-0": "Field", "h-2": "Validation", "h-1": "Description", "0-2": "Must be one of the following values:\n* GTIN-14\n* EAN\n* ISBN-10\n* ISBN-13\n* UPC", "1-2": "If standard product code = \n * 'GTIN-14' - 14 digits\n * 'EAN' - 13 digits\n * 'ISBN-10' - 10 digits\n * 'ISBN-13' - 13 digits \n * 'UPC'- 12 digits", "1-0": "**standard_product_code** \n\n*string*", "0-1": "The type of standard product code that is being provided", "1-1": "The standard product code associated with the type provided" }, "cols": 3, "rows": 2 } [/block] ## Minimum Listing Data On Jet.com, product offers across merchants are mapped to a universal product listing. Jet chooses the best pieces from each listing to create a unified listing. If a product offer matches to an existing product in our catalog, the retailer may need to provide little to no additional information than what is expected above. If the product is not available already, the fields below may be required. [block:parameters] { "data": { "h-0": "Field", "h-2": "Validation", "1-0": "**manufacturer** \n\n*string*", "h-1": "Description", "h-4": "Defined By:", "1-2": "1 to 100 characters", "1-1": "Manufacturer of the merchant SKU.", "1-4": "Merchant", "3-0": "**bullets**\n\n*string array*", "3-1": "Merchant SKU feature description. Jet currently allows for up to 5 bullets.", "3-2": "1 to 500 characters\nMax 5 strings", "3-4": "Merchant", "4-4": "Merchant", "5-4": "Merchant", "6-4": "Merchant", "0-0": "**product_description** \n\n*string*", "0-2": "1 to 2000 characters", "2-0": "**mfr_part_number** \n\n*string*", "2-2": "1 to 50 characters", "2-1": "Part number provided by the original manufacturer of the merchant SKU.", "2-4": "Merchant", "4-0": "**shipping_weight_pounds** \n\n*float*", "4-2": "Must be >= 0.01", "4-1": "Weight of the merchant SKU when in its shippable configuration.", "5-0": "**map_price** \n\n*float*", "5-2": "Must be >= 0.01", "6-1": "Price policy rule that determines allowed item pricing and Jet member savings shown to the consumer. Please note that this field name is misleading as it is used for all price policies and not just a MAP policy. These settings only apply to what the consumer is shown and have no impact on what a retailer is paid for an item.\n\n'101' = no restrictions on displayed product pricing or Jet member savings on the product. This setting is the normal setting used for most products.\n\n'102' = Jet member savings for the product are never advertised and are only visible to logged in Jet members after they specifically request to reveal savings. This value can be used when complying with a manufacturer's Minimum Advertised Price (MAP) policy. The API map_price field must also be used when using this setting as it is needed to display a price for advertising and initial presentation to the consumer. \n\n'103' = Jet member savings never applied to product and product orders never awarded to retailer if Jet item price is below item price sent by retailer. This value can be used when complying with a manufacturer's Unilateral Minimum Retail Price Policy. This policy setting will restrict the ability to win an order for a product if the retailer item price sent is above Jet's item price shown to the consumer.", "5-1": "Minimum Advertised Price (MAP) for the product. This price is used as the display or reference price when price policy value 102 is used via the map_implementation field.", "6-0": "**map_implementation** \n\n*string*", "6-2": "Must be one of the following values:\n* 103\n* 102\n* 101", "h-5": "Required", "4-5": "Required if shipping rates for fulfillment nodes are set up \"per pound\"", "5-5": "Required if map_implementation field = '102'", "7-0": "**jet_browse_node_id** \n\n*integer*", "7-1": "The unique ID that defines where the product will be found in the Jet.com browse structure. This can be found using the Jet Taxonomy API.", "7-2": "This must be a valid jet_browse_node_id. Note: Beginning May 29, 2017, the \"jet_browse_node_id\" uploaded in a merchant SKU payload must be a real node in the Jet taxonomy. The field will remain optional.", "8-0": "**attributes_node_specific**\n\n*attributes_node_specific array*", "8-1": "Attributes associated with the category provided", "8-2": "Minimum 1 attributes_node_specific object required if this field is provided Maximum 50 attributes_node_specific object required if this field is provided" }, "cols": 3, "rows": 9 } [/block] **attributes_node_specific** - The following fields are a part of the attributes_node_specific object [block:parameters] { "data": { "h-0": "Field", "h-2": "Validation", "h-1": "Description", "0-0": "**attribute_id** \n\n*int64*", "0-1": "The node attribute ID number that you get from the [Jet Taxonomy](https://www.dropbox.com/s/18wn56zutquey8m/Jet_Taxonomy.xlsx?dl=0) that corresponds with the attribute you are passing.", "1-0": "**attribute_value**\n\n*string*", "0-2": "Must be > 0", "2-0": "**attribute_value_unit**\n\n*string*", "1-1": "The value for the attribute. For example, if the attribute is size you may pass 'large' or if the the attribute is weight, you may pass '22'. For attributes like weight the unit will be passed in the next field.", "2-1": "If the attribute_value requires a unit, then you pass the unit here.", "1-2": "Must have a length between 1 and 100\nCannot be an image URL" }, "cols": 3, "rows": 3 } [/block] [block:callout] { "type": "warning", "title": "Size Attribute: Clothing", "body": "The size attribute is required for all clothing SKUs. The size attribute may depend on category." } [/block] ## Additional Fields The fields listed below are encouraged to be used when adding a sku to Jet.com. The unified catalog that Jet may need this data to list your product. [block:parameters] { "data": { "h-0": "Field", "h-2": "Validation", "h-1": "Description", "h-4": "Defined By", "0-0": "**amazon_item_type_keyword** \n\n*string*", "0-2": "", "0-1": "ItemType allows customers to find your products as they browse to the most specific item types.", "2-0": "**number_units_for_price_per_unit** \n\n*integer*", "2-2": "", "2-1": "For Price Per Unit calculations, the number of units included in the merchant SKU. The unit of measure must be specified in order to indicate what is being measured by the unit-count.", "3-0": "**type_of_unit_for_price_per_unit** \n\n*string*", "3-1": "The type_of_unit_for_price_per_unit attribute is a label for the number_units_for_price_per_unit. The price per unit can then be constructed by dividing the selling price by the number of units and appending the text \"per unit value.\" For example, for a six-pack of soda, number_units_for_price_per_unit= 6, type_of_unit_for_price_per_unit= can, price per unit = price per can.", "4-0": "**package_length_inches** \n\n*float*", "4-2": "A number >= 0.01", "4-1": "Length of the merchant SKU when in its shippable configuration.", "5-0": "**package_width_inches** \n\n*float*", "5-2": "A number >= 0.01", "5-1": "Width of the merchant SKU when in its shippable configuration.", "6-0": "**package_height_inches** \n\n*float*", "6-1": "Height of the merchant SKU when in its shippable configuration.", "6-2": "A number >= 0.01", "7-0": "**display_length_inches** \n\n*float*", "7-2": "A number >= 0.01", "8-0": "**display_width_inches** \n\n*float*", "7-1": "Length of the merchant SKU when in its fully assembled/usable condition.", "8-2": "A number >= 0.01", "9-0": "**display_height_inches** \n\n*float*", "9-2": "A number >= 0.01", "9-1": "Height of the merchant SKU when in its fully assembled/usable condition.", "8-1": "Width of the merchant SKU when in its fully assembled/usable condition.", "10-0": "**prop_65** \n\n*boolean*", "10-1": "You must tell us if your product is subject to Proposition 65 rules and regulations. Proposition 65 requires merchants to provide California consumers with special warnings for products that contain chemicals known to cause cancer, birth defects, or other reproductive harm, if those products expose consumers to such materials above certain threshold levels. The default value for this is \"false,\" so if you do not populate this column, we will assume your product is not subject to this rule. Please view this website for more information: http://www.oehha.ca.gov/.", "10-2": "", "11-0": "**legal_disclaimer_description** \n\n*string*", "11-1": "Any legal language required to be displayed with the product.", "12-0": "**cpsia_cautionary_statements **\n\n*string array*", "12-1": "Use this field to indicate if a cautionary statement relating to the choking hazards of children's toys and games applies to your product. These cautionary statements are defined in Section 24 of the Federal Hazardous Substances Act and Section 105 of the Consumer Product Safety Improvement Act of 2008. They must be displayed on the product packaging and in certain online and catalog advertisements. You are responsible for determining if a cautionary statement applies to the product. This can be verified by contacting the product manufacturer or checking the product packaging. Cautionary statements that you select will be displayed on the product detail page. If no cautionary statement applies to the product, select \"no warning applicable\".", "12-2": "Must be one of the following values:\n* no warning applicable\n* choking hazard small parts\n* choking hazard is a small ball\n* choking hazard is a marble\n* choking hazard contains a small ball\n* choking hazard contains a marble\n* choking hazard balloon\n\nCannot have 'no warning applicable' and another reason submitted together", "13-0": "**country_of_origin** \n\n*string*", "13-1": "The country that the item was manufactured in.", "14-0": "**safety_warning** \n\n*string*", "13-2": "Maximum 50 characters", "14-1": "If applicable, use to supply any associated warnings for your product.", "15-0": "**product_tax_code** \n\n*string*", "15-2": "Must be one of the following values:\n* 'Toilet Paper'\n* 'Thermometers'\n* 'Sweatbands'\n* 'SPF Suncare Products'\n* 'Sparkling Water'\n* 'Smoking Cessation'\n* 'Shoe Insoles'\n* 'Safety Clothing'\n* 'Pet Foods'\n* 'Paper Products'\n* 'OTC Pet Meds'\n* 'OTC Medication'\n* 'Oral Care Products'\n* 'Non-Motorized Boats'\n* 'Non Taxable Product'\n* 'Mobility Equipment'\n* 'Medicated Personal Care Items'\n* 'Infant Clothing'\n* 'Helmets'\n* 'Handkerchiefs'\n* 'Generic Taxable Product'\n* 'General Grocery Items'\n* 'General Clothing'\n* 'Fluoride Toothpaste'\n* 'Feminine Hygiene Products'\n* 'Durable Medical Equipment'\n* 'Drinks under 50 Percent Juice'\n* 'Disposable Wipes'\n* 'Disposable Infant Diapers'\n* 'Dietary Supplements'\n* 'Diabetic Supplies'\n* 'Costumes'\n* 'Contraceptives'\n* 'Contact Lens Solution'\n* 'Carbonated Soft Drinks'\n* 'Car Seats'\n* 'Candy with Flour'\n* 'Candy'\n* 'Breast Pumps'\n* 'Braces and Supports'\n* 'Bottled Water Plain'\n* 'Beverages with 51 to 99 Percent Juice'\n* 'Bathing Suits'\n* 'Bandages and First Aid Kits'\n* 'Baby Supplies'\n* 'Athletic Clothing'\n* 'Adult Diapers'", "15-1": "Jet's standard code for the tax properties of a given product.", "14-2": "Maximum 2000 characters", "16-0": "**msrp** \n\n*float*", "16-2": "A number >= 0.01", "16-1": "The manufacturer's suggested retail price or list price for the product", "17-0": "**alternate_images**\n\n*alternate_images object*", "17-1": "Any additional images you would like to include for the product", "1-0": "**category_path**\n\n*string*", "1-1": "The category path for where this product is located in your categorization structure\n\ne.g. A laptop bag might belong in Electronics/Computers/Laptops/Accessories/Bags in your product's category" }, "cols": 3, "rows": 18 } [/block] **alternate_images** - The following fields are a part of the alternate_images object [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**image_slot_id**\n\n*integer*", "0-1": "The slot that the alternate image should be uploaded to. Jet.com supports up to 8 images (or 8 image slots).", "0-2": "* 1 to 8\n* Required if alternate images array is provided\n* Image slots cannot be duplicated", "1-0": "**image_url** \n\n*string*", "1-1": "URL location where Jet.com can access the image. The images should be 1500 x 1500 pixels or larger, but anything 500 x 500 pixels or larger is acceptable. There is no limit to image size.\n\n* the only unsupported image file formats are multi-layer png and gif.\n* all images' areas must be at least 40000 pixels (ie 200x200)\n* one side must be at least 100 pixels", "1-2": "* A valid image URL. Jet.com will not be able to accept broken image links, or \"no image\" images.\n* Required if alternate images array is provided" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Examples request bodies", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n\"product_title\": \"My Product\",\n\"jet_browse_node_id\": 1000001,\n\"standard_product_codes\": [\n {\n \"standard_product_code\": \"123456789012\",\n \"standard_product_code_type\": \"UPC\"\n }\n],\n\"multipack_quantity\": 6,\n\"brand\": \"My Product's Brand\",\n\"manufacturer\": \"My Product's Manufacturer\",\n\"mfr_part_number\": \"AB-9874\",\n\"product_description\": \"This is a terrific product that everyone should own.\",\n\"bullets\": [\n \"This is bullet line 1\",\n \"This is bullet line 2\"\n],\n\"number_units_for_price_per_unit\": 1,\n\"type_of_unit_for_price_per_unit\": \"each\",\n\"shipping_weight_pounds\": 10,\n\"package_length_inches\": 12,\n\"package_width_inches\": 12,\n\"package_height_inches\": 12,\n\"display_length_inches\": 15,\n\"display_width_inches\": 12,\n\"display_height_inches\": 14,\n\"prop_65\": true,\n\"legal_disclaimer_description\": \"Legal stuff goes here\",\n\"cpsia_cautionary_statements\": [\n \"choking hazard balloon\",\n \"choking hazard small parts\"\n],\n\"country_of_origin\": \"U.S.A.\",\n\"safety_warning\": \"warning text goes here\",\n\"msrp\": 6.99,\n\"map_price\": 6.49,\n\"map_implementation\": \"102\",\n\"product_tax_code\": \"Generic Taxable Product\",\n\"attributes_node_specific\": [\n {\n \"attribute_id\": 95,\n \"attribute_value\": \"80\",\n \"attribute_value_unit\": \"Count\"\n },\n {\n \"attribute_id\": 119,\n \"attribute_value\": \"Aqua\"\n },\n {\n \"attribute_id\": 2,\n \"attribute_value\": \"Blue\"\n }\n],\n\"main_image_url\": \"http://www.mydomain.com/images/myImage.png\",\n\"swatch_image_url\": \"http://www.mydomain.com/images/myImage.png\",\n\"alternate_images\": [\n {\n \"image_slot_id\": 1,\n \"image_url\": \"http://www.mydomain.com/images/myImage.png\"\n },\n {\n \"image_slot_id\": 2,\n \"image_url\": \"http://www.mydomain.com/images/myImage.png\"\n }\n]\n}", "language": "json", "name": "All fields" }, { "code": "{\n\"product_title\": \"My Product\",\n\"standard_product_codes\": // required if ASIN not provided\n [\n {\n \"standard_product_code\": \"123456789012\",\n \"standard_product_code_type\": \"UPC\"\n }\n],\n\"multipack_quantity\": 6,\n\"ASIN\":\"12345ABCDE\" //required if standard product codes array not provided\n}", "language": "json", "name": "Required Fields" }, { "code": "{\n\"product_title\": \"My Product\",\n\"jet_browse_node_id\": 1000001,\n\"standard_product_codes\": [\n {\n \"standard_product_code\": \"123456789012\",\n \"standard_product_code_type\": \"UPC\"\n }\n],\n\"multipack_quantity\": 6,\n\"brand\": \"My Product's Brand\",\n\"manufacturer\": \"My Product's Manufacturer\",\n\"mfr_part_number\": \"AB-9874\",\n\"product_description\": \"This is a terrific product that everyone should own.\",\n\"bullets\": [\n \"This is bullet line 1\",\n \"This is bullet line 2\"\n],\n\n\"shipping_weight_pounds\": 10,\n\"map_price\": 6.49,\n\"map_implementation\": \"102\",\n\"product_tax_code\": \"General Taxable Product\",\n\"attributes_node_specific\": [\n {\n \"attribute_id\": 95,\n \"attribute_value\": \"80\",\n \"attribute_value_unit\": \"count\"\n },\n {\n \"attribute_id\": 119,\n \"attribute_value\": \"aqua\"\n },\n {\n \"attribute_id\": 2,\n \"attribute_value\": \"blue\"\n }\n],\n\"main_image_url\": \"http://www.mydomain.com/images/myImage.png\"\n}", "language": "json", "name": "Required and Recommended Fields" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


[block:callout] { "type": "info", "title": "user_defined_sku_id acceptable characters", "body": "The user_defined_sku_id should be between one (inclusive) and 64 characters (exclusive).\n\nSpecial characters outside the ASCII character set are acceptable but will later need to be encoded in accordance with UTF-8 for retrieval of these SKUs' information, as in the following case: \n\nGET https://merchant-api.jet.com/api/merchant-skus?sku={test/special*characters}" } [/block] [block:api-header] { "type": "basic", "title": "Request Body" } [/block] ## Required Data Jet.com maps all product offers to a universal catalog using the following data: [block:parameters] { "data": { "h-0": "Field", "h-2": "Validation", "h-1": "Description", "h-4": "Defined By", "1-0": "**multipack_quantity***\n\n*integer*", "1-1": "Number of items with the given Standard Product Code that makes up your merchant SKU (product offer).", "1-4": "Merchant", "2-2": "Required if ASIN not provided", "2-0": "**standard_product_codes**\n\n*standard_product_codes object array*", "2-1": "This is an array of product codes. Please see our product code array table below.", "2-4": "Merchant", "3-0": "**ASIN** \n\n*string*", "3-1": "Amazon standard identification number for this merchant SKU if available.", "3-2": "Required if standard_product_codes not provided\nAlphanumeric\nlength of 10", "3-4": "Merchant", "0-0": "**product_title***\n\n*string*", "0-2": "5 to 500 characters", "0-1": "The title of a given merchant sku.", "h-5": "Required", "0-5": "Yes", "1-5": "Yes", "2-5": "Required if ASIN not provided", "3-5": "Required if standard product codes not provided", "1-2": "1 to 128", "4-0": "**brand***\n\n*string*", "4-1": "The brand for your merchant SKU", "4-2": "1 to 100 characters", "5-0": "**main_image_url***\n\n*string*", "5-1": "URL location where Jet.com can access the image. The images should be 40,000 pixels or larger, There is no limit to image size.\n\n* the only unsupported image file formats are multi-layer png and gif.\n* all images' areas must be at least 40000 pixels (ie 200x200)\n* one side must be at least 100 pixels", "5-2": "A valid image URL. Jet.com will not be able to accept broken image links, or \"no image\" images." }, "cols": 3, "rows": 6 } [/block] [block:callout] { "type": "warning", "title": "Image Processing Failures", "body": "In some cases, Jet's API may accept a valid image URL only to find that processing will fail downstream. Our image processor may fail to process the following kinds of images:\n* Images with a \"No Image Available\" message\n* Blank Images\n* Logos\n* Watermarked Images" } [/block] [block:callout] { "type": "warning", "title": "Using ASIN as an Identifier", "body": "If you are sending an ASIN as a unique product identifier, please include the actual ASIN, not the parent ASIN." } [/block] [block:callout] { "type": "danger", "title": "Multipack Quantity Errors", "body": "Multipack quantity is NOT the same as product count. As a rule of thumb, multipack quantity is the number of barcodes that make up your product offer." } [/block] **standard_product_codes object** - The following fields are part of the standard_product_codes object: [block:parameters] { "data": { "0-0": "**standard_product_code_type** \n\n*string*", "h-0": "Field", "h-2": "Validation", "h-1": "Description", "0-2": "Must be one of the following values:\n* GTIN-14\n* EAN\n* ISBN-10\n* ISBN-13\n* UPC", "1-2": "If standard product code = \n * 'GTIN-14' - 14 digits\n * 'EAN' - 13 digits\n * 'ISBN-10' - 10 digits\n * 'ISBN-13' - 13 digits \n * 'UPC'- 12 digits", "1-0": "**standard_product_code** \n\n*string*", "0-1": "The type of standard product code that is being provided", "1-1": "The standard product code associated with the type provided" }, "cols": 3, "rows": 2 } [/block] ## Minimum Listing Data On Jet.com, product offers across merchants are mapped to a universal product listing. Jet chooses the best pieces from each listing to create a unified listing. If a product offer matches to an existing product in our catalog, the retailer may need to provide little to no additional information than what is expected above. If the product is not available already, the fields below may be required. [block:parameters] { "data": { "h-0": "Field", "h-2": "Validation", "1-0": "**manufacturer** \n\n*string*", "h-1": "Description", "h-4": "Defined By:", "1-2": "1 to 100 characters", "1-1": "Manufacturer of the merchant SKU.", "1-4": "Merchant", "3-0": "**bullets**\n\n*string array*", "3-1": "Merchant SKU feature description. Jet currently allows for up to 5 bullets.", "3-2": "1 to 500 characters\nMax 5 strings", "3-4": "Merchant", "4-4": "Merchant", "5-4": "Merchant", "6-4": "Merchant", "0-0": "**product_description** \n\n*string*", "0-2": "1 to 2000 characters", "2-0": "**mfr_part_number** \n\n*string*", "2-2": "1 to 50 characters", "2-1": "Part number provided by the original manufacturer of the merchant SKU.", "2-4": "Merchant", "4-0": "**shipping_weight_pounds** \n\n*float*", "4-2": "Must be >= 0.01", "4-1": "Weight of the merchant SKU when in its shippable configuration.", "5-0": "**map_price** \n\n*float*", "5-2": "Must be >= 0.01", "6-1": "Price policy rule that determines allowed item pricing and Jet member savings shown to the consumer. Please note that this field name is misleading as it is used for all price policies and not just a MAP policy. These settings only apply to what the consumer is shown and have no impact on what a retailer is paid for an item.\n\n'101' = no restrictions on displayed product pricing or Jet member savings on the product. This setting is the normal setting used for most products.\n\n'102' = Jet member savings for the product are never advertised and are only visible to logged in Jet members after they specifically request to reveal savings. This value can be used when complying with a manufacturer's Minimum Advertised Price (MAP) policy. The API map_price field must also be used when using this setting as it is needed to display a price for advertising and initial presentation to the consumer. \n\n'103' = Jet member savings never applied to product and product orders never awarded to retailer if Jet item price is below item price sent by retailer. This value can be used when complying with a manufacturer's Unilateral Minimum Retail Price Policy. This policy setting will restrict the ability to win an order for a product if the retailer item price sent is above Jet's item price shown to the consumer.", "5-1": "Minimum Advertised Price (MAP) for the product. This price is used as the display or reference price when price policy value 102 is used via the map_implementation field.", "6-0": "**map_implementation** \n\n*string*", "6-2": "Must be one of the following values:\n* 103\n* 102\n* 101", "h-5": "Required", "4-5": "Required if shipping rates for fulfillment nodes are set up \"per pound\"", "5-5": "Required if map_implementation field = '102'", "7-0": "**jet_browse_node_id** \n\n*integer*", "7-1": "The unique ID that defines where the product will be found in the Jet.com browse structure. This can be found using the Jet Taxonomy API.", "7-2": "This must be a valid jet_browse_node_id. Note: Beginning May 29, 2017, the \"jet_browse_node_id\" uploaded in a merchant SKU payload must be a real node in the Jet taxonomy. The field will remain optional.", "8-0": "**attributes_node_specific**\n\n*attributes_node_specific array*", "8-1": "Attributes associated with the category provided", "8-2": "Minimum 1 attributes_node_specific object required if this field is provided Maximum 50 attributes_node_specific object required if this field is provided" }, "cols": 3, "rows": 9 } [/block] **attributes_node_specific** - The following fields are a part of the attributes_node_specific object [block:parameters] { "data": { "h-0": "Field", "h-2": "Validation", "h-1": "Description", "0-0": "**attribute_id** \n\n*int64*", "0-1": "The node attribute ID number that you get from the [Jet Taxonomy](https://www.dropbox.com/s/18wn56zutquey8m/Jet_Taxonomy.xlsx?dl=0) that corresponds with the attribute you are passing.", "1-0": "**attribute_value**\n\n*string*", "0-2": "Must be > 0", "2-0": "**attribute_value_unit**\n\n*string*", "1-1": "The value for the attribute. For example, if the attribute is size you may pass 'large' or if the the attribute is weight, you may pass '22'. For attributes like weight the unit will be passed in the next field.", "2-1": "If the attribute_value requires a unit, then you pass the unit here.", "1-2": "Must have a length between 1 and 100\nCannot be an image URL" }, "cols": 3, "rows": 3 } [/block] [block:callout] { "type": "warning", "title": "Size Attribute: Clothing", "body": "The size attribute is required for all clothing SKUs. The size attribute may depend on category." } [/block] ## Additional Fields The fields listed below are encouraged to be used when adding a sku to Jet.com. The unified catalog that Jet may need this data to list your product. [block:parameters] { "data": { "h-0": "Field", "h-2": "Validation", "h-1": "Description", "h-4": "Defined By", "0-0": "**amazon_item_type_keyword** \n\n*string*", "0-2": "", "0-1": "ItemType allows customers to find your products as they browse to the most specific item types.", "2-0": "**number_units_for_price_per_unit** \n\n*integer*", "2-2": "", "2-1": "For Price Per Unit calculations, the number of units included in the merchant SKU. The unit of measure must be specified in order to indicate what is being measured by the unit-count.", "3-0": "**type_of_unit_for_price_per_unit** \n\n*string*", "3-1": "The type_of_unit_for_price_per_unit attribute is a label for the number_units_for_price_per_unit. The price per unit can then be constructed by dividing the selling price by the number of units and appending the text \"per unit value.\" For example, for a six-pack of soda, number_units_for_price_per_unit= 6, type_of_unit_for_price_per_unit= can, price per unit = price per can.", "4-0": "**package_length_inches** \n\n*float*", "4-2": "A number >= 0.01", "4-1": "Length of the merchant SKU when in its shippable configuration.", "5-0": "**package_width_inches** \n\n*float*", "5-2": "A number >= 0.01", "5-1": "Width of the merchant SKU when in its shippable configuration.", "6-0": "**package_height_inches** \n\n*float*", "6-1": "Height of the merchant SKU when in its shippable configuration.", "6-2": "A number >= 0.01", "7-0": "**display_length_inches** \n\n*float*", "7-2": "A number >= 0.01", "8-0": "**display_width_inches** \n\n*float*", "7-1": "Length of the merchant SKU when in its fully assembled/usable condition.", "8-2": "A number >= 0.01", "9-0": "**display_height_inches** \n\n*float*", "9-2": "A number >= 0.01", "9-1": "Height of the merchant SKU when in its fully assembled/usable condition.", "8-1": "Width of the merchant SKU when in its fully assembled/usable condition.", "10-0": "**prop_65** \n\n*boolean*", "10-1": "You must tell us if your product is subject to Proposition 65 rules and regulations. Proposition 65 requires merchants to provide California consumers with special warnings for products that contain chemicals known to cause cancer, birth defects, or other reproductive harm, if those products expose consumers to such materials above certain threshold levels. The default value for this is \"false,\" so if you do not populate this column, we will assume your product is not subject to this rule. Please view this website for more information: http://www.oehha.ca.gov/.", "10-2": "", "11-0": "**legal_disclaimer_description** \n\n*string*", "11-1": "Any legal language required to be displayed with the product.", "12-0": "**cpsia_cautionary_statements **\n\n*string array*", "12-1": "Use this field to indicate if a cautionary statement relating to the choking hazards of children's toys and games applies to your product. These cautionary statements are defined in Section 24 of the Federal Hazardous Substances Act and Section 105 of the Consumer Product Safety Improvement Act of 2008. They must be displayed on the product packaging and in certain online and catalog advertisements. You are responsible for determining if a cautionary statement applies to the product. This can be verified by contacting the product manufacturer or checking the product packaging. Cautionary statements that you select will be displayed on the product detail page. If no cautionary statement applies to the product, select \"no warning applicable\".", "12-2": "Must be one of the following values:\n* no warning applicable\n* choking hazard small parts\n* choking hazard is a small ball\n* choking hazard is a marble\n* choking hazard contains a small ball\n* choking hazard contains a marble\n* choking hazard balloon\n\nCannot have 'no warning applicable' and another reason submitted together", "13-0": "**country_of_origin** \n\n*string*", "13-1": "The country that the item was manufactured in.", "14-0": "**safety_warning** \n\n*string*", "13-2": "Maximum 50 characters", "14-1": "If applicable, use to supply any associated warnings for your product.", "15-0": "**product_tax_code** \n\n*string*", "15-2": "Must be one of the following values:\n* 'Toilet Paper'\n* 'Thermometers'\n* 'Sweatbands'\n* 'SPF Suncare Products'\n* 'Sparkling Water'\n* 'Smoking Cessation'\n* 'Shoe Insoles'\n* 'Safety Clothing'\n* 'Pet Foods'\n* 'Paper Products'\n* 'OTC Pet Meds'\n* 'OTC Medication'\n* 'Oral Care Products'\n* 'Non-Motorized Boats'\n* 'Non Taxable Product'\n* 'Mobility Equipment'\n* 'Medicated Personal Care Items'\n* 'Infant Clothing'\n* 'Helmets'\n* 'Handkerchiefs'\n* 'Generic Taxable Product'\n* 'General Grocery Items'\n* 'General Clothing'\n* 'Fluoride Toothpaste'\n* 'Feminine Hygiene Products'\n* 'Durable Medical Equipment'\n* 'Drinks under 50 Percent Juice'\n* 'Disposable Wipes'\n* 'Disposable Infant Diapers'\n* 'Dietary Supplements'\n* 'Diabetic Supplies'\n* 'Costumes'\n* 'Contraceptives'\n* 'Contact Lens Solution'\n* 'Carbonated Soft Drinks'\n* 'Car Seats'\n* 'Candy with Flour'\n* 'Candy'\n* 'Breast Pumps'\n* 'Braces and Supports'\n* 'Bottled Water Plain'\n* 'Beverages with 51 to 99 Percent Juice'\n* 'Bathing Suits'\n* 'Bandages and First Aid Kits'\n* 'Baby Supplies'\n* 'Athletic Clothing'\n* 'Adult Diapers'", "15-1": "Jet's standard code for the tax properties of a given product.", "14-2": "Maximum 2000 characters", "16-0": "**msrp** \n\n*float*", "16-2": "A number >= 0.01", "16-1": "The manufacturer's suggested retail price or list price for the product", "17-0": "**alternate_images**\n\n*alternate_images object*", "17-1": "Any additional images you would like to include for the product", "1-0": "**category_path**\n\n*string*", "1-1": "The category path for where this product is located in your categorization structure\n\ne.g. A laptop bag might belong in Electronics/Computers/Laptops/Accessories/Bags in your product's category" }, "cols": 3, "rows": 18 } [/block] **alternate_images** - The following fields are a part of the alternate_images object [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**image_slot_id**\n\n*integer*", "0-1": "The slot that the alternate image should be uploaded to. Jet.com supports up to 8 images (or 8 image slots).", "0-2": "* 1 to 8\n* Required if alternate images array is provided\n* Image slots cannot be duplicated", "1-0": "**image_url** \n\n*string*", "1-1": "URL location where Jet.com can access the image. The images should be 1500 x 1500 pixels or larger, but anything 500 x 500 pixels or larger is acceptable. There is no limit to image size.\n\n* the only unsupported image file formats are multi-layer png and gif.\n* all images' areas must be at least 40000 pixels (ie 200x200)\n* one side must be at least 100 pixels", "1-2": "* A valid image URL. Jet.com will not be able to accept broken image links, or \"no image\" images.\n* Required if alternate images array is provided" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Examples request bodies", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n\"product_title\": \"My Product\",\n\"jet_browse_node_id\": 1000001,\n\"standard_product_codes\": [\n {\n \"standard_product_code\": \"123456789012\",\n \"standard_product_code_type\": \"UPC\"\n }\n],\n\"multipack_quantity\": 6,\n\"brand\": \"My Product's Brand\",\n\"manufacturer\": \"My Product's Manufacturer\",\n\"mfr_part_number\": \"AB-9874\",\n\"product_description\": \"This is a terrific product that everyone should own.\",\n\"bullets\": [\n \"This is bullet line 1\",\n \"This is bullet line 2\"\n],\n\"number_units_for_price_per_unit\": 1,\n\"type_of_unit_for_price_per_unit\": \"each\",\n\"shipping_weight_pounds\": 10,\n\"package_length_inches\": 12,\n\"package_width_inches\": 12,\n\"package_height_inches\": 12,\n\"display_length_inches\": 15,\n\"display_width_inches\": 12,\n\"display_height_inches\": 14,\n\"prop_65\": true,\n\"legal_disclaimer_description\": \"Legal stuff goes here\",\n\"cpsia_cautionary_statements\": [\n \"choking hazard balloon\",\n \"choking hazard small parts\"\n],\n\"country_of_origin\": \"U.S.A.\",\n\"safety_warning\": \"warning text goes here\",\n\"msrp\": 6.99,\n\"map_price\": 6.49,\n\"map_implementation\": \"102\",\n\"product_tax_code\": \"Generic Taxable Product\",\n\"attributes_node_specific\": [\n {\n \"attribute_id\": 95,\n \"attribute_value\": \"80\",\n \"attribute_value_unit\": \"Count\"\n },\n {\n \"attribute_id\": 119,\n \"attribute_value\": \"Aqua\"\n },\n {\n \"attribute_id\": 2,\n \"attribute_value\": \"Blue\"\n }\n],\n\"main_image_url\": \"http://www.mydomain.com/images/myImage.png\",\n\"swatch_image_url\": \"http://www.mydomain.com/images/myImage.png\",\n\"alternate_images\": [\n {\n \"image_slot_id\": 1,\n \"image_url\": \"http://www.mydomain.com/images/myImage.png\"\n },\n {\n \"image_slot_id\": 2,\n \"image_url\": \"http://www.mydomain.com/images/myImage.png\"\n }\n]\n}", "language": "json", "name": "All fields" }, { "code": "{\n\"product_title\": \"My Product\",\n\"standard_product_codes\": // required if ASIN not provided\n [\n {\n \"standard_product_code\": \"123456789012\",\n \"standard_product_code_type\": \"UPC\"\n }\n],\n\"multipack_quantity\": 6,\n\"ASIN\":\"12345ABCDE\" //required if standard product codes array not provided\n}", "language": "json", "name": "Required Fields" }, { "code": "{\n\"product_title\": \"My Product\",\n\"jet_browse_node_id\": 1000001,\n\"standard_product_codes\": [\n {\n \"standard_product_code\": \"123456789012\",\n \"standard_product_code_type\": \"UPC\"\n }\n],\n\"multipack_quantity\": 6,\n\"brand\": \"My Product's Brand\",\n\"manufacturer\": \"My Product's Manufacturer\",\n\"mfr_part_number\": \"AB-9874\",\n\"product_description\": \"This is a terrific product that everyone should own.\",\n\"bullets\": [\n \"This is bullet line 1\",\n \"This is bullet line 2\"\n],\n\n\"shipping_weight_pounds\": 10,\n\"map_price\": 6.49,\n\"map_implementation\": \"102\",\n\"product_tax_code\": \"General Taxable Product\",\n\"attributes_node_specific\": [\n {\n \"attribute_id\": 95,\n \"attribute_value\": \"80\",\n \"attribute_value_unit\": \"count\"\n },\n {\n \"attribute_id\": 119,\n \"attribute_value\": \"aqua\"\n },\n {\n \"attribute_id\": 2,\n \"attribute_value\": \"blue\"\n }\n],\n\"main_image_url\": \"http://www.mydomain.com/images/myImage.png\"\n}", "language": "json", "name": "Required and Recommended Fields" } ], "sidebar": true } [/block]
{"_id":"56fd2bf327b4321900186edc","__v":1,"editedParams":true,"githubsync":"","order":6,"parentDoc":null,"user":"562e25d24376430d006f1769","version":"56fd2bf327b4321900186ec6","createdAt":"2015-11-30T22:08:31.906Z","next":{"description":"","pages":[]},"slug":"creating-a-returns-exception","sync_unique":"","title":"Returns Exception","editedParams2":true,"excerpt":"","isReference":false,"link_external":false,"project":"562e25f2e01a430d00c2c91e","updates":[],"api":{"url":"/merchant-skus/{user_defined_sku_id}/returnsexception","auth":"required","examples":{"codes":[]},"method":"put","params":[{"_id":"5829e5ae286d1f0f005104f8","ref":"","in":"path","required":true,"desc":"The identifier you used to track and update your merchant SKU.","default":"","type":"string","name":"user_defined_sku_id"}],"results":{"codes":[{"status":204,"code":"","language":"json"}]},"settings":""},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request Body\"\n}\n[/block]\nThe returns exceptions call is used to set up specific methods that will overwrite your default settings on a fulfillment node level for returns. This exception will be used to determine how and to where a product is returned unless the merchant specifies otherwise in the Ship Order message. \n\nThe fields for returns exceptions are outlined below:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"**return_location_ids**\\n\\n*string array*\",\n    \"0-1\": \"The ID of the returns node that was created on partner.jet.com under fulfillment settings.\",\n    \"0-3\": \"\",\n    \"h-4\": \"Required\",\n    \"0-2\": \"Must be a valid return node ID set up by the merchant\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use Cases\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Example request bodies\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"return_location_ids\\\": [\\n    \\\"9046335c27d146ee94b23ef61d8959bc\\\",\\n    \\\"e3100213167d4abaa43a1c1dd6e4dc04\\\"\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Mixed Example\"\n    },\n    {\n      \"code\": \"{\\n  \\\"return_location_ids\\\": [\\n    \\\"9046335c27d146ee94b23ef61d8959bc\\\",\\n    \\\"e3100213167d4abaa43a1c1dd6e4dc04\\\"\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Only Return Locations\"\n    },\n    {\n      \"code\": \"{}\",\n      \"language\": \"json\",\n      \"name\": \"Clear Returns Exception\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"56fd2bf327b4321900186ec9","hidden":false,"link_url":"","type":"put","childrenPages":[]}

putReturns Exception


Path Params

user_defined_sku_id:
required
string
The identifier you used to track and update your merchant SKU.
[block:api-header] { "type": "basic", "title": "Request Body" } [/block] The returns exceptions call is used to set up specific methods that will overwrite your default settings on a fulfillment node level for returns. This exception will be used to determine how and to where a product is returned unless the merchant specifies otherwise in the Ship Order message. The fields for returns exceptions are outlined below: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**return_location_ids**\n\n*string array*", "0-1": "The ID of the returns node that was created on partner.jet.com under fulfillment settings.", "0-3": "", "h-4": "Required", "0-2": "Must be a valid return node ID set up by the merchant" }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Example request bodies", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"return_location_ids\": [\n \"9046335c27d146ee94b23ef61d8959bc\",\n \"e3100213167d4abaa43a1c1dd6e4dc04\"\n ]\n}", "language": "json", "name": "Mixed Example" }, { "code": "{\n \"return_location_ids\": [\n \"9046335c27d146ee94b23ef61d8959bc\",\n \"e3100213167d4abaa43a1c1dd6e4dc04\"\n ]\n}", "language": "json", "name": "Only Return Locations" }, { "code": "{}", "language": "json", "name": "Clear Returns Exception" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


[block:api-header] { "type": "basic", "title": "Request Body" } [/block] The returns exceptions call is used to set up specific methods that will overwrite your default settings on a fulfillment node level for returns. This exception will be used to determine how and to where a product is returned unless the merchant specifies otherwise in the Ship Order message. The fields for returns exceptions are outlined below: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**return_location_ids**\n\n*string array*", "0-1": "The ID of the returns node that was created on partner.jet.com under fulfillment settings.", "0-3": "", "h-4": "Required", "0-2": "Must be a valid return node ID set up by the merchant" }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Example request bodies", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"return_location_ids\": [\n \"9046335c27d146ee94b23ef61d8959bc\",\n \"e3100213167d4abaa43a1c1dd6e4dc04\"\n ]\n}", "language": "json", "name": "Mixed Example" }, { "code": "{\n \"return_location_ids\": [\n \"9046335c27d146ee94b23ef61d8959bc\",\n \"e3100213167d4abaa43a1c1dd6e4dc04\"\n ]\n}", "language": "json", "name": "Only Return Locations" }, { "code": "{}", "language": "json", "name": "Clear Returns Exception" } ], "sidebar": true } [/block]
{"_id":"56fd2bf327b4321900186edd","__v":1,"link_url":"","slug":"merchant-sku-archive","editedParams":true,"excerpt":"","isReference":false,"next":{"description":"","pages":[]},"sync_unique":"","version":"56fd2bf327b4321900186ec6","body":"Archiving a SKU allows the retailer to \"deactivate\" a SKU from the catalog.  At any point in time, a retailer may decide to \"reactivate\" the SKU\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request Body\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Updates to an 'Archived' SKU\",\n  \"body\": \"All SKU updates (price, inventory, etc.) will be ignored for this SKU until the SKU is unarchived.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Inventory\",\n  \"body\": \"Any outstanding inventory attached to a SKU when archived or unarchived is zeroed out.  If the SKU is reactivated, the merchant will need to provide inventory for this SKU.\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**is_archived***\\n\\n*boolean*\",\n    \"0-1\": \"Indicates whether the specified SKU is archived.\\n\\n* 'true' - SKU is inactive\\n* 'false' - SKU is potentially sellable\",\n    \"0-2\": \"Must be one of the following values:\\n* true\\n* false\",\n    \"0-3\": \"\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"h-4\": \"Required\",\n    \"0-4\": \"Yes\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\\* denotes the field is required\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use Cases\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Example request bodies\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"is_archived\\\": true\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Archive SKU\"\n    },\n    {\n      \"code\": \"{\\n  \\\"is_archived\\\": false\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Unarchive SKU\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"56fd2bf327b4321900186ec9","createdAt":"2015-10-29T00:21:31.506Z","editedParams2":true,"hidden":false,"order":7,"parentDoc":null,"project":"562e25f2e01a430d00c2c91e","title":"Archive SKU","type":"put","updates":[],"user":"562e25d24376430d006f1769","api":{"url":"/merchant-skus/{user_defined_sku_id}/status/archive","auth":"required","examples":{"codes":[]},"method":"put","params":[{"ref":"","in":"path","required":false,"desc":"The identifier you used to track and update your merchant SKU.","default":"","type":"string","name":"user_defined_sku_id","_id":"5829e5cb6a1d1f0f00b94516"}],"results":{"codes":[{"code":"","language":"json","status":204}]},"settings":""},"githubsync":"","link_external":false,"childrenPages":[]}

putArchive SKU


Path Params

user_defined_sku_id:
string
The identifier you used to track and update your merchant SKU.
Archiving a SKU allows the retailer to "deactivate" a SKU from the catalog. At any point in time, a retailer may decide to "reactivate" the SKU [block:api-header] { "type": "basic", "title": "Request Body" } [/block] [block:callout] { "type": "info", "title": "Updates to an 'Archived' SKU", "body": "All SKU updates (price, inventory, etc.) will be ignored for this SKU until the SKU is unarchived." } [/block] [block:callout] { "type": "danger", "title": "Inventory", "body": "Any outstanding inventory attached to a SKU when archived or unarchived is zeroed out. If the SKU is reactivated, the merchant will need to provide inventory for this SKU." } [/block] [block:parameters] { "data": { "0-0": "**is_archived***\n\n*boolean*", "0-1": "Indicates whether the specified SKU is archived.\n\n* 'true' - SKU is inactive\n* 'false' - SKU is potentially sellable", "0-2": "Must be one of the following values:\n* true\n* false", "0-3": "", "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "h-4": "Required", "0-4": "Yes" }, "cols": 3, "rows": 1 } [/block] \* denotes the field is required [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Example request bodies", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"is_archived\": true\n}", "language": "json", "name": "Archive SKU" }, { "code": "{\n \"is_archived\": false\n}", "language": "json", "name": "Unarchive SKU" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Archiving a SKU allows the retailer to "deactivate" a SKU from the catalog. At any point in time, a retailer may decide to "reactivate" the SKU [block:api-header] { "type": "basic", "title": "Request Body" } [/block] [block:callout] { "type": "info", "title": "Updates to an 'Archived' SKU", "body": "All SKU updates (price, inventory, etc.) will be ignored for this SKU until the SKU is unarchived." } [/block] [block:callout] { "type": "danger", "title": "Inventory", "body": "Any outstanding inventory attached to a SKU when archived or unarchived is zeroed out. If the SKU is reactivated, the merchant will need to provide inventory for this SKU." } [/block] [block:parameters] { "data": { "0-0": "**is_archived***\n\n*boolean*", "0-1": "Indicates whether the specified SKU is archived.\n\n* 'true' - SKU is inactive\n* 'false' - SKU is potentially sellable", "0-2": "Must be one of the following values:\n* true\n* false", "0-3": "", "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "h-4": "Required", "0-4": "Yes" }, "cols": 3, "rows": 1 } [/block] \* denotes the field is required [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Example request bodies", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"is_archived\": true\n}", "language": "json", "name": "Archive SKU" }, { "code": "{\n \"is_archived\": false\n}", "language": "json", "name": "Unarchive SKU" } ], "sidebar": true } [/block]
{"_id":"56fd2bf327b4321900186ee3","link_external":false,"project":"562e25f2e01a430d00c2c91e","excerpt":"","githubsync":"","hidden":false,"sync_unique":"","title":"Single SKU Retrieval","__v":1,"editedParams":true,"link_url":"","isReference":false,"next":{"description":"","pages":[]},"parentDoc":null,"type":"get","version":"56fd2bf327b4321900186ec6","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"desc":"The previously created ID you will use to track and update your Merchant SKU","default":"","type":"string","name":"{user_defined_sku_id}","in":"query","_id":"562e8e1419e7b40d00b7c723","ref":"","required":false}],"results":{"codes":[{"status":200,"code":"{\n\"status\":\"Available for Purchase\",\n\"product_title\": \"My Product\",\n\"jet_browse_node_id\": 1000001,\n\"standard_product_codes\": [\n  {\n  \"standard_product_code\": \"123456789012\",\n  \"standard_product_code_type\": \"UPC\"\n  }\n],\n\"multipack_quantity\": 6,\n\"brand\": \"My Product's Brand\",\n\"manufacturer\": \"My Product's Manufacturer\",\n\"mfr_part_number\": \"AB-9874\",\n\"product_description\": \"This is a terrific product that everyone should own.\",\n\"bullets\": [\n  \"This is bullet line 1\",\n  \"This is bullet line 2\"\n],\n\"number_units_for_price_per_unit\": 1,\n\"type_of_unit_for_price_per_unit\": \"each\",\n\"shipping_weight_pounds\": 10,\n\"package_length_inches\": 12,\n\"package_width_inches\": 12,\n\"package_height_inches\": 12,\n\"display_length_inches\": 15,\n\"display_width_inches\": 12,\n\"display_height_inches\": 14,\n\"prop_65\": true,\n\"legal_disclaimer_description\": \"Legal stuff goes here\",\n\"cpsia_cautionary_statements\": [\n  \"choking hazard balloon\",\n  \"choking hazard small parts\"\n],\n\"country_of_origin\": \"U.S.A.\",\n\"safety_warning\": \"warning text goes here\",\n\"fulfillment_time\": 1,\n\"msrp\": 6.99,\n\"map_price\": 6.49,\n\"map_implementation\": \"101\",\n\"product_tax_code\": \"123\",\n\"no_return_fee_adjustment\": 0.01,\n\"exclude_from_fee_adjustments\": false,\n\"ships_alone\": false,\n\"attributes_node_specific\": [\n  {\n  \"attribute_id\": 95,\n  \"attribute_value\": \"80\",\n  \"attribute_value_unit\": \"count\"\n  },\n  {\n  \"attribute_id\": 119,\n  \"attribute_value\": \"aqua\"\n  },\n  {\n  \"attribute_id\": 2,\n  \"attribute_value\": \"blue\"\n  }\n],\n\"main_image_url\": \"http://www.mydomain.com/images/myImage.png\",\n\"swatch_image_url\": \"http://www.mydomain.com/images/myImage.png\",\n\"alternate_images\": [\n  {\n  \"image_slot_id\": 1,\n  \"image_url\": \"http://www.mydomain.com/images/myImage.png\"\n  },\n  {\n  \"image_slot_id\": 2,\n  \"image_url\": \"http://www.mydomain.com/images/myImage.png\"\n  }\n]\n}","language":"json"}]},"settings":"","url":"/merchant-skus/{user_defined_sku_id}"},"body":"Any information about the SKU that was previously uploaded (price, inventory, shipping exception) will show up here.\n\nBeginning May 29, 2017, a GET request to this endpoint will only return information about the merchant SKU (inventory and price information must now be accessed via the appropriate endpoints). As such, the following fields will no longer be returned:\n\n\"inventory_by_fulfillment_node\"\n\"inventory_last_update\"\n\"price\"\n\"price_last_update\"\n\"best_marketplace_offer\"\n\"my_best_offer\"\n\"producer_id\"\n\"merchant_sku_id\"\n\"merchant_id\"\n\"jet_sku\"\n\"correlation_id\"\n\"sales_rank\"\n\"sku_created_date\"\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body: SKU Upload Only\"\n}\n[/block]\nThe following fields are added by Jet in the response body.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**status**\\n\\n*string*\",\n    \"0-1\": \"The status of this merchant SKU in our product pipeline\\n\\nWill be one of the following values:\\n* 'Available For Purchase' - The product is listed on Jet.com and can be purchased by a customer\\n* 'Missing Listing Data' - More data is needed to list the product on Jet.com\\n* 'Under Jet Review' - The SKU is current being processed in Jet's product catalog\\n* 'Unauthorized' - The SKU is not authorized to be sold\\n* 'Excluded' - The SKU is not able to be sold on Jet.com. Please see Partner Policy for more details on SKUs accepted\\n* 'Archived' - The SKU is 'inactive' and is not available for purchase on Jet.com. All updated to this SKU will be ignored.\",\n    \"1-0\": \"**sub_status**\\n\\n*string array*\",\n    \"1-1\": \"Any additional information about the SKU's status.  A product may exist in multiple substatuses at the same time\\n\\nValues with descriptions\\n* Missing variation information\\n* Missing title\\n* Missing shipping weight\\n* Missing price\\n* Missing image\\n* Missing category\\n* Missing brand\\n* Missing attribute value\\n* Invalid SKU identifier\\n* Invalid category - the category provided does not exist or needs to be mapped to a more specific category\\n* Incorrect multipack quantity - based on our matching algorithm, the product offer may have the incorrect multipack quantity\\n* Additional SKU ID needed - we need a UPC, ASIN, GTIN, etc. to identify a SKU\",\n    \"0-2\": \"Must be one of the following values:\\n* Available For Purchase \\n* Missing Listing Data \\n* Under Jet Review \\n* Unauthorized\\n* Excluded\\n* Archived\",\n    \"1-2\": \"Must be one of the following values:\\n* Missing variation information\\n* Missing title\\n* Missing shipping weight\\n* Missing price\\n* Missing image\\n* Missing category\\n* Missing brand\\n* Missing attribute value\\n* Invalid SKU identifier\\n* Invalid category \\n* Incorrect multipack quantity\\n* Additional SKU ID needed\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request Body\"\n}\n[/block]\n##  Required Data\n\nJet.com maps all product offers to a universal catalog using the following data:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-2\": \"Validation\",\n    \"h-1\": \"Description\",\n    \"h-4\": \"Defined By\",\n    \"1-0\": \"**multipack_quantity***\\n\\n*integer*\",\n    \"1-1\": \"Number of items with the given Standard Product Code that makes up your merchant SKU (product offer).\",\n    \"1-4\": \"Merchant\",\n    \"2-2\": \"Required if ASIN not provided\",\n    \"2-0\": \"**standard_product_codes**\\n\\n*standard_product_codes object array*\",\n    \"2-1\": \"This is an array of product codes. Please see our product code array table below.\",\n    \"2-4\": \"Merchant\",\n    \"3-0\": \"**ASIN** \\n\\n*string*\",\n    \"3-1\": \"Amazon standard identification number for this merchant SKU if available.\",\n    \"3-2\": \"Required if standard_product_codes not provided\\nAlphanumeric\\nlength of 10\",\n    \"3-4\": \"Merchant\",\n    \"0-0\": \"**product_title***\\n\\n*string*\",\n    \"0-2\": \"5 to 500 characters\",\n    \"0-1\": \"The title of a given merchant sku.\",\n    \"h-5\": \"Required\",\n    \"0-5\": \"Yes\",\n    \"1-5\": \"Yes\",\n    \"2-5\": \"Required if ASIN not provided\",\n    \"3-5\": \"Required if standard product codes not provided\",\n    \"1-2\": \"1 to 128\",\n    \"4-0\": \"**brand***\\n\\n*string*\",\n    \"4-1\": \"The brand for your merchant SKU\",\n    \"4-2\": \"1 to 100 characters\",\n    \"5-0\": \"**main_image_url***\\n\\n*string*\",\n    \"5-1\": \"URL location where Jet.com can access the image. The images should be 40,000 pixels or larger, There is no limit to image size.\\n\\n* the only unsupported image file formats are multi-layer png and gif.\\n* all images' areas must be at least 40000 pixels (ie 200x200)\\n* one side must be at least 200 pixels; the other side must be at least 100 pixels.\",\n    \"5-2\": \"A valid image URL.  Jet.com will not be able to accept broken image links, or \\\"no image\\\" images.\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Multipack Quantity Errors\",\n  \"body\": \"Multipack quantity is NOT the same as product count.  As a rule of thumb, multipack quantity is the number of barcodes that make up your product offer.\"\n}\n[/block]\n**standard_product_codes object** - The following fields are part of the standard_product_codes object:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**standard_product_code_type** \\n\\n*string*\",\n    \"h-0\": \"Field\",\n    \"h-2\": \"Validation\",\n    \"h-1\": \"Description\",\n    \"0-2\": \"Must be one of the following values:\\n* GTIN-14\\n* EAN\\n* ISBN-10\\n* ISBN-13\\n* UPC\",\n    \"1-2\": \"If standard product code = \\n  * 'GTIN-14' - 14 digits\\n  * 'EAN' -       13 digits\\n  * 'ISBN-10' - 10 digits\\n  * 'ISBN-13' - 13 digits \\n  * 'UPC'-       12 digits\",\n    \"1-0\": \"**standard_product_code** \\n\\n*string*\",\n    \"0-1\": \"The type of standard product code that is being provided\",\n    \"1-1\": \"The standard product code associated with the type provided\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n##  Minimum Listing Data\n\nOn Jet.com, product offers across merchants are mapped to a universal product listing.  Jet chooses the best pieces from each listing to create a unified listing.  If a product offer matches to an existing product in our catalog, the retailer may need to provide little to no additional information than what is expected above.  If the product is not available already, the fields below may be required.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-2\": \"Validation\",\n    \"1-0\": \"**manufacturer** \\n\\n*string*\",\n    \"h-1\": \"Description\",\n    \"h-4\": \"Defined By:\",\n    \"1-2\": \"1 to 100 characters\",\n    \"1-1\": \"Manufacturer of the merchant SKU.\",\n    \"1-4\": \"Merchant\",\n    \"3-0\": \"**bullets**\\n\\n*string array*\",\n    \"3-1\": \"Merchant SKU feature description. Jet currently allows for up to 5 bullets.\",\n    \"3-2\": \"1 to 500 characters\\nMax 5 strings\",\n    \"3-4\": \"Merchant\",\n    \"4-4\": \"Merchant\",\n    \"5-4\": \"Merchant\",\n    \"6-4\": \"Merchant\",\n    \"0-0\": \"**product_description** \\n\\n*string*\",\n    \"0-2\": \"1 to 2000 characters\",\n    \"2-0\": \"**mfr_part_number** \\n\\n*string*\",\n    \"2-2\": \"1 to 50 characters\",\n    \"2-1\": \"Part number provided by the original manufacturer of the merchant SKU.\",\n    \"2-4\": \"Merchant\",\n    \"4-0\": \"**shipping_weight_pounds** \\n\\n*float*\",\n    \"4-2\": \"Must be >= 0.01\",\n    \"4-1\": \"Weight of the merchant SKU when in its shippable configuration.\",\n    \"5-0\": \"**map_price** \\n\\n*float*\",\n    \"5-2\": \"Must be >= 0.01\",\n    \"6-1\": \"Price policy rule that determines allowed item pricing and Jet member savings shown to the consumer.  Please note that this field name is misleading as it is used for all price policies and not just a MAP policy.  These settings only apply to what the consumer is shown and have no impact on what a retailer is paid for an item.\\n\\n'101' = no restrictions on displayed product pricing or Jet member savings on the product.  This setting is the normal setting used for most products.\\n\\n'102' = Jet member savings for the product are never advertised and are only visible to logged in Jet members after they specifically request to reveal savings.  This value can be used when complying with a manufacturer's Minimum Advertised Price (MAP) policy.  The API map_price field must also be used when using this setting as it is needed to display a price for advertising and initial presentation to the consumer. \\n\\n'103' = Jet member savings never applied to product and product orders never awarded to retailer if Jet item price is below item price sent by retailer.  This value can be used when complying with a manufacturer's Unilateral Minimum Retail Price Policy.  This policy setting will restrict the ability to win an order for a product if the retailer item price sent is above Jet's item price shown to the consumer.\",\n    \"5-1\": \"Minimum Advertised Price (MAP) for the product.  This price is used as the display or reference price when price policy value 102 is used via the map_implementation field.\",\n    \"6-0\": \"**map_implementation** \\n\\n*string*\",\n    \"6-2\": \"Must be one of the following values:\\n* 103\\n* 102\\n* 101\",\n    \"h-5\": \"Required\",\n    \"4-5\": \"Required if shipping rates for fulfillment nodes are set up \\\"per pound\\\"\",\n    \"5-5\": \"Required if map_implementation field = '102'\",\n    \"7-0\": \"**jet_browse_node_id** \\n\\n*integer*\",\n    \"7-1\": \"The unique ID that defines where the product will be found in the Jet.com browse structure. This can be found using the Jet Taxonomy API.\",\n    \"7-2\": \"This must be a valid jet_browse_node_id\",\n    \"8-0\": \"**attributes_node_specific**\\n\\n*attributes_node_specific array*\",\n    \"8-1\": \"Attributes associated with the category provided\",\n    \"8-2\": \"Minimum 1 attributes_node_specific object required if this field is provided Maximum 10 attributes_node_specific object required if this field is provided\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]\n**attributes_node_specific** - WThe following fields are a part of the attributes_node_specific object\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-2\": \"Validation\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"**attribute_id** \\n\\n*integer*\",\n    \"0-1\": \"The node attribute ID number that you get from the [Jet Taxonomy](https://www.dropbox.com/s/7zk1r9zpyfwcejt/Jet_Taxonomy.xlsx?dl=0) that corresponds with the attribute you are passing.\",\n    \"1-0\": \"**attribute_value**\\n\\n*string*\",\n    \"0-2\": \"Must be > 0\",\n    \"2-0\": \"**attribute_value_unit**\\n\\n*string*\",\n    \"1-1\": \"The value for the attribute. For example, if the attribute is size you may pass 'large' or if the the attribute is weight, you may pass '22'. For attributes like weight the unit will be passed in the next field.\",\n    \"2-1\": \"If the attribute_value requires a unit, then you pass the unit here.\",\n    \"1-2\": \"Must have a length between 1 and 100\\nCannot be an image URL\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n##  Additional Fields\n\nThe fields listed below are encouraged to be used when adding a sku to Jet.com. The unified catalog that Jet may need this data to list your product.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-2\": \"Validation\",\n    \"h-1\": \"Description\",\n    \"h-4\": \"Defined By\",\n    \"0-0\": \"**amazon_item_type_keyword** \\n\\n*string*\",\n    \"0-2\": \"\",\n    \"0-1\": \"ItemType allows customers to find your products as they browse to the most specific item types.\",\n    \"2-0\": \"**number_units_for_price_per_unit** \\n\\n*integer*\",\n    \"2-2\": \"\",\n    \"2-1\": \"For Price Per Unit calculations, the number of units included in the merchant SKU. The unit of measure must be specified in order to indicate what is being measured by the unit-count.\",\n    \"3-0\": \"**type_of_unit_for_price_per_unit** \\n\\n*string*\",\n    \"3-1\": \"The type_of_unit_for_price_per_unit attribute is a label for the number_units_for_price_per_unit. The price per unit can then be constructed by dividing the selling price by the number of units and appending the text \\\"per unit value.\\\" For example, for a six-pack of soda, number_units_for_price_per_unit= 6, type_of_unit_for_price_per_unit= can, price per unit = price per can.\",\n    \"4-0\": \"**package_length_inches** \\n\\n*float*\",\n    \"4-2\": \"A number >= 0.01\",\n    \"4-1\": \"Length of the merchant SKU when in its shippable configuration.\",\n    \"5-0\": \"**package_width_inches** \\n\\n*float*\",\n    \"5-2\": \"A number >= 0.01\",\n    \"5-1\": \"Width of the merchant SKU when in its shippable configuration.\",\n    \"6-0\": \"**package_height_inches** \\n\\n*float*\",\n    \"6-1\": \"Height of the merchant SKU when in its shippable configuration.\",\n    \"6-2\": \"A number >= 0.01\",\n    \"7-0\": \"**display_length_inches** \\n\\n*float*\",\n    \"7-2\": \"A number >= 0.01\",\n    \"8-0\": \"**display_width_inches** \\n\\n*float*\",\n    \"7-1\": \"Length of the merchant SKU when in its fully assembled/usable condition.\",\n    \"8-2\": \"A number >= 0.01\",\n    \"9-0\": \"**display_height_inches** \\n\\n*float*\",\n    \"9-2\": \"A number >= 0.01\",\n    \"9-1\": \"Height of the merchant SKU when in its fully assembled/usable condition.\",\n    \"8-1\": \"Width of the merchant SKU when in its fully assembled/usable condition.\",\n    \"10-0\": \"**prop_65** \\n\\n*boolean*\",\n    \"10-1\": \"You must tell us if your product is subject to Proposition 65 rules and regulations. Proposition 65 requires merchants to provide California consumers with special warnings for products that contain chemicals known to cause cancer, birth defects, or other reproductive harm, if those products expose consumers to such materials above certain threshold levels. The default value for this is \\\"false,\\\" so if you do not populate this column, we will assume your product is not subject to this rule. Please view this website for more information: http://www.oehha.ca.gov/.\",\n    \"10-2\": \"\",\n    \"11-0\": \"**legal_disclaimer_description** \\n\\n*string*\",\n    \"11-1\": \"Any legal language required to be displayed with the product.\",\n    \"12-0\": \"**cpsia_cautionary_statements **\\n\\n*string array*\",\n    \"12-1\": \"Use this field to indicate if a cautionary statement relating to the choking hazards of children's toys and games applies to your product. These cautionary statements are defined in Section 24 of the Federal Hazardous Substances Act and Section 105 of the Consumer Product Safety Improvement Act of 2008. They must be displayed on the product packaging and in certain online and catalog advertisements. You are responsible for determining if a cautionary statement applies to the product. This can be verified by contacting the product manufacturer or checking the product packaging. Cautionary statements that you select will be displayed on the product detail page. If no cautionary statement applies to the product, select \\\"no warning applicable\\\".\",\n    \"12-2\": \"Must be one of the following values:\\n* no warning applicable\\n* choking hazard small parts\\n* choking hazard is a small ball\\n* choking hazard is a marble\\n* choking hazard contains a small ball\\n* choking hazard contains a marble\\n* choking hazard balloon\\n\\nCannot have 'no warning applicable' and another reason submitted together\",\n    \"13-0\": \"**country_of_origin** \\n\\n*string*\",\n    \"13-1\": \"The country that the item was manufactured in.\",\n    \"14-0\": \"**safety_warning** \\n\\n*string*\",\n    \"13-2\": \"Maximum 50 characters\",\n    \"14-1\": \"If applicable, use to supply any associated warnings for your product.\",\n    \"15-0\": \"**product_tax_code** \\n\\n*string*\",\n    \"15-2\": \"Must be one of the following values:\\n* 'Toilet Paper'\\n* 'Thermometers'\\n* 'Sweatbands'\\n* 'SPF Suncare Products'\\n* 'Sparkling Water'\\n* 'Smoking Cessation'\\n* 'Shoe Insoles'\\n* 'Safety Clothing'\\n* 'Pet Foods'\\n* 'Paper Products'\\n* 'OTC Pet Meds'\\n* 'OTC Medication'\\n* 'Oral Care Products'\\n* 'Non-Motorized Boats'\\n* 'Non Taxable Product'\\n* 'Mobility Equipment'\\n* 'Medicated Personal Care Items'\\n* 'Infant Clothing'\\n* 'Helmets'\\n* 'Handkerchiefs'\\n* 'Generic Taxable Product'\\n* 'General Grocery Items'\\n* 'General Clothing'\\n* 'Fluoride Toothpaste'\\n* 'Feminine Hygiene Products'\\n* 'Durable Medical Equipment'\\n* 'Drinks under 50 Percent Juice'\\n* 'Disposable Wipes'\\n* 'Disposable Infant Diapers'\\n* 'Dietary Supplements'\\n* 'Diabetic Supplies'\\n* 'Costumes'\\n* 'Contraceptives'\\n* 'Contact Lens Solution'\\n* 'Carbonated Soft Drinks'\\n* 'Car Seats'\\n* 'Candy with Flour'\\n* 'Candy'\\n* 'Breast Pumps'\\n* 'Braces and Supports'\\n* 'Bottled Water Plain'\\n* 'Beverages with 51 to 99 Percent Juice'\\n* 'Bathing Suits'\\n* 'Bandages and First Aid Kits'\\n* 'Baby Supplies'\\n* 'Athletic Clothing'\\n* 'Adult Diapers'\",\n    \"15-1\": \"Jet's standard code for the tax properties of a given product.\",\n    \"14-2\": \"Maximum 2000 characters\",\n    \"16-0\": \"**msrp** \\n\\n*float*\",\n    \"16-2\": \"A number >= 0.01\",\n    \"16-1\": \"The manufacturer's suggested retail price or list price for the product\",\n    \"17-0\": \"**alternate_images**\\n\\n*alternate_images object*\",\n    \"17-1\": \"Any additional images you would like to include for the product\",\n    \"1-0\": \"**category_path**\\n\\n*string*\",\n    \"1-1\": \"The category path for where this product is located in your categorization structure\\n\\ne.g. A laptop bag might belong in Electronics/Computers/Laptops/Accessories/Bags in your product's category\"\n  },\n  \"cols\": 3,\n  \"rows\": 18\n}\n[/block]\n**alternate_images** - The following fields are a part of the alternate_images object\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**image_slot_id**\\n\\n*integer*\",\n    \"0-1\": \"The slot that the alternate image should be uploaded to. Jet.com supports up to 8 images (or 8 image slots).\",\n    \"0-2\": \"* 1 to 8\\n* Required if alternate images array is provided\\n* Image slots cannot be duplicated\",\n    \"1-0\": \"**image_url** \\n\\n*string*\",\n    \"1-1\": \"URL location where Jet.com can access the image. The images should be 1500 x 1500 pixels or larger, but anything 500 x 500 pixels or larger is acceptable. There is no limit to image size.\\n\\n* the only unsupported image file formats are multi-layer png and gif.\\n* all images' areas must be at least 40000 pixels (ie 200x200)\\n* one side must be at least 200 pixels; the other side must be at least 100 pixels.\",\n    \"1-2\": \"* A valid image URL.  Jet.com will not be able to accept broken image links, or \\\"no image\\\" images.\\n* Required if alternate images array is provided\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body: With Price Upload\"\n}\n[/block]\nThe following fields also will be returned if price is uploaded for this SKU\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"**price***\\n\\n*string*\",\n    \"0-1\": \"The overall price that the merchant SKU is priced at. Note that this is the item price, and generally will not contain in it the shipping charge.\",\n    \"0-3\": \"\",\n    \"1-0\": \"**price_by_fulfillment_node***\\n\\n*price_by_fulfillment_nodes object array*\",\n    \"1-1\": \"The price a retailer would like to set for this SKU sold at a fulfillment node\",\n    \"1-2\": \"\",\n    \"2-0\": \"**price_last_update***\\n\\n*string*\",\n    \"3-0\": \"fulfillment_node_price\",\n    \"2-1\": \"The timestamp for when this product's price was last updated\",\n    \"3-1\": \"price\",\n    \"2-3\": \"\",\n    \"3-3\": \"The price of the merchant SKU at the fulfillment node level.\",\n    \"h-4\": \"Required\",\n    \"0-4\": \"yes\",\n    \"1-4\": \"yes\",\n    \"1-3\": \"\",\n    \"2-2\": \"\",\n    \"2-4\": \"yes\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\\* denotes the field will always come back with the response\n\n**price_by_fulfillment_nodes object** - The below table outlines the fields that are within the fulfillment nodes array:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**fulfillment_node_id**\",\n    \"1-0\": \"**fulfillment_node_price**\",\n    \"0-1\": \"The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.\",\n    \"1-1\": \"The price of the merchant SKU at the fulfillment node level.\",\n    \"0-3\": \"\",\n    \"1-3\": \"\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Valid Values\",\n    \"h-3\": \"Description\",\n    \"h-0\": \"Field\",\n    \"h-4\": \"Required\",\n    \"0-4\": \"\",\n    \"1-4\": \"\",\n    \"0-2\": \"Must be a valid fulfillment node ID set up by the merchant\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body: With Inventory Upload\"\n}\n[/block]\nThe following fields also will be returned if inventory is uploaded for this SKU\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"**inventory_by_fulfillment_node**\\n\\n*inventory_by_fulfillment_nodes object array*\",\n    \"0-1\": \"An array of fulfillment nodes to set inventory\",\n    \"0-2\": \"\",\n    \"0-3\": \"\",\n    \"1-0\": \"**inventory_last_update**\\n\\n*string*\",\n    \"1-1\": \"This is the timestamp for when inventory was last updated\",\n    \"2-0\": \"quantity\",\n    \"2-1\": \"integer\",\n    \"2-3\": \"The quantity of inventory for the given SKU in a given fulfillment node.\",\n    \"1-3\": \"\",\n    \"h-4\": \"Required\",\n    \"0-4\": \"\",\n    \"1-4\": \"\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n**inventory_by_fulfillment_nodes array** - The below table outlines the fields that are within the fulfillment nodes array:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**fulfillment_node_id** \\n\\n*string*\",\n    \"1-0\": \"**quantity** \\n\\n*integer*\",\n    \"0-1\": \"The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.\",\n    \"1-1\": \"The feed number provided for the given fulfillment node.\",\n    \"0-3\": \"\",\n    \"1-3\": \"\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"h-1\": \"Description\",\n    \"h-0\": \"Field\",\n    \"h-4\": \"Required\",\n    \"0-4\": \"\",\n    \"1-4\": \"\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body: With Shipping Exceptions\"\n}\n[/block]\nThe following fields also will be returned if a shipping exception is uploaded for this SKU\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"**fulfillment_nodes** \\n\\n*fulfillment_nodes object array*\",\n    \"0-1\": \"This is an array of fulfillment nodes. Please see our fulfillment nodes array table below.\",\n    \"0-3\": \"\",\n    \"h-4\": \"Required\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n**fulfillment_nodes array **- The following tables \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"h-4\": \"Required\",\n    \"0-0\": \"**fulfillment_node_id***\\n\\n*string*\",\n    \"0-1\": \"The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.\",\n    \"0-3\": \"\",\n    \"0-4\": \"\",\n    \"1-4\": \"\",\n    \"1-3\": \"\",\n    \"1-1\": \"This array contains all fields below. There can be multiple shipping exception arrays in a fulfillment node array.\",\n    \"1-0\": \"**shipping_exceptions**\\n\\n*shipping_exceptions object array*\",\n    \"0-2\": \"Must be a valid fulfillment node ID set up by the merchant\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n**shipping_exceptions object** - The fields below are part of the shipping_exceptions object\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"\",\n    \"0-0\": \"**service_level** \\n\\n*string*\",\n    \"0-1\": \"This field should be used if you are defining your shipping options by service_level.\",\n    \"0-2\": \"Must be one of the following values:\\n* SecondDay\\n* NextDay\\n* Scheduled\\n* Expedited\\n* Standard\",\n    \"0-3\": \"\",\n    \"1-0\": \"**shipping_method** \\n\\n*string*\",\n    \"1-1\": \"A specific shipping method e.g. UPS Ground, UPS Next Day Air, FedEx Home, Freight.\",\n    \"1-2\": \"\",\n    \"1-3\": \"\",\n    \"2-0\": \"**override_type** \\n\\n*string*\",\n    \"2-1\": \"Override charge - A charge that overrides the default shipping charge.\\n\\nAdditional charge - A charge that is added to the default shipping charge.\",\n    \"2-2\": \"Must be one of the following values:\\n* Override charge\\n* Additional charge\",\n    \"2-3\": \"\",\n    \"3-0\": \"**shipping_charge_amount**\\n\\n*float*\",\n    \"3-1\": \"The amount added to your default shipping charge when override_type = \\\"Additional charge\\\" \\n\\nThe total amount charged when override_type = \\\"Override charge\\\"\",\n    \"3-3\": \"\",\n    \"4-0\": \"**shipping_exception_type** \\n\\n*string*\",\n    \"4-1\": \"'exclusive' - The product should only be shipped using the shipping method or shipping level provided\\n'restricted' - The product cannot be shipped using the shipping method or shipping level provided.\",\n    \"4-2\": \"Must be one of the following values:\\n* exclusive \\n* restricted\",\n    \"4-3\": \"\",\n    \"h-4\": \"\",\n    \"3-2\": \"A number >= 0\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body: With Returns Exception\"\n}\n[/block]\nThe following fields also will be returned if a returns exception is uploaded for this SKU\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"**time_to_return** \\n\\n*integer*\",\n    \"1-0\": \"**return_location_ids**\\n\\n*string array*\",\n    \"2-0\": \"**return_shipping_methods**\\n\\n*string array*\",\n    \"0-1\": \"The number of days after purchase a customer can return the item.\",\n    \"1-1\": \"The ID of the returns node that was created on partner.jet.com under fulfillment settings.\",\n    \"2-1\": \"A specific shipping method.  Jet will choose its default of FedEx ground\",\n    \"0-3\": \"\",\n    \"1-3\": \"\",\n    \"2-3\": \"\",\n    \"2-2\": \"Must be one of the following values:\\n* Freight\\n* FedEx Ground \\n* UPS Ground\",\n    \"h-4\": \"Required\",\n    \"1-2\": \"Must be a valid return node ID set up by the merchant\",\n    \"0-2\": \"1 to 30\\n\\nMust be consistent with returns policy\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body: With Archive\"\n}\n[/block]\nThe following fields also will be returned if an archive message is uploaded for this SKU\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**is_archived***\\n\\n*boolean*\",\n    \"0-1\": \"Indicates whether the specified SKU is archived.\",\n    \"0-2\": \"Must be one of the following values:\\n* true\\n* false\",\n    \"0-3\": \"\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"h-4\": \"Required\",\n    \"0-4\": \"Yes\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]","editedParams2":true,"order":8,"slug":"get-skus","updates":[],"user":"562e25d24376430d006f1769","category":"56fd2bf327b4321900186ec9","createdAt":"2015-10-26T20:42:37.562Z","childrenPages":[]}

getSingle SKU Retrieval


Query Params

user_defined_sku_id:
string
The previously created ID you will use to track and update your Merchant SKU
Any information about the SKU that was previously uploaded (price, inventory, shipping exception) will show up here. Beginning May 29, 2017, a GET request to this endpoint will only return information about the merchant SKU (inventory and price information must now be accessed via the appropriate endpoints). As such, the following fields will no longer be returned: "inventory_by_fulfillment_node" "inventory_last_update" "price" "price_last_update" "best_marketplace_offer" "my_best_offer" "producer_id" "merchant_sku_id" "merchant_id" "jet_sku" "correlation_id" "sales_rank" "sku_created_date" [block:api-header] { "type": "basic", "title": "Response Body: SKU Upload Only" } [/block] The following fields are added by Jet in the response body. [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**status**\n\n*string*", "0-1": "The status of this merchant SKU in our product pipeline\n\nWill be one of the following values:\n* 'Available For Purchase' - The product is listed on Jet.com and can be purchased by a customer\n* 'Missing Listing Data' - More data is needed to list the product on Jet.com\n* 'Under Jet Review' - The SKU is current being processed in Jet's product catalog\n* 'Unauthorized' - The SKU is not authorized to be sold\n* 'Excluded' - The SKU is not able to be sold on Jet.com. Please see Partner Policy for more details on SKUs accepted\n* 'Archived' - The SKU is 'inactive' and is not available for purchase on Jet.com. All updated to this SKU will be ignored.", "1-0": "**sub_status**\n\n*string array*", "1-1": "Any additional information about the SKU's status. A product may exist in multiple substatuses at the same time\n\nValues with descriptions\n* Missing variation information\n* Missing title\n* Missing shipping weight\n* Missing price\n* Missing image\n* Missing category\n* Missing brand\n* Missing attribute value\n* Invalid SKU identifier\n* Invalid category - the category provided does not exist or needs to be mapped to a more specific category\n* Incorrect multipack quantity - based on our matching algorithm, the product offer may have the incorrect multipack quantity\n* Additional SKU ID needed - we need a UPC, ASIN, GTIN, etc. to identify a SKU", "0-2": "Must be one of the following values:\n* Available For Purchase \n* Missing Listing Data \n* Under Jet Review \n* Unauthorized\n* Excluded\n* Archived", "1-2": "Must be one of the following values:\n* Missing variation information\n* Missing title\n* Missing shipping weight\n* Missing price\n* Missing image\n* Missing category\n* Missing brand\n* Missing attribute value\n* Invalid SKU identifier\n* Invalid category \n* Incorrect multipack quantity\n* Additional SKU ID needed" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Request Body" } [/block] ## Required Data Jet.com maps all product offers to a universal catalog using the following data: [block:parameters] { "data": { "h-0": "Field", "h-2": "Validation", "h-1": "Description", "h-4": "Defined By", "1-0": "**multipack_quantity***\n\n*integer*", "1-1": "Number of items with the given Standard Product Code that makes up your merchant SKU (product offer).", "1-4": "Merchant", "2-2": "Required if ASIN not provided", "2-0": "**standard_product_codes**\n\n*standard_product_codes object array*", "2-1": "This is an array of product codes. Please see our product code array table below.", "2-4": "Merchant", "3-0": "**ASIN** \n\n*string*", "3-1": "Amazon standard identification number for this merchant SKU if available.", "3-2": "Required if standard_product_codes not provided\nAlphanumeric\nlength of 10", "3-4": "Merchant", "0-0": "**product_title***\n\n*string*", "0-2": "5 to 500 characters", "0-1": "The title of a given merchant sku.", "h-5": "Required", "0-5": "Yes", "1-5": "Yes", "2-5": "Required if ASIN not provided", "3-5": "Required if standard product codes not provided", "1-2": "1 to 128", "4-0": "**brand***\n\n*string*", "4-1": "The brand for your merchant SKU", "4-2": "1 to 100 characters", "5-0": "**main_image_url***\n\n*string*", "5-1": "URL location where Jet.com can access the image. The images should be 40,000 pixels or larger, There is no limit to image size.\n\n* the only unsupported image file formats are multi-layer png and gif.\n* all images' areas must be at least 40000 pixels (ie 200x200)\n* one side must be at least 200 pixels; the other side must be at least 100 pixels.", "5-2": "A valid image URL. Jet.com will not be able to accept broken image links, or \"no image\" images." }, "cols": 3, "rows": 6 } [/block] [block:callout] { "type": "danger", "title": "Multipack Quantity Errors", "body": "Multipack quantity is NOT the same as product count. As a rule of thumb, multipack quantity is the number of barcodes that make up your product offer." } [/block] **standard_product_codes object** - The following fields are part of the standard_product_codes object: [block:parameters] { "data": { "0-0": "**standard_product_code_type** \n\n*string*", "h-0": "Field", "h-2": "Validation", "h-1": "Description", "0-2": "Must be one of the following values:\n* GTIN-14\n* EAN\n* ISBN-10\n* ISBN-13\n* UPC", "1-2": "If standard product code = \n * 'GTIN-14' - 14 digits\n * 'EAN' - 13 digits\n * 'ISBN-10' - 10 digits\n * 'ISBN-13' - 13 digits \n * 'UPC'- 12 digits", "1-0": "**standard_product_code** \n\n*string*", "0-1": "The type of standard product code that is being provided", "1-1": "The standard product code associated with the type provided" }, "cols": 3, "rows": 2 } [/block] ## Minimum Listing Data On Jet.com, product offers across merchants are mapped to a universal product listing. Jet chooses the best pieces from each listing to create a unified listing. If a product offer matches to an existing product in our catalog, the retailer may need to provide little to no additional information than what is expected above. If the product is not available already, the fields below may be required. [block:parameters] { "data": { "h-0": "Field", "h-2": "Validation", "1-0": "**manufacturer** \n\n*string*", "h-1": "Description", "h-4": "Defined By:", "1-2": "1 to 100 characters", "1-1": "Manufacturer of the merchant SKU.", "1-4": "Merchant", "3-0": "**bullets**\n\n*string array*", "3-1": "Merchant SKU feature description. Jet currently allows for up to 5 bullets.", "3-2": "1 to 500 characters\nMax 5 strings", "3-4": "Merchant", "4-4": "Merchant", "5-4": "Merchant", "6-4": "Merchant", "0-0": "**product_description** \n\n*string*", "0-2": "1 to 2000 characters", "2-0": "**mfr_part_number** \n\n*string*", "2-2": "1 to 50 characters", "2-1": "Part number provided by the original manufacturer of the merchant SKU.", "2-4": "Merchant", "4-0": "**shipping_weight_pounds** \n\n*float*", "4-2": "Must be >= 0.01", "4-1": "Weight of the merchant SKU when in its shippable configuration.", "5-0": "**map_price** \n\n*float*", "5-2": "Must be >= 0.01", "6-1": "Price policy rule that determines allowed item pricing and Jet member savings shown to the consumer. Please note that this field name is misleading as it is used for all price policies and not just a MAP policy. These settings only apply to what the consumer is shown and have no impact on what a retailer is paid for an item.\n\n'101' = no restrictions on displayed product pricing or Jet member savings on the product. This setting is the normal setting used for most products.\n\n'102' = Jet member savings for the product are never advertised and are only visible to logged in Jet members after they specifically request to reveal savings. This value can be used when complying with a manufacturer's Minimum Advertised Price (MAP) policy. The API map_price field must also be used when using this setting as it is needed to display a price for advertising and initial presentation to the consumer. \n\n'103' = Jet member savings never applied to product and product orders never awarded to retailer if Jet item price is below item price sent by retailer. This value can be used when complying with a manufacturer's Unilateral Minimum Retail Price Policy. This policy setting will restrict the ability to win an order for a product if the retailer item price sent is above Jet's item price shown to the consumer.", "5-1": "Minimum Advertised Price (MAP) for the product. This price is used as the display or reference price when price policy value 102 is used via the map_implementation field.", "6-0": "**map_implementation** \n\n*string*", "6-2": "Must be one of the following values:\n* 103\n* 102\n* 101", "h-5": "Required", "4-5": "Required if shipping rates for fulfillment nodes are set up \"per pound\"", "5-5": "Required if map_implementation field = '102'", "7-0": "**jet_browse_node_id** \n\n*integer*", "7-1": "The unique ID that defines where the product will be found in the Jet.com browse structure. This can be found using the Jet Taxonomy API.", "7-2": "This must be a valid jet_browse_node_id", "8-0": "**attributes_node_specific**\n\n*attributes_node_specific array*", "8-1": "Attributes associated with the category provided", "8-2": "Minimum 1 attributes_node_specific object required if this field is provided Maximum 10 attributes_node_specific object required if this field is provided" }, "cols": 3, "rows": 9 } [/block] **attributes_node_specific** - WThe following fields are a part of the attributes_node_specific object [block:parameters] { "data": { "h-0": "Field", "h-2": "Validation", "h-1": "Description", "0-0": "**attribute_id** \n\n*integer*", "0-1": "The node attribute ID number that you get from the [Jet Taxonomy](https://www.dropbox.com/s/7zk1r9zpyfwcejt/Jet_Taxonomy.xlsx?dl=0) that corresponds with the attribute you are passing.", "1-0": "**attribute_value**\n\n*string*", "0-2": "Must be > 0", "2-0": "**attribute_value_unit**\n\n*string*", "1-1": "The value for the attribute. For example, if the attribute is size you may pass 'large' or if the the attribute is weight, you may pass '22'. For attributes like weight the unit will be passed in the next field.", "2-1": "If the attribute_value requires a unit, then you pass the unit here.", "1-2": "Must have a length between 1 and 100\nCannot be an image URL" }, "cols": 3, "rows": 3 } [/block] ## Additional Fields The fields listed below are encouraged to be used when adding a sku to Jet.com. The unified catalog that Jet may need this data to list your product. [block:parameters] { "data": { "h-0": "Field", "h-2": "Validation", "h-1": "Description", "h-4": "Defined By", "0-0": "**amazon_item_type_keyword** \n\n*string*", "0-2": "", "0-1": "ItemType allows customers to find your products as they browse to the most specific item types.", "2-0": "**number_units_for_price_per_unit** \n\n*integer*", "2-2": "", "2-1": "For Price Per Unit calculations, the number of units included in the merchant SKU. The unit of measure must be specified in order to indicate what is being measured by the unit-count.", "3-0": "**type_of_unit_for_price_per_unit** \n\n*string*", "3-1": "The type_of_unit_for_price_per_unit attribute is a label for the number_units_for_price_per_unit. The price per unit can then be constructed by dividing the selling price by the number of units and appending the text \"per unit value.\" For example, for a six-pack of soda, number_units_for_price_per_unit= 6, type_of_unit_for_price_per_unit= can, price per unit = price per can.", "4-0": "**package_length_inches** \n\n*float*", "4-2": "A number >= 0.01", "4-1": "Length of the merchant SKU when in its shippable configuration.", "5-0": "**package_width_inches** \n\n*float*", "5-2": "A number >= 0.01", "5-1": "Width of the merchant SKU when in its shippable configuration.", "6-0": "**package_height_inches** \n\n*float*", "6-1": "Height of the merchant SKU when in its shippable configuration.", "6-2": "A number >= 0.01", "7-0": "**display_length_inches** \n\n*float*", "7-2": "A number >= 0.01", "8-0": "**display_width_inches** \n\n*float*", "7-1": "Length of the merchant SKU when in its fully assembled/usable condition.", "8-2": "A number >= 0.01", "9-0": "**display_height_inches** \n\n*float*", "9-2": "A number >= 0.01", "9-1": "Height of the merchant SKU when in its fully assembled/usable condition.", "8-1": "Width of the merchant SKU when in its fully assembled/usable condition.", "10-0": "**prop_65** \n\n*boolean*", "10-1": "You must tell us if your product is subject to Proposition 65 rules and regulations. Proposition 65 requires merchants to provide California consumers with special warnings for products that contain chemicals known to cause cancer, birth defects, or other reproductive harm, if those products expose consumers to such materials above certain threshold levels. The default value for this is \"false,\" so if you do not populate this column, we will assume your product is not subject to this rule. Please view this website for more information: http://www.oehha.ca.gov/.", "10-2": "", "11-0": "**legal_disclaimer_description** \n\n*string*", "11-1": "Any legal language required to be displayed with the product.", "12-0": "**cpsia_cautionary_statements **\n\n*string array*", "12-1": "Use this field to indicate if a cautionary statement relating to the choking hazards of children's toys and games applies to your product. These cautionary statements are defined in Section 24 of the Federal Hazardous Substances Act and Section 105 of the Consumer Product Safety Improvement Act of 2008. They must be displayed on the product packaging and in certain online and catalog advertisements. You are responsible for determining if a cautionary statement applies to the product. This can be verified by contacting the product manufacturer or checking the product packaging. Cautionary statements that you select will be displayed on the product detail page. If no cautionary statement applies to the product, select \"no warning applicable\".", "12-2": "Must be one of the following values:\n* no warning applicable\n* choking hazard small parts\n* choking hazard is a small ball\n* choking hazard is a marble\n* choking hazard contains a small ball\n* choking hazard contains a marble\n* choking hazard balloon\n\nCannot have 'no warning applicable' and another reason submitted together", "13-0": "**country_of_origin** \n\n*string*", "13-1": "The country that the item was manufactured in.", "14-0": "**safety_warning** \n\n*string*", "13-2": "Maximum 50 characters", "14-1": "If applicable, use to supply any associated warnings for your product.", "15-0": "**product_tax_code** \n\n*string*", "15-2": "Must be one of the following values:\n* 'Toilet Paper'\n* 'Thermometers'\n* 'Sweatbands'\n* 'SPF Suncare Products'\n* 'Sparkling Water'\n* 'Smoking Cessation'\n* 'Shoe Insoles'\n* 'Safety Clothing'\n* 'Pet Foods'\n* 'Paper Products'\n* 'OTC Pet Meds'\n* 'OTC Medication'\n* 'Oral Care Products'\n* 'Non-Motorized Boats'\n* 'Non Taxable Product'\n* 'Mobility Equipment'\n* 'Medicated Personal Care Items'\n* 'Infant Clothing'\n* 'Helmets'\n* 'Handkerchiefs'\n* 'Generic Taxable Product'\n* 'General Grocery Items'\n* 'General Clothing'\n* 'Fluoride Toothpaste'\n* 'Feminine Hygiene Products'\n* 'Durable Medical Equipment'\n* 'Drinks under 50 Percent Juice'\n* 'Disposable Wipes'\n* 'Disposable Infant Diapers'\n* 'Dietary Supplements'\n* 'Diabetic Supplies'\n* 'Costumes'\n* 'Contraceptives'\n* 'Contact Lens Solution'\n* 'Carbonated Soft Drinks'\n* 'Car Seats'\n* 'Candy with Flour'\n* 'Candy'\n* 'Breast Pumps'\n* 'Braces and Supports'\n* 'Bottled Water Plain'\n* 'Beverages with 51 to 99 Percent Juice'\n* 'Bathing Suits'\n* 'Bandages and First Aid Kits'\n* 'Baby Supplies'\n* 'Athletic Clothing'\n* 'Adult Diapers'", "15-1": "Jet's standard code for the tax properties of a given product.", "14-2": "Maximum 2000 characters", "16-0": "**msrp** \n\n*float*", "16-2": "A number >= 0.01", "16-1": "The manufacturer's suggested retail price or list price for the product", "17-0": "**alternate_images**\n\n*alternate_images object*", "17-1": "Any additional images you would like to include for the product", "1-0": "**category_path**\n\n*string*", "1-1": "The category path for where this product is located in your categorization structure\n\ne.g. A laptop bag might belong in Electronics/Computers/Laptops/Accessories/Bags in your product's category" }, "cols": 3, "rows": 18 } [/block] **alternate_images** - The following fields are a part of the alternate_images object [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**image_slot_id**\n\n*integer*", "0-1": "The slot that the alternate image should be uploaded to. Jet.com supports up to 8 images (or 8 image slots).", "0-2": "* 1 to 8\n* Required if alternate images array is provided\n* Image slots cannot be duplicated", "1-0": "**image_url** \n\n*string*", "1-1": "URL location where Jet.com can access the image. The images should be 1500 x 1500 pixels or larger, but anything 500 x 500 pixels or larger is acceptable. There is no limit to image size.\n\n* the only unsupported image file formats are multi-layer png and gif.\n* all images' areas must be at least 40000 pixels (ie 200x200)\n* one side must be at least 200 pixels; the other side must be at least 100 pixels.", "1-2": "* A valid image URL. Jet.com will not be able to accept broken image links, or \"no image\" images.\n* Required if alternate images array is provided" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Response Body: With Price Upload" } [/block] The following fields also will be returned if price is uploaded for this SKU [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**price***\n\n*string*", "0-1": "The overall price that the merchant SKU is priced at. Note that this is the item price, and generally will not contain in it the shipping charge.", "0-3": "", "1-0": "**price_by_fulfillment_node***\n\n*price_by_fulfillment_nodes object array*", "1-1": "The price a retailer would like to set for this SKU sold at a fulfillment node", "1-2": "", "2-0": "**price_last_update***\n\n*string*", "3-0": "fulfillment_node_price", "2-1": "The timestamp for when this product's price was last updated", "3-1": "price", "2-3": "", "3-3": "The price of the merchant SKU at the fulfillment node level.", "h-4": "Required", "0-4": "yes", "1-4": "yes", "1-3": "", "2-2": "", "2-4": "yes" }, "cols": 3, "rows": 3 } [/block] \* denotes the field will always come back with the response **price_by_fulfillment_nodes object** - The below table outlines the fields that are within the fulfillment nodes array: [block:parameters] { "data": { "0-0": "**fulfillment_node_id**", "1-0": "**fulfillment_node_price**", "0-1": "The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.", "1-1": "The price of the merchant SKU at the fulfillment node level.", "0-3": "", "1-3": "", "h-1": "Type", "h-2": "Valid Values", "h-3": "Description", "h-0": "Field", "h-4": "Required", "0-4": "", "1-4": "", "0-2": "Must be a valid fulfillment node ID set up by the merchant" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Response Body: With Inventory Upload" } [/block] The following fields also will be returned if inventory is uploaded for this SKU [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**inventory_by_fulfillment_node**\n\n*inventory_by_fulfillment_nodes object array*", "0-1": "An array of fulfillment nodes to set inventory", "0-2": "", "0-3": "", "1-0": "**inventory_last_update**\n\n*string*", "1-1": "This is the timestamp for when inventory was last updated", "2-0": "quantity", "2-1": "integer", "2-3": "The quantity of inventory for the given SKU in a given fulfillment node.", "1-3": "", "h-4": "Required", "0-4": "", "1-4": "" }, "cols": 3, "rows": 2 } [/block] **inventory_by_fulfillment_nodes array** - The below table outlines the fields that are within the fulfillment nodes array: [block:parameters] { "data": { "0-0": "**fulfillment_node_id** \n\n*string*", "1-0": "**quantity** \n\n*integer*", "0-1": "The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.", "1-1": "The feed number provided for the given fulfillment node.", "0-3": "", "1-3": "", "h-2": "Validation", "h-3": "Description", "h-1": "Description", "h-0": "Field", "h-4": "Required", "0-4": "", "1-4": "" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Response Body: With Shipping Exceptions" } [/block] The following fields also will be returned if a shipping exception is uploaded for this SKU [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**fulfillment_nodes** \n\n*fulfillment_nodes object array*", "0-1": "This is an array of fulfillment nodes. Please see our fulfillment nodes array table below.", "0-3": "", "h-4": "Required" }, "cols": 3, "rows": 1 } [/block] **fulfillment_nodes array **- The following tables [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "h-4": "Required", "0-0": "**fulfillment_node_id***\n\n*string*", "0-1": "The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.", "0-3": "", "0-4": "", "1-4": "", "1-3": "", "1-1": "This array contains all fields below. There can be multiple shipping exception arrays in a fulfillment node array.", "1-0": "**shipping_exceptions**\n\n*shipping_exceptions object array*", "0-2": "Must be a valid fulfillment node ID set up by the merchant" }, "cols": 3, "rows": 2 } [/block] **shipping_exceptions object** - The fields below are part of the shipping_exceptions object [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "", "0-0": "**service_level** \n\n*string*", "0-1": "This field should be used if you are defining your shipping options by service_level.", "0-2": "Must be one of the following values:\n* SecondDay\n* NextDay\n* Scheduled\n* Expedited\n* Standard", "0-3": "", "1-0": "**shipping_method** \n\n*string*", "1-1": "A specific shipping method e.g. UPS Ground, UPS Next Day Air, FedEx Home, Freight.", "1-2": "", "1-3": "", "2-0": "**override_type** \n\n*string*", "2-1": "Override charge - A charge that overrides the default shipping charge.\n\nAdditional charge - A charge that is added to the default shipping charge.", "2-2": "Must be one of the following values:\n* Override charge\n* Additional charge", "2-3": "", "3-0": "**shipping_charge_amount**\n\n*float*", "3-1": "The amount added to your default shipping charge when override_type = \"Additional charge\" \n\nThe total amount charged when override_type = \"Override charge\"", "3-3": "", "4-0": "**shipping_exception_type** \n\n*string*", "4-1": "'exclusive' - The product should only be shipped using the shipping method or shipping level provided\n'restricted' - The product cannot be shipped using the shipping method or shipping level provided.", "4-2": "Must be one of the following values:\n* exclusive \n* restricted", "4-3": "", "h-4": "", "3-2": "A number >= 0" }, "cols": 3, "rows": 5 } [/block] [block:api-header] { "type": "basic", "title": "Response Body: With Returns Exception" } [/block] The following fields also will be returned if a returns exception is uploaded for this SKU [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**time_to_return** \n\n*integer*", "1-0": "**return_location_ids**\n\n*string array*", "2-0": "**return_shipping_methods**\n\n*string array*", "0-1": "The number of days after purchase a customer can return the item.", "1-1": "The ID of the returns node that was created on partner.jet.com under fulfillment settings.", "2-1": "A specific shipping method. Jet will choose its default of FedEx ground", "0-3": "", "1-3": "", "2-3": "", "2-2": "Must be one of the following values:\n* Freight\n* FedEx Ground \n* UPS Ground", "h-4": "Required", "1-2": "Must be a valid return node ID set up by the merchant", "0-2": "1 to 30\n\nMust be consistent with returns policy" }, "cols": 3, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "Response Body: With Archive" } [/block] The following fields also will be returned if an archive message is uploaded for this SKU [block:parameters] { "data": { "0-0": "**is_archived***\n\n*boolean*", "0-1": "Indicates whether the specified SKU is archived.", "0-2": "Must be one of the following values:\n* true\n* false", "0-3": "", "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "h-4": "Required", "0-4": "Yes" }, "cols": 3, "rows": 1 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Any information about the SKU that was previously uploaded (price, inventory, shipping exception) will show up here. Beginning May 29, 2017, a GET request to this endpoint will only return information about the merchant SKU (inventory and price information must now be accessed via the appropriate endpoints). As such, the following fields will no longer be returned: "inventory_by_fulfillment_node" "inventory_last_update" "price" "price_last_update" "best_marketplace_offer" "my_best_offer" "producer_id" "merchant_sku_id" "merchant_id" "jet_sku" "correlation_id" "sales_rank" "sku_created_date" [block:api-header] { "type": "basic", "title": "Response Body: SKU Upload Only" } [/block] The following fields are added by Jet in the response body. [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**status**\n\n*string*", "0-1": "The status of this merchant SKU in our product pipeline\n\nWill be one of the following values:\n* 'Available For Purchase' - The product is listed on Jet.com and can be purchased by a customer\n* 'Missing Listing Data' - More data is needed to list the product on Jet.com\n* 'Under Jet Review' - The SKU is current being processed in Jet's product catalog\n* 'Unauthorized' - The SKU is not authorized to be sold\n* 'Excluded' - The SKU is not able to be sold on Jet.com. Please see Partner Policy for more details on SKUs accepted\n* 'Archived' - The SKU is 'inactive' and is not available for purchase on Jet.com. All updated to this SKU will be ignored.", "1-0": "**sub_status**\n\n*string array*", "1-1": "Any additional information about the SKU's status. A product may exist in multiple substatuses at the same time\n\nValues with descriptions\n* Missing variation information\n* Missing title\n* Missing shipping weight\n* Missing price\n* Missing image\n* Missing category\n* Missing brand\n* Missing attribute value\n* Invalid SKU identifier\n* Invalid category - the category provided does not exist or needs to be mapped to a more specific category\n* Incorrect multipack quantity - based on our matching algorithm, the product offer may have the incorrect multipack quantity\n* Additional SKU ID needed - we need a UPC, ASIN, GTIN, etc. to identify a SKU", "0-2": "Must be one of the following values:\n* Available For Purchase \n* Missing Listing Data \n* Under Jet Review \n* Unauthorized\n* Excluded\n* Archived", "1-2": "Must be one of the following values:\n* Missing variation information\n* Missing title\n* Missing shipping weight\n* Missing price\n* Missing image\n* Missing category\n* Missing brand\n* Missing attribute value\n* Invalid SKU identifier\n* Invalid category \n* Incorrect multipack quantity\n* Additional SKU ID needed" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Request Body" } [/block] ## Required Data Jet.com maps all product offers to a universal catalog using the following data: [block:parameters] { "data": { "h-0": "Field", "h-2": "Validation", "h-1": "Description", "h-4": "Defined By", "1-0": "**multipack_quantity***\n\n*integer*", "1-1": "Number of items with the given Standard Product Code that makes up your merchant SKU (product offer).", "1-4": "Merchant", "2-2": "Required if ASIN not provided", "2-0": "**standard_product_codes**\n\n*standard_product_codes object array*", "2-1": "This is an array of product codes. Please see our product code array table below.", "2-4": "Merchant", "3-0": "**ASIN** \n\n*string*", "3-1": "Amazon standard identification number for this merchant SKU if available.", "3-2": "Required if standard_product_codes not provided\nAlphanumeric\nlength of 10", "3-4": "Merchant", "0-0": "**product_title***\n\n*string*", "0-2": "5 to 500 characters", "0-1": "The title of a given merchant sku.", "h-5": "Required", "0-5": "Yes", "1-5": "Yes", "2-5": "Required if ASIN not provided", "3-5": "Required if standard product codes not provided", "1-2": "1 to 128", "4-0": "**brand***\n\n*string*", "4-1": "The brand for your merchant SKU", "4-2": "1 to 100 characters", "5-0": "**main_image_url***\n\n*string*", "5-1": "URL location where Jet.com can access the image. The images should be 40,000 pixels or larger, There is no limit to image size.\n\n* the only unsupported image file formats are multi-layer png and gif.\n* all images' areas must be at least 40000 pixels (ie 200x200)\n* one side must be at least 200 pixels; the other side must be at least 100 pixels.", "5-2": "A valid image URL. Jet.com will not be able to accept broken image links, or \"no image\" images." }, "cols": 3, "rows": 6 } [/block] [block:callout] { "type": "danger", "title": "Multipack Quantity Errors", "body": "Multipack quantity is NOT the same as product count. As a rule of thumb, multipack quantity is the number of barcodes that make up your product offer." } [/block] **standard_product_codes object** - The following fields are part of the standard_product_codes object: [block:parameters] { "data": { "0-0": "**standard_product_code_type** \n\n*string*", "h-0": "Field", "h-2": "Validation", "h-1": "Description", "0-2": "Must be one of the following values:\n* GTIN-14\n* EAN\n* ISBN-10\n* ISBN-13\n* UPC", "1-2": "If standard product code = \n * 'GTIN-14' - 14 digits\n * 'EAN' - 13 digits\n * 'ISBN-10' - 10 digits\n * 'ISBN-13' - 13 digits \n * 'UPC'- 12 digits", "1-0": "**standard_product_code** \n\n*string*", "0-1": "The type of standard product code that is being provided", "1-1": "The standard product code associated with the type provided" }, "cols": 3, "rows": 2 } [/block] ## Minimum Listing Data On Jet.com, product offers across merchants are mapped to a universal product listing. Jet chooses the best pieces from each listing to create a unified listing. If a product offer matches to an existing product in our catalog, the retailer may need to provide little to no additional information than what is expected above. If the product is not available already, the fields below may be required. [block:parameters] { "data": { "h-0": "Field", "h-2": "Validation", "1-0": "**manufacturer** \n\n*string*", "h-1": "Description", "h-4": "Defined By:", "1-2": "1 to 100 characters", "1-1": "Manufacturer of the merchant SKU.", "1-4": "Merchant", "3-0": "**bullets**\n\n*string array*", "3-1": "Merchant SKU feature description. Jet currently allows for up to 5 bullets.", "3-2": "1 to 500 characters\nMax 5 strings", "3-4": "Merchant", "4-4": "Merchant", "5-4": "Merchant", "6-4": "Merchant", "0-0": "**product_description** \n\n*string*", "0-2": "1 to 2000 characters", "2-0": "**mfr_part_number** \n\n*string*", "2-2": "1 to 50 characters", "2-1": "Part number provided by the original manufacturer of the merchant SKU.", "2-4": "Merchant", "4-0": "**shipping_weight_pounds** \n\n*float*", "4-2": "Must be >= 0.01", "4-1": "Weight of the merchant SKU when in its shippable configuration.", "5-0": "**map_price** \n\n*float*", "5-2": "Must be >= 0.01", "6-1": "Price policy rule that determines allowed item pricing and Jet member savings shown to the consumer. Please note that this field name is misleading as it is used for all price policies and not just a MAP policy. These settings only apply to what the consumer is shown and have no impact on what a retailer is paid for an item.\n\n'101' = no restrictions on displayed product pricing or Jet member savings on the product. This setting is the normal setting used for most products.\n\n'102' = Jet member savings for the product are never advertised and are only visible to logged in Jet members after they specifically request to reveal savings. This value can be used when complying with a manufacturer's Minimum Advertised Price (MAP) policy. The API map_price field must also be used when using this setting as it is needed to display a price for advertising and initial presentation to the consumer. \n\n'103' = Jet member savings never applied to product and product orders never awarded to retailer if Jet item price is below item price sent by retailer. This value can be used when complying with a manufacturer's Unilateral Minimum Retail Price Policy. This policy setting will restrict the ability to win an order for a product if the retailer item price sent is above Jet's item price shown to the consumer.", "5-1": "Minimum Advertised Price (MAP) for the product. This price is used as the display or reference price when price policy value 102 is used via the map_implementation field.", "6-0": "**map_implementation** \n\n*string*", "6-2": "Must be one of the following values:\n* 103\n* 102\n* 101", "h-5": "Required", "4-5": "Required if shipping rates for fulfillment nodes are set up \"per pound\"", "5-5": "Required if map_implementation field = '102'", "7-0": "**jet_browse_node_id** \n\n*integer*", "7-1": "The unique ID that defines where the product will be found in the Jet.com browse structure. This can be found using the Jet Taxonomy API.", "7-2": "This must be a valid jet_browse_node_id", "8-0": "**attributes_node_specific**\n\n*attributes_node_specific array*", "8-1": "Attributes associated with the category provided", "8-2": "Minimum 1 attributes_node_specific object required if this field is provided Maximum 10 attributes_node_specific object required if this field is provided" }, "cols": 3, "rows": 9 } [/block] **attributes_node_specific** - WThe following fields are a part of the attributes_node_specific object [block:parameters] { "data": { "h-0": "Field", "h-2": "Validation", "h-1": "Description", "0-0": "**attribute_id** \n\n*integer*", "0-1": "The node attribute ID number that you get from the [Jet Taxonomy](https://www.dropbox.com/s/7zk1r9zpyfwcejt/Jet_Taxonomy.xlsx?dl=0) that corresponds with the attribute you are passing.", "1-0": "**attribute_value**\n\n*string*", "0-2": "Must be > 0", "2-0": "**attribute_value_unit**\n\n*string*", "1-1": "The value for the attribute. For example, if the attribute is size you may pass 'large' or if the the attribute is weight, you may pass '22'. For attributes like weight the unit will be passed in the next field.", "2-1": "If the attribute_value requires a unit, then you pass the unit here.", "1-2": "Must have a length between 1 and 100\nCannot be an image URL" }, "cols": 3, "rows": 3 } [/block] ## Additional Fields The fields listed below are encouraged to be used when adding a sku to Jet.com. The unified catalog that Jet may need this data to list your product. [block:parameters] { "data": { "h-0": "Field", "h-2": "Validation", "h-1": "Description", "h-4": "Defined By", "0-0": "**amazon_item_type_keyword** \n\n*string*", "0-2": "", "0-1": "ItemType allows customers to find your products as they browse to the most specific item types.", "2-0": "**number_units_for_price_per_unit** \n\n*integer*", "2-2": "", "2-1": "For Price Per Unit calculations, the number of units included in the merchant SKU. The unit of measure must be specified in order to indicate what is being measured by the unit-count.", "3-0": "**type_of_unit_for_price_per_unit** \n\n*string*", "3-1": "The type_of_unit_for_price_per_unit attribute is a label for the number_units_for_price_per_unit. The price per unit can then be constructed by dividing the selling price by the number of units and appending the text \"per unit value.\" For example, for a six-pack of soda, number_units_for_price_per_unit= 6, type_of_unit_for_price_per_unit= can, price per unit = price per can.", "4-0": "**package_length_inches** \n\n*float*", "4-2": "A number >= 0.01", "4-1": "Length of the merchant SKU when in its shippable configuration.", "5-0": "**package_width_inches** \n\n*float*", "5-2": "A number >= 0.01", "5-1": "Width of the merchant SKU when in its shippable configuration.", "6-0": "**package_height_inches** \n\n*float*", "6-1": "Height of the merchant SKU when in its shippable configuration.", "6-2": "A number >= 0.01", "7-0": "**display_length_inches** \n\n*float*", "7-2": "A number >= 0.01", "8-0": "**display_width_inches** \n\n*float*", "7-1": "Length of the merchant SKU when in its fully assembled/usable condition.", "8-2": "A number >= 0.01", "9-0": "**display_height_inches** \n\n*float*", "9-2": "A number >= 0.01", "9-1": "Height of the merchant SKU when in its fully assembled/usable condition.", "8-1": "Width of the merchant SKU when in its fully assembled/usable condition.", "10-0": "**prop_65** \n\n*boolean*", "10-1": "You must tell us if your product is subject to Proposition 65 rules and regulations. Proposition 65 requires merchants to provide California consumers with special warnings for products that contain chemicals known to cause cancer, birth defects, or other reproductive harm, if those products expose consumers to such materials above certain threshold levels. The default value for this is \"false,\" so if you do not populate this column, we will assume your product is not subject to this rule. Please view this website for more information: http://www.oehha.ca.gov/.", "10-2": "", "11-0": "**legal_disclaimer_description** \n\n*string*", "11-1": "Any legal language required to be displayed with the product.", "12-0": "**cpsia_cautionary_statements **\n\n*string array*", "12-1": "Use this field to indicate if a cautionary statement relating to the choking hazards of children's toys and games applies to your product. These cautionary statements are defined in Section 24 of the Federal Hazardous Substances Act and Section 105 of the Consumer Product Safety Improvement Act of 2008. They must be displayed on the product packaging and in certain online and catalog advertisements. You are responsible for determining if a cautionary statement applies to the product. This can be verified by contacting the product manufacturer or checking the product packaging. Cautionary statements that you select will be displayed on the product detail page. If no cautionary statement applies to the product, select \"no warning applicable\".", "12-2": "Must be one of the following values:\n* no warning applicable\n* choking hazard small parts\n* choking hazard is a small ball\n* choking hazard is a marble\n* choking hazard contains a small ball\n* choking hazard contains a marble\n* choking hazard balloon\n\nCannot have 'no warning applicable' and another reason submitted together", "13-0": "**country_of_origin** \n\n*string*", "13-1": "The country that the item was manufactured in.", "14-0": "**safety_warning** \n\n*string*", "13-2": "Maximum 50 characters", "14-1": "If applicable, use to supply any associated warnings for your product.", "15-0": "**product_tax_code** \n\n*string*", "15-2": "Must be one of the following values:\n* 'Toilet Paper'\n* 'Thermometers'\n* 'Sweatbands'\n* 'SPF Suncare Products'\n* 'Sparkling Water'\n* 'Smoking Cessation'\n* 'Shoe Insoles'\n* 'Safety Clothing'\n* 'Pet Foods'\n* 'Paper Products'\n* 'OTC Pet Meds'\n* 'OTC Medication'\n* 'Oral Care Products'\n* 'Non-Motorized Boats'\n* 'Non Taxable Product'\n* 'Mobility Equipment'\n* 'Medicated Personal Care Items'\n* 'Infant Clothing'\n* 'Helmets'\n* 'Handkerchiefs'\n* 'Generic Taxable Product'\n* 'General Grocery Items'\n* 'General Clothing'\n* 'Fluoride Toothpaste'\n* 'Feminine Hygiene Products'\n* 'Durable Medical Equipment'\n* 'Drinks under 50 Percent Juice'\n* 'Disposable Wipes'\n* 'Disposable Infant Diapers'\n* 'Dietary Supplements'\n* 'Diabetic Supplies'\n* 'Costumes'\n* 'Contraceptives'\n* 'Contact Lens Solution'\n* 'Carbonated Soft Drinks'\n* 'Car Seats'\n* 'Candy with Flour'\n* 'Candy'\n* 'Breast Pumps'\n* 'Braces and Supports'\n* 'Bottled Water Plain'\n* 'Beverages with 51 to 99 Percent Juice'\n* 'Bathing Suits'\n* 'Bandages and First Aid Kits'\n* 'Baby Supplies'\n* 'Athletic Clothing'\n* 'Adult Diapers'", "15-1": "Jet's standard code for the tax properties of a given product.", "14-2": "Maximum 2000 characters", "16-0": "**msrp** \n\n*float*", "16-2": "A number >= 0.01", "16-1": "The manufacturer's suggested retail price or list price for the product", "17-0": "**alternate_images**\n\n*alternate_images object*", "17-1": "Any additional images you would like to include for the product", "1-0": "**category_path**\n\n*string*", "1-1": "The category path for where this product is located in your categorization structure\n\ne.g. A laptop bag might belong in Electronics/Computers/Laptops/Accessories/Bags in your product's category" }, "cols": 3, "rows": 18 } [/block] **alternate_images** - The following fields are a part of the alternate_images object [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**image_slot_id**\n\n*integer*", "0-1": "The slot that the alternate image should be uploaded to. Jet.com supports up to 8 images (or 8 image slots).", "0-2": "* 1 to 8\n* Required if alternate images array is provided\n* Image slots cannot be duplicated", "1-0": "**image_url** \n\n*string*", "1-1": "URL location where Jet.com can access the image. The images should be 1500 x 1500 pixels or larger, but anything 500 x 500 pixels or larger is acceptable. There is no limit to image size.\n\n* the only unsupported image file formats are multi-layer png and gif.\n* all images' areas must be at least 40000 pixels (ie 200x200)\n* one side must be at least 200 pixels; the other side must be at least 100 pixels.", "1-2": "* A valid image URL. Jet.com will not be able to accept broken image links, or \"no image\" images.\n* Required if alternate images array is provided" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Response Body: With Price Upload" } [/block] The following fields also will be returned if price is uploaded for this SKU [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**price***\n\n*string*", "0-1": "The overall price that the merchant SKU is priced at. Note that this is the item price, and generally will not contain in it the shipping charge.", "0-3": "", "1-0": "**price_by_fulfillment_node***\n\n*price_by_fulfillment_nodes object array*", "1-1": "The price a retailer would like to set for this SKU sold at a fulfillment node", "1-2": "", "2-0": "**price_last_update***\n\n*string*", "3-0": "fulfillment_node_price", "2-1": "The timestamp for when this product's price was last updated", "3-1": "price", "2-3": "", "3-3": "The price of the merchant SKU at the fulfillment node level.", "h-4": "Required", "0-4": "yes", "1-4": "yes", "1-3": "", "2-2": "", "2-4": "yes" }, "cols": 3, "rows": 3 } [/block] \* denotes the field will always come back with the response **price_by_fulfillment_nodes object** - The below table outlines the fields that are within the fulfillment nodes array: [block:parameters] { "data": { "0-0": "**fulfillment_node_id**", "1-0": "**fulfillment_node_price**", "0-1": "The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.", "1-1": "The price of the merchant SKU at the fulfillment node level.", "0-3": "", "1-3": "", "h-1": "Type", "h-2": "Valid Values", "h-3": "Description", "h-0": "Field", "h-4": "Required", "0-4": "", "1-4": "", "0-2": "Must be a valid fulfillment node ID set up by the merchant" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Response Body: With Inventory Upload" } [/block] The following fields also will be returned if inventory is uploaded for this SKU [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**inventory_by_fulfillment_node**\n\n*inventory_by_fulfillment_nodes object array*", "0-1": "An array of fulfillment nodes to set inventory", "0-2": "", "0-3": "", "1-0": "**inventory_last_update**\n\n*string*", "1-1": "This is the timestamp for when inventory was last updated", "2-0": "quantity", "2-1": "integer", "2-3": "The quantity of inventory for the given SKU in a given fulfillment node.", "1-3": "", "h-4": "Required", "0-4": "", "1-4": "" }, "cols": 3, "rows": 2 } [/block] **inventory_by_fulfillment_nodes array** - The below table outlines the fields that are within the fulfillment nodes array: [block:parameters] { "data": { "0-0": "**fulfillment_node_id** \n\n*string*", "1-0": "**quantity** \n\n*integer*", "0-1": "The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.", "1-1": "The feed number provided for the given fulfillment node.", "0-3": "", "1-3": "", "h-2": "Validation", "h-3": "Description", "h-1": "Description", "h-0": "Field", "h-4": "Required", "0-4": "", "1-4": "" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Response Body: With Shipping Exceptions" } [/block] The following fields also will be returned if a shipping exception is uploaded for this SKU [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**fulfillment_nodes** \n\n*fulfillment_nodes object array*", "0-1": "This is an array of fulfillment nodes. Please see our fulfillment nodes array table below.", "0-3": "", "h-4": "Required" }, "cols": 3, "rows": 1 } [/block] **fulfillment_nodes array **- The following tables [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "h-4": "Required", "0-0": "**fulfillment_node_id***\n\n*string*", "0-1": "The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.", "0-3": "", "0-4": "", "1-4": "", "1-3": "", "1-1": "This array contains all fields below. There can be multiple shipping exception arrays in a fulfillment node array.", "1-0": "**shipping_exceptions**\n\n*shipping_exceptions object array*", "0-2": "Must be a valid fulfillment node ID set up by the merchant" }, "cols": 3, "rows": 2 } [/block] **shipping_exceptions object** - The fields below are part of the shipping_exceptions object [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "", "0-0": "**service_level** \n\n*string*", "0-1": "This field should be used if you are defining your shipping options by service_level.", "0-2": "Must be one of the following values:\n* SecondDay\n* NextDay\n* Scheduled\n* Expedited\n* Standard", "0-3": "", "1-0": "**shipping_method** \n\n*string*", "1-1": "A specific shipping method e.g. UPS Ground, UPS Next Day Air, FedEx Home, Freight.", "1-2": "", "1-3": "", "2-0": "**override_type** \n\n*string*", "2-1": "Override charge - A charge that overrides the default shipping charge.\n\nAdditional charge - A charge that is added to the default shipping charge.", "2-2": "Must be one of the following values:\n* Override charge\n* Additional charge", "2-3": "", "3-0": "**shipping_charge_amount**\n\n*float*", "3-1": "The amount added to your default shipping charge when override_type = \"Additional charge\" \n\nThe total amount charged when override_type = \"Override charge\"", "3-3": "", "4-0": "**shipping_exception_type** \n\n*string*", "4-1": "'exclusive' - The product should only be shipped using the shipping method or shipping level provided\n'restricted' - The product cannot be shipped using the shipping method or shipping level provided.", "4-2": "Must be one of the following values:\n* exclusive \n* restricted", "4-3": "", "h-4": "", "3-2": "A number >= 0" }, "cols": 3, "rows": 5 } [/block] [block:api-header] { "type": "basic", "title": "Response Body: With Returns Exception" } [/block] The following fields also will be returned if a returns exception is uploaded for this SKU [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**time_to_return** \n\n*integer*", "1-0": "**return_location_ids**\n\n*string array*", "2-0": "**return_shipping_methods**\n\n*string array*", "0-1": "The number of days after purchase a customer can return the item.", "1-1": "The ID of the returns node that was created on partner.jet.com under fulfillment settings.", "2-1": "A specific shipping method. Jet will choose its default of FedEx ground", "0-3": "", "1-3": "", "2-3": "", "2-2": "Must be one of the following values:\n* Freight\n* FedEx Ground \n* UPS Ground", "h-4": "Required", "1-2": "Must be a valid return node ID set up by the merchant", "0-2": "1 to 30\n\nMust be consistent with returns policy" }, "cols": 3, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "Response Body: With Archive" } [/block] The following fields also will be returned if an archive message is uploaded for this SKU [block:parameters] { "data": { "0-0": "**is_archived***\n\n*boolean*", "0-1": "Indicates whether the specified SKU is archived.", "0-2": "Must be one of the following values:\n* true\n* false", "0-3": "", "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "h-4": "Required", "0-4": "Yes" }, "cols": 3, "rows": 1 } [/block]
{"_id":"56fd2bf327b4321900186ede","createdAt":"2016-01-22T16:51:34.119Z","editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"project":"562e25f2e01a430d00c2c91e","api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"fulfillment_nodes\": [],\n  \"price\": 10,\n  \"price_last_update\": \"2015-09-10T18:07:20.0830684+00:00\"\n}"},{"status":200,"language":"json","code":"{\n  \"price\": 29.99,\n  \"fulfillment_nodes\": [\n    {\n      \"fulfillment_node_id\": \"XISNDKSANDSFNCSJKFDNFKJHFJD\",\n      \"fulfillment_node_price\": 29.99\n    },\n    {\n      \"fulfillment_node_id\": \"AKSDKDJIJDISJFIDFJIDSIFFISI\",\n      \"fulfillment_node_price\": 30.5\n    }\n  ],\n  \"price_last_update\": \"2015-09-10T18:07:20.0830684+00:00\"\n}"}]},"settings":"","url":"/merchant-skus/{user_defined_sku_id}/price","auth":"required","examples":{"codes":[]},"method":"get","params":[{"in":"query","_id":"562e8e1419e7b40d00b7c723","ref":"","required":false,"desc":"The previously created ID you will use to track and update your Merchant SKU","default":"","type":"string","name":"{user_defined_sku_id}"}]},"slug":"price-retrieval","updates":[],"link_url":"","order":9,"title":"Price Retrieval","type":"get","user":"562e25d24376430d006f1769","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body\"\n}\n[/block]\nAt Jet, the price the retailer sets is not the same as the price the customer pays.  The price set for a SKU will be the price the retailer gets paid for selling the products.  However, the price that is set will influence how competitive your product offer matches up compared to other product offers for the same SKU.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"**price***\\n\\n*string*\",\n    \"0-1\": \"The overall price that the merchant SKU is priced at. Note that this is the item price, and generally will not contain in it the shipping charge.\",\n    \"0-3\": \"\",\n    \"1-0\": \"**fulfillment_nodes***\\n\\n*fulfillment_nodes object array*\",\n    \"1-1\": \"The price a retailer would like to set for this SKU sold at a fulfillment node\",\n    \"1-2\": \"\",\n    \"2-0\": \"**price_last_update***\\n\\n*string*\",\n    \"3-0\": \"fulfillment_node_price\",\n    \"2-1\": \"The timestamp for when this product's price was last updated\",\n    \"3-1\": \"price\",\n    \"2-3\": \"\",\n    \"3-3\": \"The price of the merchant SKU at the fulfillment node level.\",\n    \"h-4\": \"Required\",\n    \"0-4\": \"yes\",\n    \"1-4\": \"yes\",\n    \"1-3\": \"\",\n    \"2-2\": \"\",\n    \"2-4\": \"yes\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\\* denotes the field will always come back with the response\n\n**fulfillment_nodes object** - The below table outlines the fields that are within the fulfillment nodes array:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**fulfillment_node_id**\",\n    \"1-0\": \"**fulfillment_node_price**\",\n    \"0-1\": \"The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.\",\n    \"1-1\": \"The price of the merchant SKU at the fulfillment node level.\",\n    \"0-3\": \"\",\n    \"1-3\": \"\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Valid Values\",\n    \"h-3\": \"Description\",\n    \"h-0\": \"Field\",\n    \"h-4\": \"Required\",\n    \"0-4\": \"\",\n    \"1-4\": \"\",\n    \"0-2\": \"Must be a valid fulfillment node ID set up by the merchant\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","editedParams":true,"sync_unique":"","version":"56fd2bf327b4321900186ec6","link_external":false,"parentDoc":null,"isReference":false,"__v":0,"category":"56fd2bf327b4321900186ec9","childrenPages":[]}

getPrice Retrieval


Query Params

user_defined_sku_id:
string
The previously created ID you will use to track and update your Merchant SKU
[block:api-header] { "type": "basic", "title": "Response Body" } [/block] At Jet, the price the retailer sets is not the same as the price the customer pays. The price set for a SKU will be the price the retailer gets paid for selling the products. However, the price that is set will influence how competitive your product offer matches up compared to other product offers for the same SKU. [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**price***\n\n*string*", "0-1": "The overall price that the merchant SKU is priced at. Note that this is the item price, and generally will not contain in it the shipping charge.", "0-3": "", "1-0": "**fulfillment_nodes***\n\n*fulfillment_nodes object array*", "1-1": "The price a retailer would like to set for this SKU sold at a fulfillment node", "1-2": "", "2-0": "**price_last_update***\n\n*string*", "3-0": "fulfillment_node_price", "2-1": "The timestamp for when this product's price was last updated", "3-1": "price", "2-3": "", "3-3": "The price of the merchant SKU at the fulfillment node level.", "h-4": "Required", "0-4": "yes", "1-4": "yes", "1-3": "", "2-2": "", "2-4": "yes" }, "cols": 3, "rows": 3 } [/block] \* denotes the field will always come back with the response **fulfillment_nodes object** - The below table outlines the fields that are within the fulfillment nodes array: [block:parameters] { "data": { "0-0": "**fulfillment_node_id**", "1-0": "**fulfillment_node_price**", "0-1": "The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.", "1-1": "The price of the merchant SKU at the fulfillment node level.", "0-3": "", "1-3": "", "h-1": "Description", "h-2": "Valid Values", "h-3": "Description", "h-0": "Field", "h-4": "Required", "0-4": "", "1-4": "", "0-2": "Must be a valid fulfillment node ID set up by the merchant" }, "cols": 3, "rows": 2 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response Body" } [/block] At Jet, the price the retailer sets is not the same as the price the customer pays. The price set for a SKU will be the price the retailer gets paid for selling the products. However, the price that is set will influence how competitive your product offer matches up compared to other product offers for the same SKU. [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**price***\n\n*string*", "0-1": "The overall price that the merchant SKU is priced at. Note that this is the item price, and generally will not contain in it the shipping charge.", "0-3": "", "1-0": "**fulfillment_nodes***\n\n*fulfillment_nodes object array*", "1-1": "The price a retailer would like to set for this SKU sold at a fulfillment node", "1-2": "", "2-0": "**price_last_update***\n\n*string*", "3-0": "fulfillment_node_price", "2-1": "The timestamp for when this product's price was last updated", "3-1": "price", "2-3": "", "3-3": "The price of the merchant SKU at the fulfillment node level.", "h-4": "Required", "0-4": "yes", "1-4": "yes", "1-3": "", "2-2": "", "2-4": "yes" }, "cols": 3, "rows": 3 } [/block] \* denotes the field will always come back with the response **fulfillment_nodes object** - The below table outlines the fields that are within the fulfillment nodes array: [block:parameters] { "data": { "0-0": "**fulfillment_node_id**", "1-0": "**fulfillment_node_price**", "0-1": "The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.", "1-1": "The price of the merchant SKU at the fulfillment node level.", "0-3": "", "1-3": "", "h-1": "Description", "h-2": "Valid Values", "h-3": "Description", "h-0": "Field", "h-4": "Required", "0-4": "", "1-4": "", "0-2": "Must be a valid fulfillment node ID set up by the merchant" }, "cols": 3, "rows": 2 } [/block]
{"_id":"56fd2bf327b4321900186edf","__v":0,"githubsync":"","hidden":false,"title":"Inventory Retrieval","api":{"settings":"","url":"/merchant-skus/{user_defined_sku_id}/inventory","auth":"required","examples":{"codes":[]},"method":"get","params":[{"default":"","type":"string","name":"{user_defined_sku_id}","in":"query","_id":"562e912f36d1140d00120b51","ref":"","required":false,"desc":"The previously created ID you will use to track and update your Merchant SKU"}],"results":{"codes":[{"status":200,"code":"{\n  \"fulfillment_nodes\": [\n    {\n      \"fulfillment_node_id\": \"XISNDKSANDSFNCSJKFDNFKJHFJD\",\n      \"quantity\": 100\n    },\n    {\n      \"fulfillment_node_id\": \"AKSDKDJIJDISJFIDFJIDSIFFISI\",\n      \"quantity\": 20\n    }\n  ],\n  \"inventory_last_update\":\"2015-11-03T11:48:30.6063244+00:00\"\n}","language":"json"},{"status":200,"language":"json","code":"{\n  \"fulfillment_nodes\": [],\n  \"inventory_last_update\": \"2016-01-22T16:37:10.6660795+00:00\"\n}"}]}},"category":"56fd2bf327b4321900186ec9","createdAt":"2015-10-26T20:46:39.958Z","editedParams":true,"isReference":false,"parentDoc":null,"sync_unique":"","updates":[],"user":"562e25d24376430d006f1769","editedParams2":true,"excerpt":"","link_external":false,"link_url":"","order":10,"project":"562e25f2e01a430d00c2c91e","slug":"check-inventory","type":"get","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body\"\n}\n[/block]\nThe inventory returned from this endpoint represents the number in the feed, not the quantity that is currently sellable on Jet.com\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"**fulfillment_nodes**\\n\\n*fulfillment_nodes object array*\",\n    \"0-1\": \"An array of fulfillment nodes to set inventory\",\n    \"0-2\": \"\",\n    \"0-3\": \"\",\n    \"1-0\": \"**inventory_last_update**\\n\\n*string*\",\n    \"1-1\": \"This is the timestamp for when inventory was last updated\",\n    \"2-0\": \"quantity\",\n    \"2-1\": \"integer\",\n    \"2-3\": \"The quantity of inventory for the given SKU in a given fulfillment node.\",\n    \"1-3\": \"\",\n    \"h-4\": \"Required\",\n    \"0-4\": \"\",\n    \"1-4\": \"\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n**fulfillment_nodes array** - The below table outlines the fields that are within the fulfillment nodes array:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**fulfillment_node_id** \\n\\n*string*\",\n    \"1-0\": \"**quantity** \\n\\n*integer*\",\n    \"0-1\": \"The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.\",\n    \"1-1\": \"The feed number provided for the given fulfillment node.\",\n    \"0-3\": \"\",\n    \"1-3\": \"\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"h-1\": \"Description\",\n    \"h-0\": \"Field\",\n    \"h-4\": \"Required\",\n    \"0-4\": \"\",\n    \"1-4\": \"\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Inventory Quantity\",\n  \"body\": \"Please note that the inventory quantity returned in this message is the quantity sent through the feed.  The quantity will not decrement as items are sold.\"\n}\n[/block]","version":"56fd2bf327b4321900186ec6","childrenPages":[]}

getInventory Retrieval


Query Params

user_defined_sku_id:
string
The previously created ID you will use to track and update your Merchant SKU
[block:api-header] { "type": "basic", "title": "Response Body" } [/block] The inventory returned from this endpoint represents the number in the feed, not the quantity that is currently sellable on Jet.com [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**fulfillment_nodes**\n\n*fulfillment_nodes object array*", "0-1": "An array of fulfillment nodes to set inventory", "0-2": "", "0-3": "", "1-0": "**inventory_last_update**\n\n*string*", "1-1": "This is the timestamp for when inventory was last updated", "2-0": "quantity", "2-1": "integer", "2-3": "The quantity of inventory for the given SKU in a given fulfillment node.", "1-3": "", "h-4": "Required", "0-4": "", "1-4": "" }, "cols": 3, "rows": 2 } [/block] **fulfillment_nodes array** - The below table outlines the fields that are within the fulfillment nodes array: [block:parameters] { "data": { "0-0": "**fulfillment_node_id** \n\n*string*", "1-0": "**quantity** \n\n*integer*", "0-1": "The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.", "1-1": "The feed number provided for the given fulfillment node.", "0-3": "", "1-3": "", "h-2": "Validation", "h-3": "Description", "h-1": "Description", "h-0": "Field", "h-4": "Required", "0-4": "", "1-4": "" }, "cols": 3, "rows": 2 } [/block] [block:callout] { "type": "danger", "title": "Inventory Quantity", "body": "Please note that the inventory quantity returned in this message is the quantity sent through the feed. The quantity will not decrement as items are sold." } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response Body" } [/block] The inventory returned from this endpoint represents the number in the feed, not the quantity that is currently sellable on Jet.com [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**fulfillment_nodes**\n\n*fulfillment_nodes object array*", "0-1": "An array of fulfillment nodes to set inventory", "0-2": "", "0-3": "", "1-0": "**inventory_last_update**\n\n*string*", "1-1": "This is the timestamp for when inventory was last updated", "2-0": "quantity", "2-1": "integer", "2-3": "The quantity of inventory for the given SKU in a given fulfillment node.", "1-3": "", "h-4": "Required", "0-4": "", "1-4": "" }, "cols": 3, "rows": 2 } [/block] **fulfillment_nodes array** - The below table outlines the fields that are within the fulfillment nodes array: [block:parameters] { "data": { "0-0": "**fulfillment_node_id** \n\n*string*", "1-0": "**quantity** \n\n*integer*", "0-1": "The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.", "1-1": "The feed number provided for the given fulfillment node.", "0-3": "", "1-3": "", "h-2": "Validation", "h-3": "Description", "h-1": "Description", "h-0": "Field", "h-4": "Required", "0-4": "", "1-4": "" }, "cols": 3, "rows": 2 } [/block] [block:callout] { "type": "danger", "title": "Inventory Quantity", "body": "Please note that the inventory quantity returned in this message is the quantity sent through the feed. The quantity will not decrement as items are sold." } [/block]
{"_id":"56fd2bf327b4321900186ee0","title":"Variation Retrieval","category":"56fd2bf327b4321900186ec9","editedParams2":true,"excerpt":"","isReference":false,"link_url":"","parentDoc":null,"project":"562e25f2e01a430d00c2c91e","type":"get","version":"56fd2bf327b4321900186ec6","__v":0,"api":{"examples":{"codes":[]},"method":"get","params":[{"type":"string","name":"{user_defined_sku_id}","in":"query","_id":"562e8e1419e7b40d00b7c723","ref":"","required":false,"desc":"The previously created ID you will use to track and update your Merchant SKU","default":""}],"results":{"codes":[{"status":200,"language":"json","code":""},{"code":"","language":"json","status":400}]},"settings":"","url":"/merchant-skus/{user_defined_sku_id}/variation","auth":"required"},"editedParams":true,"order":11,"sync_unique":"","slug":"variation-upload","updates":[],"user":"562e25d24376430d006f1769","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"**relationship*** \\n\\n*string*\",\n    \"0-1\": \"This field is required if you are setting up a Variation relationship between a set merchant SKUs.\\n\\nValid Values:\\n* 'Variation' - Products in a group vary by a few attributes\\n* 'Accessory' - Products in a  group are complementary\",\n    \"0-2\": \"Must be one of the following values:\\n* Variation\\n* Accessory\",\n    \"0-3\": \"\",\n    \"1-0\": \"**variation_refinements*** \\n\\n*integer array*\",\n    \"2-0\": \"**children_skus*** \\n\\n*string array*\",\n    \"1-3\": \"\",\n    \"2-3\": \"\",\n    \"1-1\": \"The attribute IDs associated with the characteristic the parent-children SKUs relate on.\",\n    \"1-2\": \"A Jet attribute or attributes that were uploaded for the products associated with the variation\\n\\nEach integer must be > 0\",\n    \"2-1\": \"The merchant SKUs that are the child SKUs.\",\n    \"2-2\": \"Must be an uploaded merchant SKU\",\n    \"h-4\": \"Required\",\n    \"0-4\": \"Yes\",\n    \"1-4\": \"Yes\",\n    \"2-4\": \"Yes\",\n    \"3-0\": \"**group_title** \\n\\n*string*\",\n    \"3-1\": \"The title for the variation group  to be shown as the title on the product detail page\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\\* denotes the field is required","createdAt":"2016-02-03T13:27:47.363Z","githubsync":"","hidden":false,"link_external":false,"childrenPages":[]}

getVariation Retrieval


Query Params

user_defined_sku_id:
string
The previously created ID you will use to track and update your Merchant SKU
[block:api-header] { "type": "basic", "title": "Response Body" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**relationship*** \n\n*string*", "0-1": "This field is required if you are setting up a Variation relationship between a set merchant SKUs.\n\nValid Values:\n* 'Variation' - Products in a group vary by a few attributes\n* 'Accessory' - Products in a group are complementary", "0-2": "Must be one of the following values:\n* Variation\n* Accessory", "0-3": "", "1-0": "**variation_refinements*** \n\n*integer array*", "2-0": "**children_skus*** \n\n*string array*", "1-3": "", "2-3": "", "1-1": "The attribute IDs associated with the characteristic the parent-children SKUs relate on.", "1-2": "A Jet attribute or attributes that were uploaded for the products associated with the variation\n\nEach integer must be > 0", "2-1": "The merchant SKUs that are the child SKUs.", "2-2": "Must be an uploaded merchant SKU", "h-4": "Required", "0-4": "Yes", "1-4": "Yes", "2-4": "Yes", "3-0": "**group_title** \n\n*string*", "3-1": "The title for the variation group to be shown as the title on the product detail page" }, "cols": 3, "rows": 4 } [/block] \* denotes the field is required

Definition

{{ api_url }}{{ page_api_url }}


[block:api-header] { "type": "basic", "title": "Response Body" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**relationship*** \n\n*string*", "0-1": "This field is required if you are setting up a Variation relationship between a set merchant SKUs.\n\nValid Values:\n* 'Variation' - Products in a group vary by a few attributes\n* 'Accessory' - Products in a group are complementary", "0-2": "Must be one of the following values:\n* Variation\n* Accessory", "0-3": "", "1-0": "**variation_refinements*** \n\n*integer array*", "2-0": "**children_skus*** \n\n*string array*", "1-3": "", "2-3": "", "1-1": "The attribute IDs associated with the characteristic the parent-children SKUs relate on.", "1-2": "A Jet attribute or attributes that were uploaded for the products associated with the variation\n\nEach integer must be > 0", "2-1": "The merchant SKUs that are the child SKUs.", "2-2": "Must be an uploaded merchant SKU", "h-4": "Required", "0-4": "Yes", "1-4": "Yes", "2-4": "Yes", "3-0": "**group_title** \n\n*string*", "3-1": "The title for the variation group to be shown as the title on the product detail page" }, "cols": 3, "rows": 4 } [/block] \* denotes the field is required
{"_id":"56fd2bf327b4321900186ee1","hidden":false,"next":{"description":"","pages":[]},"parentDoc":null,"user":"562e25d24376430d006f1769","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request Body\"\n}\n[/block]\nThe shipping exceptions call is used to set up specific methods and costs for individual SKUs that will override your default settings, with the ability to drill down to the fulfillment node level.\n\nThe fields for shipping exceptions are outlined below:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"**fulfillment_nodes** \\n\\n*fulfillment_nodes object array*\",\n    \"0-1\": \"This is an array of fulfillment nodes. Please see our fulfillment nodes array table below.\",\n    \"0-3\": \"\",\n    \"h-4\": \"Required\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n**fulfillment_nodes array** - The fields below are part of a fulfillment_nodes object\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"h-4\": \"Required\",\n    \"0-0\": \"**fulfillment_node_id**\\n\\n*string*\",\n    \"0-1\": \"The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.\",\n    \"0-3\": \"\",\n    \"0-4\": \"\",\n    \"1-4\": \"\",\n    \"1-3\": \"\",\n    \"1-1\": \"This array contains all fields below. There can be multiple shipping exception arrays in a fulfillment node array.\",\n    \"1-0\": \"**shipping_exceptions**\\n\\n*shipping_exceptions object array*\",\n    \"0-2\": \"Must be a valid fulfillment node ID set up by the merchant\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n**shipping_exceptions object** - The fields below are part of the shipping_exceptions object\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"\",\n    \"0-0\": \"**service_level** \\n\\n*string*\",\n    \"0-1\": \"This field should be used if you are defining your shipping options by service_level.\",\n    \"0-2\": \"Either service_level or shipping_method must be provided\\n\\nMust be one of the following values:\\n* Second Day\\n* Next Day\\n* Scheduled (freight)\\n* Expedited\\n* Standard\",\n    \"0-3\": \"\",\n    \"1-0\": \"**shipping_method** \\n\\n*string*\",\n    \"1-1\": \"A specific shipping method e.g. UPS Ground, UPS Next Day Air, FedEx Home, Freight.\",\n    \"1-2\": \"Either service_level or shipping_method must be provided\\n\\nMust be one of the following values:\\n\\n  * DHL Global Mail\\n  * FedEx 2 Day\\n  * FedEx Express Saver\\n  * FedEx First Overnight\\n  * FedEx Ground\\n  * FedEx Home Delivery\\n  * FedEx Priority Overnight\\n  * FedEx Smart Post\\n  * FedEx Standard Overnight\\n  * Freight\\n  * Ontrac Ground\\n  * UPS 2nd Day Air AM\\n  * UPS 2nd Day Air\\n  * UPS 3 Day Select\\n  * UPS Ground\\n  * UPS Mail Innovations\\n  * UPS Next Day Air Saver\\n  * UPS Next Day Air\\n  * UPS SurePost\\n  * USPS First Class Mail\\n  * USPS Media Mail\\n  * USPS Priority Mail Express\\n  * USPS Priority Mail\\n  * USPS Standard Post\",\n    \"1-3\": \"\",\n    \"2-0\": \"**override_type** \\n\\n*string*\",\n    \"2-1\": \"Override charge - A charge that overrides the default shipping charge.\\n\\nAdditional charge - A charge that is added to the default shipping charge.\",\n    \"2-2\": \"Must be one of the following values:\\n* Override charge\\n* Additional charge\\n\\nIf shipping_exception_type is \\\"restricted\\\", override_type and shipping_charge_amount should not be provided\\n\\nIf the override_type is \\\"Additional charge\\\" the shipping method or service level provided must exist on the fulfillment node\",\n    \"2-3\": \"\",\n    \"3-0\": \"**shipping_charge_amount**\\n\\n*float*\",\n    \"3-1\": \"The amount added to your default shipping charge when override_type = \\\"Additional charge\\\" \\n\\nThe total amount charged when override_type = \\\"Override charge\\\"\",\n    \"3-3\": \"\",\n    \"4-0\": \"**shipping_exception_type*** \\n\\n*string*\",\n    \"4-1\": \"Indicates if you want the product to be shipped exclusively (only with) or restrictively (not including) via the shipping level of shipping method provided\\n\\nValid Values\\n* restricted - The product cannot be shipped using the shipping method or shipping level provided.  \\n\\nCan only be applied to shipping methods or service levels configured in the Partner Portal. There can be many restricted shipping methods per fulfillment node.\\n\\n* exclusive - The product should only be shipped using the shipping method or shipping level provided.  \\n\\nThere can only be one exclusive shipping method per fulfillment node.\\n\\n* include - The product will be priced normally under the Jet.com pricing algorithm.  \\n\\nIf the shipping method                    determined for the order has an exception on it, the appropriate override_type will be applied. Can only be applied to shipping methods or service levels configured in the Partner Portal.\",\n    \"4-2\": \"Must be one of the following values:\\n* exclusive \\n* restricted\\n* include\",\n    \"4-3\": \"\",\n    \"h-4\": \"\",\n    \"3-2\": \"A number >= 0\\n\\nRequired if override_type is provided\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n\\* denotes that field is required\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use Cases\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Example request bodies below\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"fulfillment_nodes\\\": [\\n    {\\n      \\\"fulfillment_node_id\\\": \\\"XISNDKSANDSFNCSJKFDNFKJHFJD\\\",\\n      \\\"shipping_exceptions\\\": [\\n        {\\n          \\\"service_level\\\": \\\"Standard\\\",\\n          \\\"shipping_exception_type\\\": \\\"restricted\\\"\\n        },\\n        {\\n          \\\"shipping_method\\\": \\\"UPS Ground\\\",\\n          \\\"shipping_exception_type\\\": \\\"restricted\\\"\\n        }\\n      ]\\n    },\\n    {\\n      \\\"fulfillment_node_id\\\": \\\"1234DKSANDSFNCSJKFDNFKJHFAZ\\\",\\n      \\\"shipping_exceptions\\\": [\\n        {\\n          \\\"shipping_method\\\": \\\"Freight\\\",\\n          \\\"override_type\\\": \\\"Additional charge\\\",\\n          \\\"shipping_charge_amount\\\": 3.25,\\n          \\\"shipping_exception_type\\\": \\\"exclusive\\\"\\n        }\\n      ]\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Mixed Example\"\n    },\n    {\n      \"code\": \"{\\n  \\\"fulfillment_nodes\\\": [\\n    {\\n      \\\"fulfillment_node_id\\\": \\\"1234DKSANDSFNCSJKFDNFKJHFAZ\\\",\\n      \\\"shipping_exceptions\\\": [\\n        {\\n          \\\"shipping_method\\\": \\\"Freight\\\",\\n          \\\"override_type\\\": \\\"Additional charge\\\",\\n          \\\"shipping_charge_amount\\\": 3.25,\\n          \\\"shipping_exception_type\\\": \\\"exclusive\\\"\\n        }\\n      ]\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Exclusive\"\n    },\n    {\n      \"code\": \"{\\n  \\\"fulfillment_nodes\\\": [\\n    {\\n      \\\"fulfillment_node_id\\\": \\\"XISNDKSANDSFNCSJKFDNFKJHFJD\\\",\\n      \\\"shipping_exceptions\\\": [\\n        {\\n          \\\"service_level\\\": \\\"Standard\\\",\\n          \\\"shipping_exception_type\\\": \\\"restricted\\\"\\n        },\\n        {\\n          \\\"shipping_method\\\": \\\"UPS Ground\\\",\\n          \\\"shipping_exception_type\\\": \\\"restricted\\\"\\n        }\\n      ]\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Multiple Restricted\"\n    },\n    {\n      \"code\": \"{}\",\n      \"language\": \"json\",\n      \"name\": \"Empty JSON object clear\"\n    },\n    {\n      \"code\": \"{\\n\\t\\\"fulfillment_nodes\\\":[]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Empty fulfillment_nodes array clear\"\n    },\n    {\n      \"code\": \"{\\n  \\\"fulfillment_nodes\\\": [\\n    {\\n      \\\"fulfillment_node_id\\\": \\\"1234DKSANDSFNCSJKFDNFKJHFAZ\\\",\\n      \\\"shipping_exceptions\\\": [\\n        {\\n          \\\"shipping_method\\\": \\\"FedEx Home Delivery\\\", //if FedEx Home Delivery is chosen as the shipping method for the order, we'll add an additional $1\\n          \\\"override_type\\\": \\\"Additional charge\\\",\\n          \\\"shipping_charge_amount\\\": 1,\\n          \\\"shipping_exception_type\\\": \\\"include\\\"\\n        },\\n        {\\n          \\\"shipping_method\\\": \\\"UPS Next Day Air\\\", \\n          \\\"override_type\\\": \\\"Override charge\\\",\\n          \\\"shipping_charge_amount\\\": 100,\\n          \\\"shipping_exception_type\\\": \\\"include\\\"\\n        }\\n      ]\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Include Exception Type\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","githubsync":"","project":"562e25f2e01a430d00c2c91e","updates":[],"api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"user_defined_sku_id","in":"path","_id":"562e8e1419e7b40d00b7c723","ref":"","required":false,"desc":"The previously created ID you will use to track and update your Merchant SKU","default":"","type":"string"}],"results":{"codes":[{"code":"","language":"json","status":200}]},"settings":"","url":"/merchant-skus/{user_defined_sku_id}/shippingexception"},"excerpt":"","link_url":"","slug":"shipping-exception-upload","title":"Shipping Exception Retrieval","type":"get","version":"56fd2bf327b4321900186ec6","category":"56fd2bf327b4321900186ec9","createdAt":"2016-02-03T13:29:26.139Z","editedParams2":true,"isReference":false,"link_external":false,"order":12,"sync_unique":"","__v":1,"editedParams":true,"childrenPages":[]}

getShipping Exception Retrieval


Path Params

user_defined_sku_id:
string
The previously created ID you will use to track and update your Merchant SKU
[block:api-header] { "type": "basic", "title": "Request Body" } [/block] The shipping exceptions call is used to set up specific methods and costs for individual SKUs that will override your default settings, with the ability to drill down to the fulfillment node level. The fields for shipping exceptions are outlined below: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**fulfillment_nodes** \n\n*fulfillment_nodes object array*", "0-1": "This is an array of fulfillment nodes. Please see our fulfillment nodes array table below.", "0-3": "", "h-4": "Required" }, "cols": 3, "rows": 1 } [/block] **fulfillment_nodes array** - The fields below are part of a fulfillment_nodes object [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "h-4": "Required", "0-0": "**fulfillment_node_id**\n\n*string*", "0-1": "The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.", "0-3": "", "0-4": "", "1-4": "", "1-3": "", "1-1": "This array contains all fields below. There can be multiple shipping exception arrays in a fulfillment node array.", "1-0": "**shipping_exceptions**\n\n*shipping_exceptions object array*", "0-2": "Must be a valid fulfillment node ID set up by the merchant" }, "cols": 3, "rows": 2 } [/block] **shipping_exceptions object** - The fields below are part of the shipping_exceptions object [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "", "0-0": "**service_level** \n\n*string*", "0-1": "This field should be used if you are defining your shipping options by service_level.", "0-2": "Either service_level or shipping_method must be provided\n\nMust be one of the following values:\n* Second Day\n* Next Day\n* Scheduled (freight)\n* Expedited\n* Standard", "0-3": "", "1-0": "**shipping_method** \n\n*string*", "1-1": "A specific shipping method e.g. UPS Ground, UPS Next Day Air, FedEx Home, Freight.", "1-2": "Either service_level or shipping_method must be provided\n\nMust be one of the following values:\n\n * DHL Global Mail\n * FedEx 2 Day\n * FedEx Express Saver\n * FedEx First Overnight\n * FedEx Ground\n * FedEx Home Delivery\n * FedEx Priority Overnight\n * FedEx Smart Post\n * FedEx Standard Overnight\n * Freight\n * Ontrac Ground\n * UPS 2nd Day Air AM\n * UPS 2nd Day Air\n * UPS 3 Day Select\n * UPS Ground\n * UPS Mail Innovations\n * UPS Next Day Air Saver\n * UPS Next Day Air\n * UPS SurePost\n * USPS First Class Mail\n * USPS Media Mail\n * USPS Priority Mail Express\n * USPS Priority Mail\n * USPS Standard Post", "1-3": "", "2-0": "**override_type** \n\n*string*", "2-1": "Override charge - A charge that overrides the default shipping charge.\n\nAdditional charge - A charge that is added to the default shipping charge.", "2-2": "Must be one of the following values:\n* Override charge\n* Additional charge\n\nIf shipping_exception_type is \"restricted\", override_type and shipping_charge_amount should not be provided\n\nIf the override_type is \"Additional charge\" the shipping method or service level provided must exist on the fulfillment node", "2-3": "", "3-0": "**shipping_charge_amount**\n\n*float*", "3-1": "The amount added to your default shipping charge when override_type = \"Additional charge\" \n\nThe total amount charged when override_type = \"Override charge\"", "3-3": "", "4-0": "**shipping_exception_type*** \n\n*string*", "4-1": "Indicates if you want the product to be shipped exclusively (only with) or restrictively (not including) via the shipping level of shipping method provided\n\nValid Values\n* restricted - The product cannot be shipped using the shipping method or shipping level provided. \n\nCan only be applied to shipping methods or service levels configured in the Partner Portal. There can be many restricted shipping methods per fulfillment node.\n\n* exclusive - The product should only be shipped using the shipping method or shipping level provided. \n\nThere can only be one exclusive shipping method per fulfillment node.\n\n* include - The product will be priced normally under the Jet.com pricing algorithm. \n\nIf the shipping method determined for the order has an exception on it, the appropriate override_type will be applied. Can only be applied to shipping methods or service levels configured in the Partner Portal.", "4-2": "Must be one of the following values:\n* exclusive \n* restricted\n* include", "4-3": "", "h-4": "", "3-2": "A number >= 0\n\nRequired if override_type is provided" }, "cols": 3, "rows": 5 } [/block] \* denotes that field is required [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Example request bodies below", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"XISNDKSANDSFNCSJKFDNFKJHFJD\",\n \"shipping_exceptions\": [\n {\n \"service_level\": \"Standard\",\n \"shipping_exception_type\": \"restricted\"\n },\n {\n \"shipping_method\": \"UPS Ground\",\n \"shipping_exception_type\": \"restricted\"\n }\n ]\n },\n {\n \"fulfillment_node_id\": \"1234DKSANDSFNCSJKFDNFKJHFAZ\",\n \"shipping_exceptions\": [\n {\n \"shipping_method\": \"Freight\",\n \"override_type\": \"Additional charge\",\n \"shipping_charge_amount\": 3.25,\n \"shipping_exception_type\": \"exclusive\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "Mixed Example" }, { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"1234DKSANDSFNCSJKFDNFKJHFAZ\",\n \"shipping_exceptions\": [\n {\n \"shipping_method\": \"Freight\",\n \"override_type\": \"Additional charge\",\n \"shipping_charge_amount\": 3.25,\n \"shipping_exception_type\": \"exclusive\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "Exclusive" }, { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"XISNDKSANDSFNCSJKFDNFKJHFJD\",\n \"shipping_exceptions\": [\n {\n \"service_level\": \"Standard\",\n \"shipping_exception_type\": \"restricted\"\n },\n {\n \"shipping_method\": \"UPS Ground\",\n \"shipping_exception_type\": \"restricted\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "Multiple Restricted" }, { "code": "{}", "language": "json", "name": "Empty JSON object clear" }, { "code": "{\n\t\"fulfillment_nodes\":[]\n}", "language": "json", "name": "Empty fulfillment_nodes array clear" }, { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"1234DKSANDSFNCSJKFDNFKJHFAZ\",\n \"shipping_exceptions\": [\n {\n \"shipping_method\": \"FedEx Home Delivery\", //if FedEx Home Delivery is chosen as the shipping method for the order, we'll add an additional $1\n \"override_type\": \"Additional charge\",\n \"shipping_charge_amount\": 1,\n \"shipping_exception_type\": \"include\"\n },\n {\n \"shipping_method\": \"UPS Next Day Air\", \n \"override_type\": \"Override charge\",\n \"shipping_charge_amount\": 100,\n \"shipping_exception_type\": \"include\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "Include Exception Type" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


[block:api-header] { "type": "basic", "title": "Request Body" } [/block] The shipping exceptions call is used to set up specific methods and costs for individual SKUs that will override your default settings, with the ability to drill down to the fulfillment node level. The fields for shipping exceptions are outlined below: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**fulfillment_nodes** \n\n*fulfillment_nodes object array*", "0-1": "This is an array of fulfillment nodes. Please see our fulfillment nodes array table below.", "0-3": "", "h-4": "Required" }, "cols": 3, "rows": 1 } [/block] **fulfillment_nodes array** - The fields below are part of a fulfillment_nodes object [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "h-4": "Required", "0-0": "**fulfillment_node_id**\n\n*string*", "0-1": "The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.", "0-3": "", "0-4": "", "1-4": "", "1-3": "", "1-1": "This array contains all fields below. There can be multiple shipping exception arrays in a fulfillment node array.", "1-0": "**shipping_exceptions**\n\n*shipping_exceptions object array*", "0-2": "Must be a valid fulfillment node ID set up by the merchant" }, "cols": 3, "rows": 2 } [/block] **shipping_exceptions object** - The fields below are part of the shipping_exceptions object [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "", "0-0": "**service_level** \n\n*string*", "0-1": "This field should be used if you are defining your shipping options by service_level.", "0-2": "Either service_level or shipping_method must be provided\n\nMust be one of the following values:\n* Second Day\n* Next Day\n* Scheduled (freight)\n* Expedited\n* Standard", "0-3": "", "1-0": "**shipping_method** \n\n*string*", "1-1": "A specific shipping method e.g. UPS Ground, UPS Next Day Air, FedEx Home, Freight.", "1-2": "Either service_level or shipping_method must be provided\n\nMust be one of the following values:\n\n * DHL Global Mail\n * FedEx 2 Day\n * FedEx Express Saver\n * FedEx First Overnight\n * FedEx Ground\n * FedEx Home Delivery\n * FedEx Priority Overnight\n * FedEx Smart Post\n * FedEx Standard Overnight\n * Freight\n * Ontrac Ground\n * UPS 2nd Day Air AM\n * UPS 2nd Day Air\n * UPS 3 Day Select\n * UPS Ground\n * UPS Mail Innovations\n * UPS Next Day Air Saver\n * UPS Next Day Air\n * UPS SurePost\n * USPS First Class Mail\n * USPS Media Mail\n * USPS Priority Mail Express\n * USPS Priority Mail\n * USPS Standard Post", "1-3": "", "2-0": "**override_type** \n\n*string*", "2-1": "Override charge - A charge that overrides the default shipping charge.\n\nAdditional charge - A charge that is added to the default shipping charge.", "2-2": "Must be one of the following values:\n* Override charge\n* Additional charge\n\nIf shipping_exception_type is \"restricted\", override_type and shipping_charge_amount should not be provided\n\nIf the override_type is \"Additional charge\" the shipping method or service level provided must exist on the fulfillment node", "2-3": "", "3-0": "**shipping_charge_amount**\n\n*float*", "3-1": "The amount added to your default shipping charge when override_type = \"Additional charge\" \n\nThe total amount charged when override_type = \"Override charge\"", "3-3": "", "4-0": "**shipping_exception_type*** \n\n*string*", "4-1": "Indicates if you want the product to be shipped exclusively (only with) or restrictively (not including) via the shipping level of shipping method provided\n\nValid Values\n* restricted - The product cannot be shipped using the shipping method or shipping level provided. \n\nCan only be applied to shipping methods or service levels configured in the Partner Portal. There can be many restricted shipping methods per fulfillment node.\n\n* exclusive - The product should only be shipped using the shipping method or shipping level provided. \n\nThere can only be one exclusive shipping method per fulfillment node.\n\n* include - The product will be priced normally under the Jet.com pricing algorithm. \n\nIf the shipping method determined for the order has an exception on it, the appropriate override_type will be applied. Can only be applied to shipping methods or service levels configured in the Partner Portal.", "4-2": "Must be one of the following values:\n* exclusive \n* restricted\n* include", "4-3": "", "h-4": "", "3-2": "A number >= 0\n\nRequired if override_type is provided" }, "cols": 3, "rows": 5 } [/block] \* denotes that field is required [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Example request bodies below", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"XISNDKSANDSFNCSJKFDNFKJHFJD\",\n \"shipping_exceptions\": [\n {\n \"service_level\": \"Standard\",\n \"shipping_exception_type\": \"restricted\"\n },\n {\n \"shipping_method\": \"UPS Ground\",\n \"shipping_exception_type\": \"restricted\"\n }\n ]\n },\n {\n \"fulfillment_node_id\": \"1234DKSANDSFNCSJKFDNFKJHFAZ\",\n \"shipping_exceptions\": [\n {\n \"shipping_method\": \"Freight\",\n \"override_type\": \"Additional charge\",\n \"shipping_charge_amount\": 3.25,\n \"shipping_exception_type\": \"exclusive\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "Mixed Example" }, { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"1234DKSANDSFNCSJKFDNFKJHFAZ\",\n \"shipping_exceptions\": [\n {\n \"shipping_method\": \"Freight\",\n \"override_type\": \"Additional charge\",\n \"shipping_charge_amount\": 3.25,\n \"shipping_exception_type\": \"exclusive\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "Exclusive" }, { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"XISNDKSANDSFNCSJKFDNFKJHFJD\",\n \"shipping_exceptions\": [\n {\n \"service_level\": \"Standard\",\n \"shipping_exception_type\": \"restricted\"\n },\n {\n \"shipping_method\": \"UPS Ground\",\n \"shipping_exception_type\": \"restricted\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "Multiple Restricted" }, { "code": "{}", "language": "json", "name": "Empty JSON object clear" }, { "code": "{\n\t\"fulfillment_nodes\":[]\n}", "language": "json", "name": "Empty fulfillment_nodes array clear" }, { "code": "{\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"1234DKSANDSFNCSJKFDNFKJHFAZ\",\n \"shipping_exceptions\": [\n {\n \"shipping_method\": \"FedEx Home Delivery\", //if FedEx Home Delivery is chosen as the shipping method for the order, we'll add an additional $1\n \"override_type\": \"Additional charge\",\n \"shipping_charge_amount\": 1,\n \"shipping_exception_type\": \"include\"\n },\n {\n \"shipping_method\": \"UPS Next Day Air\", \n \"override_type\": \"Override charge\",\n \"shipping_charge_amount\": 100,\n \"shipping_exception_type\": \"include\"\n }\n ]\n }\n ]\n}", "language": "json", "name": "Include Exception Type" } ], "sidebar": true } [/block]
{"_id":"56fd2bf327b4321900186ee2","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"**time_to_return** \\n\\n*integer*\",\n    \"1-0\": \"**return_location_ids**\\n\\n*string array*\",\n    \"2-0\": \"**return_shipping_methods**\\n\\n*string array*\",\n    \"0-1\": \"The number of days after purchase a customer can return the item.\",\n    \"1-1\": \"The ID of the returns node that was created on partner.jet.com under fulfillment settings.\",\n    \"2-1\": \"A specific shipping method.  Jet will choose its default of FedEx ground\",\n    \"0-3\": \"\",\n    \"1-3\": \"\",\n    \"2-3\": \"\",\n    \"2-2\": \"Must be one of the following values:\\n* Freight\\n* FedEx Ground\\n* UPS Ground\",\n    \"h-4\": \"Required\",\n    \"1-2\": \"Must be a valid return node ID set up by the merchant\",\n    \"0-2\": \"1 to 30\\n\\nMust be consistent with returns policy\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","createdAt":"2016-02-03T13:26:26.819Z","githubsync":"","link_external":false,"title":"Returns Exception","version":"56fd2bf327b4321900186ec6","api":{"method":"get","params":[{"desc":"The previously created ID you will use to track and update your Merchant SKU","default":"","type":"string","name":"{user_defined_sku_id}","in":"query","_id":"565cc8dff8bc860d006842e9","ref":"","required":false}],"results":{"codes":[{"status":200,"code":"","language":"json"}]},"settings":"","url":"/merchant-skus/{user_defined_sku_id}/returnsexception","auth":"required","examples":{"codes":[]}},"editedParams2":true,"updates":[],"editedParams":true,"excerpt":"","hidden":false,"link_url":"","parentDoc":null,"sync_unique":"","type":"get","__v":0,"category":"56fd2bf327b4321900186ec9","isReference":false,"order":13,"project":"562e25f2e01a430d00c2c91e","slug":"returns-exception","user":"562e25d24376430d006f1769","childrenPages":[]}

getReturns Exception


Query Params

user_defined_sku_id:
string
The previously created ID you will use to track and update your Merchant SKU
[block:api-header] { "type": "basic", "title": "Response Body" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**time_to_return** \n\n*integer*", "1-0": "**return_location_ids**\n\n*string array*", "2-0": "**return_shipping_methods**\n\n*string array*", "0-1": "The number of days after purchase a customer can return the item.", "1-1": "The ID of the returns node that was created on partner.jet.com under fulfillment settings.", "2-1": "A specific shipping method. Jet will choose its default of FedEx ground", "0-3": "", "1-3": "", "2-3": "", "2-2": "Must be one of the following values:\n* Freight\n* FedEx Ground\n* UPS Ground", "h-4": "Required", "1-2": "Must be a valid return node ID set up by the merchant", "0-2": "1 to 30\n\nMust be consistent with returns policy" }, "cols": 3, "rows": 3 } [/block]

Definition

{{ api_url }}{{ page_api_url }}


[block:api-header] { "type": "basic", "title": "Response Body" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "0-0": "**time_to_return** \n\n*integer*", "1-0": "**return_location_ids**\n\n*string array*", "2-0": "**return_shipping_methods**\n\n*string array*", "0-1": "The number of days after purchase a customer can return the item.", "1-1": "The ID of the returns node that was created on partner.jet.com under fulfillment settings.", "2-1": "A specific shipping method. Jet will choose its default of FedEx ground", "0-3": "", "1-3": "", "2-3": "", "2-2": "Must be one of the following values:\n* Freight\n* FedEx Ground\n* UPS Ground", "h-4": "Required", "1-2": "Must be a valid return node ID set up by the merchant", "0-2": "1 to 30\n\nMust be consistent with returns policy" }, "cols": 3, "rows": 3 } [/block]
{"_id":"56fd2bf327b4321900186ee4","hidden":false,"link_external":false,"parentDoc":null,"project":"562e25f2e01a430d00c2c91e","slug":"verify-the-existence-of-multiple-skus","updates":[],"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body\"\n}\n[/block]\nThis call allows you visibility into the total number of SKUs you have uploaded. Alternatively, the Partner Portal allows you to download a CSV file of all SKUs.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**sku_urls***\\n\\n*string array*\",\n    \"0-1\": \"The merchant SKU links associated with the merchants SKUs uploaded to Jet.com\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\\* denotes the field is required","githubsync":"","version":"56fd2bf327b4321900186ec6","isReference":false,"order":14,"sync_unique":"","category":"56fd2bf327b4321900186ec9","excerpt":"","api":{"examples":{"codes":[]},"method":"get","params":[{"desc":"The first SKU # you wish to appear in the return","default":"","type":"int","name":"offset","in":"path","_id":"562e912f36d1140d00120b51","ref":"","required":false},{"ref":"","required":false,"desc":"The last SKU # you wish to appear in the return","default":"","type":"int","name":"limit","in":"path","_id":"562e932c0ef0870d0030d2a3"}],"results":{"codes":[{"code":"{\n  \"sku_urls\": [\n    \"merchant-skus/merchant-sku-01\",\n    \"merchant-skus/merchant-sku-02\",\n    \"merchant-skus/merchant-sku-03\"\n  ]\n}","language":"json","status":200}]},"settings":"","url":"/merchant-skus?offset={offset}&limit={limit}","auth":"required"},"createdAt":"2015-10-26T20:55:08.924Z","editedParams2":true,"type":"get","user":"562e25d24376430d006f1769","__v":0,"title":"SKU Link Retrieval","editedParams":true,"link_url":"","childrenPages":[]}

getSKU Link Retrieval


Path Params

offset:
integer
The first SKU # you wish to appear in the return
limit:
integer
The last SKU # you wish to appear in the return
[block:api-header] { "type": "basic", "title": "Response Body" } [/block] This call allows you visibility into the total number of SKUs you have uploaded. Alternatively, the Partner Portal allows you to download a CSV file of all SKUs. [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**sku_urls***\n\n*string array*", "0-1": "The merchant SKU links associated with the merchants SKUs uploaded to Jet.com" }, "cols": 3, "rows": 1 } [/block] \* denotes the field is required

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response Body" } [/block] This call allows you visibility into the total number of SKUs you have uploaded. Alternatively, the Partner Portal allows you to download a CSV file of all SKUs. [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**sku_urls***\n\n*string array*", "0-1": "The merchant SKU links associated with the merchants SKUs uploaded to Jet.com" }, "cols": 3, "rows": 1 } [/block] \* denotes the field is required
{"_id":"5714f8074007610e00c804fa","createdAt":"2016-04-18T15:06:47.039Z","excerpt":"Analyze how your individual product price (item and shipping price) compares to the lowest individual product prices from the marketplace. These prices are only provided for SKUs that have the status “Available for Sale”. If a best price does not change, then the last_update time also will not change. If your inventory is zero, then these prices will not continue to be updated and will be stale. Note: It may take up to 24 hours to reflect any price updates from you and the marketplace.\n\nProduct pricing is one factor that Jet uses to determine which retailer wins a basket order. Jet determines what orders retailers will win based on the the product prices of all products in the order, base commission on those items as well as commission adjustments set via the Rules Engine. Commission adjustments set via the Rules Engine can be very effective in optimizing your win rate and profitability at the order level without having to have the absolute lowest item and shipping prices.","link_external":false,"link_url":"","sync_unique":"","__v":1,"githubsync":"","hidden":false,"isReference":false,"order":15,"project":"562e25f2e01a430d00c2c91e","title":"SKU Sales Data","api":{"params":[{"ref":"","required":false,"desc":"The previously created ID you will use to track and update your Merchant SKU","default":"","type":"string","name":"user_defined_sku_id","in":"path","_id":"5714f8dab9061c0e00d123a9"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"sales_rank\": {\n\t\t\"level_0\": 1435,\n\t\t\"last_update\": \"2016-02-03T11:48:30.6063244+00:00\"\n\t},\n\t\"units_sold\": {\n\t\t\"last_30_days\": 235,\n\t\t\"last_update\": \"2016-02-03T11:48:30.6063244+00:00\"\n\t},\n\t\"my_best_offer\": [{\n\t\t\"shipping_method\": null,\n\t\t\"item_price\": 9.99,\n\t\t\"shipping_price\": 1.00,\n\t\t\"last_update\": \"2016-02-03T11:48:30.6063244+00:00\"\n\t}],\n\t\"best_marketplace_offer\": [{\n\t\t\"shipping_method\": null,\n\t\t\"item_price\": 9.00,\n\t\t\"shipping_price\": 0.00,\n\t\t\"last_update\": \"2016-02-03T11:48:30.6063244+00:00\"\n\t}]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/merchant-skus/{user_defined_sku_id}/salesdata","auth":"required","examples":{"codes":[]},"method":"get"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body\"\n}\n[/block]\n**sales_rank array** - The below table outlines the fields that are within this array:\n[block:parameters]\n{\n  \"data\": {\n    \"0-1\": \"Jet sales rank of a SKU based off its exponential moving average sales by all retailers on the marketplace, updated daily.\",\n    \"1-1\": \"The last time Jet sales rank was updated\",\n    \"1-0\": \"**last_update** \\n\\n*string*\",\n    \"0-0\": \"**level_0** \\n\\n*integer*\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n**units_sold array** - The below table outlines the fields that are within this array:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**last_30_days**\\n\\n*integer*\",\n    \"0-1\": \"Units of this SKU sold on Jet by all retailers over the last 30 days, updated daily. If there are no units sold, this field will not be presented.\",\n    \"1-1\": \"The last time units sold was updated\",\n    \"1-0\": \"**last_update** \\n\\n*string*\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n**my_best_offer array** - The below table outlines the fields that are within this array:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validaiton\",\n    \"0-1\": \"The shipping method specified for your best price. For the time being, this will always be null.\",\n    \"3-1\": \"The last time these prices were updated. The last_update time does not necessarily change if the best price does not change, even if the price is more up to date than this time.\",\n    \"2-1\": \"The shipping price for one unit of the SKU based on your best retail price (item and shipping price)\",\n    \"1-1\": \"The item price for one unit of the SKU based on your best retail price (item and shipping price)\",\n    \"0-0\": \"**shipping_method** \\n\\n*string*\",\n    \"1-0\": \"**item_price** \\n\\n*float*\",\n    \"2-0\": \"**shipping_price** \\n\\n*float*\",\n    \"3-0\": \"**last_update** \\n\\n*string*\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n**best_marketplace_offer array** - The below table outlines the fields that are within this array:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**shipping_method** \\n\\n*string*\",\n    \"1-0\": \"**item_price** \\n\\n*float*\",\n    \"2-0\": \"**shipping_price** \\n\\n*float*\",\n    \"3-0\": \"**last_update** \\n\\n*string*\",\n    \"0-1\": \"The shipping method specified for the best price on Jet's marketplace. For the time being, this will always be null.\",\n    \"3-1\": \"The last time these prices were updated. The last_update time does not necessarily change if the best price does not change, even if the price is more up to date than this time.\",\n    \"2-1\": \"The shipping price for one unit of the SKU based on the best retail price (item and shipping price) on Jet's marketplace\",\n    \"1-1\": \"The item price for one unit of the SKU based on the best retail price (item and shipping price) on Jet's marketplace\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Please see Bulk Reporting API to retrieve data for all SKUs.\",\n  \"body\": \"http://developer.jet.com/docs/create-new-report\"\n}\n[/block]","type":"get","updates":[],"user":"562e25d24376430d006f1769","editedParams2":true,"slug":"sku-sales-data","version":"56fd2bf327b4321900186ec6","category":"56fd2bf327b4321900186ec9","editedParams":true,"parentDoc":null,"childrenPages":[]}

getSKU Sales Data

Analyze how your individual product price (item and shipping price) compares to the lowest individual product prices from the marketplace. These prices are only provided for SKUs that have the status “Available for Sale”. If a best price does not change, then the last_update time also will not change. If your inventory is zero, then these prices will not continue to be updated and will be stale. Note: It may take up to 24 hours to reflect any price updates from you and the marketplace. Product pricing is one factor that Jet uses to determine which retailer wins a basket order. Jet determines what orders retailers will win based on the the product prices of all products in the order, base commission on those items as well as commission adjustments set via the Rules Engine. Commission adjustments set via the Rules Engine can be very effective in optimizing your win rate and profitability at the order level without having to have the absolute lowest item and shipping prices.

Path Params

user_defined_sku_id:
string
The previously created ID you will use to track and update your Merchant SKU
[block:api-header] { "type": "basic", "title": "Response Body" } [/block] **sales_rank array** - The below table outlines the fields that are within this array: [block:parameters] { "data": { "0-1": "Jet sales rank of a SKU based off its exponential moving average sales by all retailers on the marketplace, updated daily.", "1-1": "The last time Jet sales rank was updated", "1-0": "**last_update** \n\n*string*", "0-0": "**level_0** \n\n*integer*", "h-0": "Field", "h-1": "Description", "h-2": "Validation" }, "cols": 3, "rows": 2 } [/block] **units_sold array** - The below table outlines the fields that are within this array: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**last_30_days**\n\n*integer*", "0-1": "Units of this SKU sold on Jet by all retailers over the last 30 days, updated daily. If there are no units sold, this field will not be presented.", "1-1": "The last time units sold was updated", "1-0": "**last_update** \n\n*string*" }, "cols": 3, "rows": 2 } [/block] **my_best_offer array** - The below table outlines the fields that are within this array: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validaiton", "0-1": "The shipping method specified for your best price. For the time being, this will always be null.", "3-1": "The last time these prices were updated. The last_update time does not necessarily change if the best price does not change, even if the price is more up to date than this time.", "2-1": "The shipping price for one unit of the SKU based on your best retail price (item and shipping price)", "1-1": "The item price for one unit of the SKU based on your best retail price (item and shipping price)", "0-0": "**shipping_method** \n\n*string*", "1-0": "**item_price** \n\n*float*", "2-0": "**shipping_price** \n\n*float*", "3-0": "**last_update** \n\n*string*" }, "cols": 3, "rows": 4 } [/block] **best_marketplace_offer array** - The below table outlines the fields that are within this array: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**shipping_method** \n\n*string*", "1-0": "**item_price** \n\n*float*", "2-0": "**shipping_price** \n\n*float*", "3-0": "**last_update** \n\n*string*", "0-1": "The shipping method specified for the best price on Jet's marketplace. For the time being, this will always be null.", "3-1": "The last time these prices were updated. The last_update time does not necessarily change if the best price does not change, even if the price is more up to date than this time.", "2-1": "The shipping price for one unit of the SKU based on the best retail price (item and shipping price) on Jet's marketplace", "1-1": "The item price for one unit of the SKU based on the best retail price (item and shipping price) on Jet's marketplace" }, "cols": 3, "rows": 4 } [/block] [block:callout] { "type": "info", "title": "Please see Bulk Reporting API to retrieve data for all SKUs.", "body": "http://developer.jet.com/docs/create-new-report" } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response Body" } [/block] **sales_rank array** - The below table outlines the fields that are within this array: [block:parameters] { "data": { "0-1": "Jet sales rank of a SKU based off its exponential moving average sales by all retailers on the marketplace, updated daily.", "1-1": "The last time Jet sales rank was updated", "1-0": "**last_update** \n\n*string*", "0-0": "**level_0** \n\n*integer*", "h-0": "Field", "h-1": "Description", "h-2": "Validation" }, "cols": 3, "rows": 2 } [/block] **units_sold array** - The below table outlines the fields that are within this array: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**last_30_days**\n\n*integer*", "0-1": "Units of this SKU sold on Jet by all retailers over the last 30 days, updated daily. If there are no units sold, this field will not be presented.", "1-1": "The last time units sold was updated", "1-0": "**last_update** \n\n*string*" }, "cols": 3, "rows": 2 } [/block] **my_best_offer array** - The below table outlines the fields that are within this array: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validaiton", "0-1": "The shipping method specified for your best price. For the time being, this will always be null.", "3-1": "The last time these prices were updated. The last_update time does not necessarily change if the best price does not change, even if the price is more up to date than this time.", "2-1": "The shipping price for one unit of the SKU based on your best retail price (item and shipping price)", "1-1": "The item price for one unit of the SKU based on your best retail price (item and shipping price)", "0-0": "**shipping_method** \n\n*string*", "1-0": "**item_price** \n\n*float*", "2-0": "**shipping_price** \n\n*float*", "3-0": "**last_update** \n\n*string*" }, "cols": 3, "rows": 4 } [/block] **best_marketplace_offer array** - The below table outlines the fields that are within this array: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**shipping_method** \n\n*string*", "1-0": "**item_price** \n\n*float*", "2-0": "**shipping_price** \n\n*float*", "3-0": "**last_update** \n\n*string*", "0-1": "The shipping method specified for the best price on Jet's marketplace. For the time being, this will always be null.", "3-1": "The last time these prices were updated. The last_update time does not necessarily change if the best price does not change, even if the price is more up to date than this time.", "2-1": "The shipping price for one unit of the SKU based on the best retail price (item and shipping price) on Jet's marketplace", "1-1": "The item price for one unit of the SKU based on the best retail price (item and shipping price) on Jet's marketplace" }, "cols": 3, "rows": 4 } [/block] [block:callout] { "type": "info", "title": "Please see Bulk Reporting API to retrieve data for all SKUs.", "body": "http://developer.jet.com/docs/create-new-report" } [/block]
{"_id":"59b840128c45630028f0ca74","project":"562e25f2e01a430d00c2c91e","version":"56fd2bf327b4321900186ec6","category":"56fd2bf327b4321900186ec9","user":"562e25d24376430d006f1769","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-12T20:14:10.924Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"put","examples":{"codes":[]},"settings":"","results":{"codes":[{"code":"","language":"json","status":204},{"code":"","language":"json","status":400}]},"auth":"required","params":[{"_id":"562e8e1419e7b40d00b7c723","ref":"","in":"path","required":true,"desc":"The identifier you will use to track and update your merchant SKU. Maximum of 64 chars.","default":"","type":"string","name":"user_defined_sku_id"}],"url":"/merchant-skus/{user_defined_sku_id}/v2"},"isReference":false,"order":999,"body":"[block:api-header]\n{\n  \"title\": \"Shoe Product Types\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Boots\",\n    \"1-0\": \"Clogs\",\n    \"2-0\": \"Mules\",\n    \"3-0\": \"Flats\",\n    \"4-0\": \"Boat Shoes\",\n    \"5-0\": \"Loafers\",\n    \"6-0\": \"Oxfords\",\n    \"7-0\": \"Pumps\",\n    \"8-0\": \"Heels\",\n    \"9-0\": \"Sandals\",\n    \"10-0\": \"Slippers\",\n    \"11-0\": \"Casual & Fashion Sneakers\",\n    \"12-0\": \"Athletic Shoes\",\n    \"0-1\": \"37005005000\",\n    \"1-1\": \"37005013000\",\n    \"2-1\": \"37005030000\",\n    \"3-1\": \"37005023000\",\n    \"4-1\": \"37005031001\",\n    \"5-1\": \"37005031000\",\n    \"6-1\": \"37005032000\",\n    \"8-1\": \"37005027000\",\n    \"7-1\": \"37005027007\",\n    \"9-1\": \"37005037000\",\n    \"10-1\": \"37005043000\",\n    \"11-1\": \"37005045000\",\n    \"12-1\": \"37005046000\",\n    \"h-1\": \"Product Type Id\",\n    \"h-0\": \"Product Type Name\"\n  },\n  \"cols\": 2,\n  \"rows\": 13\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use Cases\",\n  \"sidebar\": true\n}\n[/block]\nExamples request bodies\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n\\\"product_type_id\\\": 37005005000 ,\\n\\\"product_title\\\": \\\"My Product\\\",\\n\\\"standard_product_codes\\\": [\\n  {\\n  \\\"standard_product_code\\\": \\\"123456789012\\\",\\n  \\\"standard_product_code_type\\\": \\\"UPC\\\"\\n  }\\n],\\n\\\"multipack_quantity\\\": 6,\\n\\\"brand\\\": \\\"My Product's Brand\\\",\\n\\\"manufacturer\\\": \\\"My Product's Manufacturer\\\",\\n\\\"mfr_part_number\\\": \\\"AB-9874\\\",\\n\\\"product_description\\\": \\\"This is a terrific product that everyone should own.\\\",\\n\\\"bullets\\\": [\\n  \\\"This is bullet line 1\\\",\\n  \\\"This is bullet line 2\\\"\\n],\\n\\\"number_units_for_price_per_unit\\\": 1,\\n\\\"type_of_unit_for_price_per_unit\\\": \\\"each\\\",\\n\\\"shipping_weight_pounds\\\": 10,\\n\\\"package_length_inches\\\": 12,\\n\\\"package_width_inches\\\": 12,\\n\\\"package_height_inches\\\": 12,\\n\\\"display_length_inches\\\": 15,\\n\\\"display_width_inches\\\": 12,\\n\\\"display_height_inches\\\": 14,\\n\\\"prop_65\\\": true,\\n\\\"legal_disclaimer_description\\\": \\\"Legal stuff goes here\\\",\\n\\\"cpsia_cautionary_statements\\\": [\\n  \\\"choking hazard balloon\\\",\\n  \\\"choking hazard small parts\\\"\\n],\\n\\\"country_of_origin\\\": \\\"U.S.A.\\\",\\n\\\"safety_warning\\\": \\\"warning text goes here\\\",\\n\\\"msrp\\\": 6.99,\\n\\\"map_price\\\": 6.49,\\n\\\"map_implementation\\\": \\\"102\\\",\\n\\\"product_tax_code\\\": \\\"Generic Taxable Product\\\",\\n\\\"attributes_node_specific\\\": [\\n      {\\n            \\\"attribute_id\\\": 770703275075886,\\n            \\\"attribute_value\\\": \\\"Men\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 969418632494197,\\n            \\\"attribute_value\\\": \\\"9.5\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 951803048500342,\\n            \\\"attribute_value\\\": \\\"US\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 805390093102030,\\n            \\\"attribute_value\\\": \\\"Blue\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 80,\\n            \\\"attribute_value\\\": \\\"D\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 656494019201798,\\n            \\\"attribute_value\\\": \\\"Synthetic\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 714725568257326,\\n            \\\"attribute_value\\\": \\\"Synthetic\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 782030647047910,\\n            \\\"attribute_value\\\": \\\"Cameo\\\"\\n            }\\n],\\n\\\"main_image_url\\\": \\\"http://www.mydomain.com/images/myImage.png\\\",\\n\\\"swatch_image_url\\\": \\\"http://www.mydomain.com/images/myImage.png\\\",\\n\\\"alternate_images\\\": [\\n  {\\n  \\\"image_slot_id\\\": 1,\\n  \\\"image_url\\\": \\\"http://www.mydomain.com/images/myImage.png\\\"\\n  },\\n  {\\n  \\\"image_slot_id\\\": 2,\\n  \\\"image_url\\\": \\\"http://www.mydomain.com/images/myImage.png\\\"\\n  }\\n]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"All fields\"\n    },\n    {\n      \"code\": \"{\\n    \\\"product_type_id\\\": 3700500500,\\n    \\\"attributes_node_specific\\\": [\\n        {\\n            \\\"attribute_id\\\": 770703275075886,\\n            \\\"attribute_value\\\": \\\"Men\\\"\\n        },\\n        {\\n            \\\"attribute_id\\\": 969418632494197,\\n            \\\"attribute_value\\\": \\\"9.5\\\"\\n        },\\n        {\\n            \\\"attribute_id\\\": 951803048500342,\\n            \\\"attribute_value\\\": \\\"US\\\"\\n        },\\n        {\\n            \\\"attribute_id\\\": 805390093102030,\\n            \\\"attribute_value\\\": \\\"Blue\\\"\\n        },\\n        {\\n            \\\"attribute_id\\\": 80,\\n            \\\"attribute_value\\\": \\\"D\\\"\\n        },\\n        {\\n            \\\"attribute_id\\\": 656494019201798,\\n            \\\"attribute_value\\\": \\\"Synthetic\\\"\\n        },\\n        {\\n            \\\"attribute_id\\\": 714725568257326,\\n            \\\"attribute_value\\\": \\\"Synthetic\\\"\\n        },\\n        {\\n            \\\"attribute_id\\\": 782030647047910,\\n            \\\"attribute_value\\\": \\\"Cameo\\\"\\n        }\\n    ],\\n    \\\"brand\\\": \\\"SkechersY\\\",\\n    \\\"main_image_url\\\": \\\"http://www.shoebuy.com/pi/skech/jb/skech766106_42986_jb.jpg\\\",\\n    \\\"multipack_quantity\\\": 1,\\n    \\\"product_description\\\": \\\"Give younglings an appreciation of the classics with the Star Wars Skechers: Tossers - Padawan shoe. Soft woven canvas fabric upper in a slip on retro skate sneaker with printed classic Star Wars logo design and cool printed insole. Memory Foam comfort.\\\",\\n    \\\"product_title\\\": \\\"Skechers Unisex Children's  Star Wars Tossers Padawan Slip On Charcoal/Black Size 12 M\\\",\\n    \\\"standard_product_codes\\\": [\\n        {\\n            \\\"standard_product_code\\\": \\\"889110600900\\\",\\n            \\\"standard_product_code_type\\\": \\\"UPC\\\"\\n          }\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Required Fields\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"sku-upload-v2-shoe-category","type":"put","title":"SKU Upload V2 (Shoe Only Category)","__v":8,"childrenPages":[]}

putSKU Upload V2 (Shoe Only Category)


Path Params

user_defined_sku_id:
required
string
The identifier you will use to track and update your merchant SKU. Maximum of 64 chars.
[block:api-header] { "title": "Shoe Product Types" } [/block] [block:parameters] { "data": { "0-0": "Boots", "1-0": "Clogs", "2-0": "Mules", "3-0": "Flats", "4-0": "Boat Shoes", "5-0": "Loafers", "6-0": "Oxfords", "7-0": "Pumps", "8-0": "Heels", "9-0": "Sandals", "10-0": "Slippers", "11-0": "Casual & Fashion Sneakers", "12-0": "Athletic Shoes", "0-1": "37005005000", "1-1": "37005013000", "2-1": "37005030000", "3-1": "37005023000", "4-1": "37005031001", "5-1": "37005031000", "6-1": "37005032000", "8-1": "37005027000", "7-1": "37005027007", "9-1": "37005037000", "10-1": "37005043000", "11-1": "37005045000", "12-1": "37005046000", "h-1": "Product Type Id", "h-0": "Product Type Name" }, "cols": 2, "rows": 13 } [/block] [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] Examples request bodies [block:code] { "codes": [ { "code": "{\n\"product_type_id\": 37005005000 ,\n\"product_title\": \"My Product\",\n\"standard_product_codes\": [\n {\n \"standard_product_code\": \"123456789012\",\n \"standard_product_code_type\": \"UPC\"\n }\n],\n\"multipack_quantity\": 6,\n\"brand\": \"My Product's Brand\",\n\"manufacturer\": \"My Product's Manufacturer\",\n\"mfr_part_number\": \"AB-9874\",\n\"product_description\": \"This is a terrific product that everyone should own.\",\n\"bullets\": [\n \"This is bullet line 1\",\n \"This is bullet line 2\"\n],\n\"number_units_for_price_per_unit\": 1,\n\"type_of_unit_for_price_per_unit\": \"each\",\n\"shipping_weight_pounds\": 10,\n\"package_length_inches\": 12,\n\"package_width_inches\": 12,\n\"package_height_inches\": 12,\n\"display_length_inches\": 15,\n\"display_width_inches\": 12,\n\"display_height_inches\": 14,\n\"prop_65\": true,\n\"legal_disclaimer_description\": \"Legal stuff goes here\",\n\"cpsia_cautionary_statements\": [\n \"choking hazard balloon\",\n \"choking hazard small parts\"\n],\n\"country_of_origin\": \"U.S.A.\",\n\"safety_warning\": \"warning text goes here\",\n\"msrp\": 6.99,\n\"map_price\": 6.49,\n\"map_implementation\": \"102\",\n\"product_tax_code\": \"Generic Taxable Product\",\n\"attributes_node_specific\": [\n {\n \"attribute_id\": 770703275075886,\n \"attribute_value\": \"Men\"\n },\n {\n \"attribute_id\": 969418632494197,\n \"attribute_value\": \"9.5\"\n },\n {\n \"attribute_id\": 951803048500342,\n \"attribute_value\": \"US\"\n },\n {\n \"attribute_id\": 805390093102030,\n \"attribute_value\": \"Blue\"\n },\n {\n \"attribute_id\": 80,\n \"attribute_value\": \"D\"\n },\n {\n \"attribute_id\": 656494019201798,\n \"attribute_value\": \"Synthetic\"\n },\n {\n \"attribute_id\": 714725568257326,\n \"attribute_value\": \"Synthetic\"\n },\n {\n \"attribute_id\": 782030647047910,\n \"attribute_value\": \"Cameo\"\n }\n],\n\"main_image_url\": \"http://www.mydomain.com/images/myImage.png\",\n\"swatch_image_url\": \"http://www.mydomain.com/images/myImage.png\",\n\"alternate_images\": [\n {\n \"image_slot_id\": 1,\n \"image_url\": \"http://www.mydomain.com/images/myImage.png\"\n },\n {\n \"image_slot_id\": 2,\n \"image_url\": \"http://www.mydomain.com/images/myImage.png\"\n }\n]\n}", "language": "json", "name": "All fields" }, { "code": "{\n \"product_type_id\": 3700500500,\n \"attributes_node_specific\": [\n {\n \"attribute_id\": 770703275075886,\n \"attribute_value\": \"Men\"\n },\n {\n \"attribute_id\": 969418632494197,\n \"attribute_value\": \"9.5\"\n },\n {\n \"attribute_id\": 951803048500342,\n \"attribute_value\": \"US\"\n },\n {\n \"attribute_id\": 805390093102030,\n \"attribute_value\": \"Blue\"\n },\n {\n \"attribute_id\": 80,\n \"attribute_value\": \"D\"\n },\n {\n \"attribute_id\": 656494019201798,\n \"attribute_value\": \"Synthetic\"\n },\n {\n \"attribute_id\": 714725568257326,\n \"attribute_value\": \"Synthetic\"\n },\n {\n \"attribute_id\": 782030647047910,\n \"attribute_value\": \"Cameo\"\n }\n ],\n \"brand\": \"SkechersY\",\n \"main_image_url\": \"http://www.shoebuy.com/pi/skech/jb/skech766106_42986_jb.jpg\",\n \"multipack_quantity\": 1,\n \"product_description\": \"Give younglings an appreciation of the classics with the Star Wars Skechers: Tossers - Padawan shoe. Soft woven canvas fabric upper in a slip on retro skate sneaker with printed classic Star Wars logo design and cool printed insole. Memory Foam comfort.\",\n \"product_title\": \"Skechers Unisex Children's Star Wars Tossers Padawan Slip On Charcoal/Black Size 12 M\",\n \"standard_product_codes\": [\n {\n \"standard_product_code\": \"889110600900\",\n \"standard_product_code_type\": \"UPC\"\n }\n ]\n}", "language": "json", "name": "Required Fields" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


[block:api-header] { "title": "Shoe Product Types" } [/block] [block:parameters] { "data": { "0-0": "Boots", "1-0": "Clogs", "2-0": "Mules", "3-0": "Flats", "4-0": "Boat Shoes", "5-0": "Loafers", "6-0": "Oxfords", "7-0": "Pumps", "8-0": "Heels", "9-0": "Sandals", "10-0": "Slippers", "11-0": "Casual & Fashion Sneakers", "12-0": "Athletic Shoes", "0-1": "37005005000", "1-1": "37005013000", "2-1": "37005030000", "3-1": "37005023000", "4-1": "37005031001", "5-1": "37005031000", "6-1": "37005032000", "8-1": "37005027000", "7-1": "37005027007", "9-1": "37005037000", "10-1": "37005043000", "11-1": "37005045000", "12-1": "37005046000", "h-1": "Product Type Id", "h-0": "Product Type Name" }, "cols": 2, "rows": 13 } [/block] [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] Examples request bodies [block:code] { "codes": [ { "code": "{\n\"product_type_id\": 37005005000 ,\n\"product_title\": \"My Product\",\n\"standard_product_codes\": [\n {\n \"standard_product_code\": \"123456789012\",\n \"standard_product_code_type\": \"UPC\"\n }\n],\n\"multipack_quantity\": 6,\n\"brand\": \"My Product's Brand\",\n\"manufacturer\": \"My Product's Manufacturer\",\n\"mfr_part_number\": \"AB-9874\",\n\"product_description\": \"This is a terrific product that everyone should own.\",\n\"bullets\": [\n \"This is bullet line 1\",\n \"This is bullet line 2\"\n],\n\"number_units_for_price_per_unit\": 1,\n\"type_of_unit_for_price_per_unit\": \"each\",\n\"shipping_weight_pounds\": 10,\n\"package_length_inches\": 12,\n\"package_width_inches\": 12,\n\"package_height_inches\": 12,\n\"display_length_inches\": 15,\n\"display_width_inches\": 12,\n\"display_height_inches\": 14,\n\"prop_65\": true,\n\"legal_disclaimer_description\": \"Legal stuff goes here\",\n\"cpsia_cautionary_statements\": [\n \"choking hazard balloon\",\n \"choking hazard small parts\"\n],\n\"country_of_origin\": \"U.S.A.\",\n\"safety_warning\": \"warning text goes here\",\n\"msrp\": 6.99,\n\"map_price\": 6.49,\n\"map_implementation\": \"102\",\n\"product_tax_code\": \"Generic Taxable Product\",\n\"attributes_node_specific\": [\n {\n \"attribute_id\": 770703275075886,\n \"attribute_value\": \"Men\"\n },\n {\n \"attribute_id\": 969418632494197,\n \"attribute_value\": \"9.5\"\n },\n {\n \"attribute_id\": 951803048500342,\n \"attribute_value\": \"US\"\n },\n {\n \"attribute_id\": 805390093102030,\n \"attribute_value\": \"Blue\"\n },\n {\n \"attribute_id\": 80,\n \"attribute_value\": \"D\"\n },\n {\n \"attribute_id\": 656494019201798,\n \"attribute_value\": \"Synthetic\"\n },\n {\n \"attribute_id\": 714725568257326,\n \"attribute_value\": \"Synthetic\"\n },\n {\n \"attribute_id\": 782030647047910,\n \"attribute_value\": \"Cameo\"\n }\n],\n\"main_image_url\": \"http://www.mydomain.com/images/myImage.png\",\n\"swatch_image_url\": \"http://www.mydomain.com/images/myImage.png\",\n\"alternate_images\": [\n {\n \"image_slot_id\": 1,\n \"image_url\": \"http://www.mydomain.com/images/myImage.png\"\n },\n {\n \"image_slot_id\": 2,\n \"image_url\": \"http://www.mydomain.com/images/myImage.png\"\n }\n]\n}", "language": "json", "name": "All fields" }, { "code": "{\n \"product_type_id\": 3700500500,\n \"attributes_node_specific\": [\n {\n \"attribute_id\": 770703275075886,\n \"attribute_value\": \"Men\"\n },\n {\n \"attribute_id\": 969418632494197,\n \"attribute_value\": \"9.5\"\n },\n {\n \"attribute_id\": 951803048500342,\n \"attribute_value\": \"US\"\n },\n {\n \"attribute_id\": 805390093102030,\n \"attribute_value\": \"Blue\"\n },\n {\n \"attribute_id\": 80,\n \"attribute_value\": \"D\"\n },\n {\n \"attribute_id\": 656494019201798,\n \"attribute_value\": \"Synthetic\"\n },\n {\n \"attribute_id\": 714725568257326,\n \"attribute_value\": \"Synthetic\"\n },\n {\n \"attribute_id\": 782030647047910,\n \"attribute_value\": \"Cameo\"\n }\n ],\n \"brand\": \"SkechersY\",\n \"main_image_url\": \"http://www.shoebuy.com/pi/skech/jb/skech766106_42986_jb.jpg\",\n \"multipack_quantity\": 1,\n \"product_description\": \"Give younglings an appreciation of the classics with the Star Wars Skechers: Tossers - Padawan shoe. Soft woven canvas fabric upper in a slip on retro skate sneaker with printed classic Star Wars logo design and cool printed insole. Memory Foam comfort.\",\n \"product_title\": \"Skechers Unisex Children's Star Wars Tossers Padawan Slip On Charcoal/Black Size 12 M\",\n \"standard_product_codes\": [\n {\n \"standard_product_code\": \"889110600900\",\n \"standard_product_code_type\": \"UPC\"\n }\n ]\n}", "language": "json", "name": "Required Fields" } ], "sidebar": true } [/block]
{"_id":"56fd2bf327b4321900186eeb","next":{"description":"","pages":[]},"parentDoc":null,"api":{"results":{"codes":[{"language":"json","status":200,"name":"","code":"{}"},{"status":400,"name":"","code":"{}","language":"json"}]},"settings":"","auth":"required","params":[],"url":""},"hidden":false,"sync_unique":"","title":"JSON File Examples","updates":["598d24ff78092e00193b6460"],"version":"56fd2bf327b4321900186ec6","order":0,"project":"562e25f2e01a430d00c2c91e","__v":2,"slug":"batched-api-file-uploads","category":"56fd2bf327b4321900186eca","createdAt":"2015-12-07T23:41:29.661Z","excerpt":"","githubsync":"","isReference":false,"link_external":false,"body":"The File Upload API supports processing SKU information in bulk.  This is the preferred method of integration for retailers with large catalogs.\n\nThe following product files are accepted:\n* MerchantSKUs\n* Price\n* Inventory\n* InventoryPatch\n* ShippingException\n* ReturnsException\n* Variation\n* Archive\n\nThere are four endpoints associated with the Bulk JSON File upload, all of which must be used to ensure that a file has been processed and will enter the Jet system successfully. From a high level, the workflow is as follows: \n* User [GETs](https://developer.jet.com/docs/upload-token-url) from Jet an Azure URL where the file is to be uploaded \n* User [PUTs](https://developer.jet.com/docs/testinput-1) a GZIP file to this Azure URL\n* User [POSTs](https://developer.jet.com/docs/uploaded-files) an instruction for Jet to process the upload file \n* User [GETs](https://developer.jet.com/docs/uploaded-files) the file status to ensure that Jet has successfully processed the file \n\nThe body of each record in the file will correspond to whatever the request body is in the single case (e.g. a single [merchant SKU upload](https://developer.jet.com/docs/merchant-sku)).  Samples for each of the file types are found to the right.  More information about the file bodies can be found in the single case equivalent.\n\nPlease note that it is possible for files to process in parallel.  Therefore, if a user is uploading their products for the first time, it is recommended that they send the \"MerchantSKUs\" file first; other file types should only be uploaded once this initial load has been verified to be successfully processed. \n\nUploaded files will only be accessible for 30 days after upload.\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"File Processing and HTTP Codes\",\n  \"body\": \"Please be aware that a \\\"200 OK\\\" HTTP code on any of the File Upload endpoints does not indicate that a file has been processed successfully. It merely indicates that the request in question was valid and accepted. \\n\\nFor information on whether the file has been processed successfully, users must refer to the \\\"status\\\" field returned by a GET to the [Verify Processing Success](https://developer.jet.com/docs/jet-file-id) endpoint. \\n\\nIf errors are returned, download the associated \\\"error_url\\\" to see the specific errors for each record.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"File Sizes\",\n  \"body\": \"The file size which will optimize processing time is **100K records.** \\n\\nWe ask that if the merchant plans to upload **500K or more records**, they space the uploads out over several hours. \\n\\nAdditionally, we ask that if the merchant plans to upload less than **10K records**, they use the merchant API as opposed to the bulk JSON file upload.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"File Examples\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Example file constructions for each file type\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n\\t\\\"{user_defined_merchant_sku}\\\": {\\n    \\\"product_title\\\": \\\"My Product\\\",\\n    \\\"standard_product_codes\\\": \\n     [\\n      {\\n      \\\"standard_product_code\\\": \\\"123456789012\\\",\\n      \\\"standard_product_code_type\\\": \\\"UPC\\\"\\n      }\\n    ],\\n    \\\"multipack_quantity\\\": 6,\\n    \\\"ASIN\\\":\\\"12345ABCDE\\\"\\n\\t},\\n\\t\\\"{user_defined_merchant_sku}\\\": {\\n    \\\"product_title\\\": \\\"My Product\\\",\\n    \\\"jet_browse_node_id\\\": 1000001,\\n    \\\"standard_product_codes\\\": [\\n      {\\n      \\\"standard_product_code\\\": \\\"123456789012\\\",\\n      \\\"standard_product_code_type\\\": \\\"UPC\\\"\\n      }\\n    ],\\n    \\\"multipack_quantity\\\": 6,\\n    \\\"brand\\\": \\\"My Product's Brand\\\",\\n    \\\"manufacturer\\\": \\\"My Product's Manufacturer\\\",\\n    \\\"mfr_part_number\\\": \\\"AB-9874\\\",\\n    \\\"product_description\\\": \\\"This is a terrific product that everyone should own.\\\",\\n    \\\"bullets\\\": [\\n      \\\"This is bullet line 1\\\",\\n      \\\"This is bullet line 2\\\"\\n    ],\\n\\n    \\\"shipping_weight_pounds\\\": 10,\\n    \\\"map_price\\\": 6.49,\\n    \\\"map_implementation\\\": \\\"102\\\",\\n    \\\"product_tax_code\\\": \\\"Generic Taxable Product\\\",\\n    \\\"attributes_node_specific\\\": [\\n      {\\n      \\\"attribute_id\\\": 95,\\n      \\\"attribute_value\\\": \\\"80\\\",\\n      \\\"attribute_value_unit\\\": \\\"count\\\"\\n      },\\n      {\\n      \\\"attribute_id\\\": 119,\\n      \\\"attribute_value\\\": \\\"aqua\\\"\\n      },\\n      {\\n      \\\"attribute_id\\\": 2,\\n      \\\"attribute_value\\\": \\\"blue\\\"\\n      }\\n    ],\\n    \\\"main_image_url\\\": \\\"http://www.mydomain.com/images/myImage.png\\\"\\n\\t}\\n}\",\n      \"language\": \"json\",\n      \"name\": \"MerchantSKUs file\"\n    },\n    {\n      \"code\": \"{\\n\\t\\\"{user_defined_merchant_sku}\\\":{\\n  \\t\\\"price\\\":12.33\\n\\t},\\n  \\\"{user_defined_merchant_sku}\\\":{\\n  \\t\\\"price\\\":21.23\\n\\t}\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Price file\"\n    },\n    {\n      \"code\": \"{\\n\\t\\\"{user_defined_merchant_sku}\\\":{  \\t\\n      \\\"fulfillment_nodes\\\": [\\n        {\\n          \\\"fulfillment_node_id\\\": \\\"XISNDKSANDSFNCSJKFDNFKJHFJD\\\",\\n          \\\"quantity\\\": 100\\n        },\\n        {\\n          \\\"fulfillment_node_id\\\": \\\"AKSDKDJIJDISJFIDFJIDSIFFISI\\\",\\n          \\\"quantity\\\": 20\\n        }\\n      ]\\n\\t},\\n  \\\"{user_defined_merchant_sku}\\\":{\\n  \\t\\t\\\"fulfillment_nodes\\\": []\\n\\t}\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Inventory file\"\n    },\n    {\n      \"code\": \"{\\n\\t\\\"{user_defined_merchant_sku}\\\":{  \\t\\n      \\\"fulfillment_nodes\\\": [\\n        {\\n          \\\"fulfillment_node_id\\\": \\\"1234DKSANDSFNCSJKFDNFKJHFAZ\\\",\\n          \\\"shipping_exceptions\\\": [\\n            {\\n              \\\"shipping_method\\\": \\\"Freight\\\",\\n              \\\"override_type\\\": \\\"Additional charge\\\",\\n              \\\"shipping_charge_amount\\\": 3.25,\\n              \\\"shipping_exception_type\\\": \\\"exclusive\\\"\\n            }\\n          ]\\n        }\\n      ]\\n\\t},\\n  \\\"{user_defined_merchant_sku}\\\":{\\n  \\t\\t\\\"fulfillment_nodes\\\": [\\n      {\\n        \\\"fulfillment_node_id\\\": \\\"XISNDKSANDSFNCSJKFDNFKJHFJD\\\",\\n        \\\"shipping_exceptions\\\": [\\n          {\\n            \\\"service_level\\\": \\\"Standard\\\",\\n            \\\"shipping_exception_type\\\": \\\"restricted\\\"\\n          },\\n          {\\n            \\\"shipping_method\\\": \\\"UPS Ground\\\",\\n            \\\"shipping_exception_type\\\": \\\"restricted\\\"\\n          }\\n        ]\\n      }\\n    ]\\n\\t}\\n}\",\n      \"language\": \"json\",\n      \"name\": \"ShippingException file\"\n    },\n    {\n      \"code\": \"{\\n \\t\\\"{user_defined_merchant_sku}\\\":{\\n    \\\"time_to_return\\\": 5,\\n    \\\"return_location_ids\\\": [\\n      \\\"9046335c27d146ee94b23ef61d8959bc\\\",\\n      \\\"e3100213167d4abaa43a1c1dd6e4dc04\\\"\\n    ]\\n  },\\n  \\\"{user_defined_merchant_sku}\\\":{\\n    \\\"time_to_return\\\": 5\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"ReturnsException file\"\n    },\n    {\n      \"code\": \"{\\n\\t\\\"{user_defined_merchant_sku}\\\":{  \\t\\n    \\\"relationship\\\": \\\"Variation\\\",\\n    \\\"variation_refinements\\\": [12, 34],\\n    \\\"children_skus\\\": [\\n      \\\"abcd\\\",\\n      \\\"efgh\\\"\\n    ]\\n\\t},\\n  \\\"{user_defined_merchant_sku}\\\":{\\n  \\t\\t\\\"relationship\\\": \\\"Variation\\\",\\n      \\\"variation_refinements\\\": [12, 34],\\n      \\\"children_skus\\\": [\\n        \\\"zyxw\\\",\\n        \\\"dcba\\\"\\n      ]\\n\\t}\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Variation file\"\n    },\n    {\n      \"code\": \"{\\n\\t\\\"{user_defined_merchant_sku}\\\":{  \\t\\n\\t\\t\\t\\\"is_archived\\\":true\\n\\t},\\n  \\\"{user_defined_merchant_sku}\\\":{\\n  \\t\\t\\\"is_archived\\\":false\\n\\t}\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Archive file\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","user":"562e25d24376430d006f1769","link_url":"","type":"basic","childrenPages":[]}

JSON File Examples


The File Upload API supports processing SKU information in bulk. This is the preferred method of integration for retailers with large catalogs. The following product files are accepted: * MerchantSKUs * Price * Inventory * InventoryPatch * ShippingException * ReturnsException * Variation * Archive There are four endpoints associated with the Bulk JSON File upload, all of which must be used to ensure that a file has been processed and will enter the Jet system successfully. From a high level, the workflow is as follows: * User [GETs](https://developer.jet.com/docs/upload-token-url) from Jet an Azure URL where the file is to be uploaded * User [PUTs](https://developer.jet.com/docs/testinput-1) a GZIP file to this Azure URL * User [POSTs](https://developer.jet.com/docs/uploaded-files) an instruction for Jet to process the upload file * User [GETs](https://developer.jet.com/docs/uploaded-files) the file status to ensure that Jet has successfully processed the file The body of each record in the file will correspond to whatever the request body is in the single case (e.g. a single [merchant SKU upload](https://developer.jet.com/docs/merchant-sku)). Samples for each of the file types are found to the right. More information about the file bodies can be found in the single case equivalent. Please note that it is possible for files to process in parallel. Therefore, if a user is uploading their products for the first time, it is recommended that they send the "MerchantSKUs" file first; other file types should only be uploaded once this initial load has been verified to be successfully processed. Uploaded files will only be accessible for 30 days after upload. [block:callout] { "type": "danger", "title": "File Processing and HTTP Codes", "body": "Please be aware that a \"200 OK\" HTTP code on any of the File Upload endpoints does not indicate that a file has been processed successfully. It merely indicates that the request in question was valid and accepted. \n\nFor information on whether the file has been processed successfully, users must refer to the \"status\" field returned by a GET to the [Verify Processing Success](https://developer.jet.com/docs/jet-file-id) endpoint. \n\nIf errors are returned, download the associated \"error_url\" to see the specific errors for each record." } [/block] [block:callout] { "type": "warning", "title": "File Sizes", "body": "The file size which will optimize processing time is **100K records.** \n\nWe ask that if the merchant plans to upload **500K or more records**, they space the uploads out over several hours. \n\nAdditionally, we ask that if the merchant plans to upload less than **10K records**, they use the merchant API as opposed to the bulk JSON file upload." } [/block] [block:api-header] { "type": "basic", "title": "File Examples", "sidebar": true } [/block] [block:textarea] { "text": "Example file constructions for each file type", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n\t\"{user_defined_merchant_sku}\": {\n \"product_title\": \"My Product\",\n \"standard_product_codes\": \n [\n {\n \"standard_product_code\": \"123456789012\",\n \"standard_product_code_type\": \"UPC\"\n }\n ],\n \"multipack_quantity\": 6,\n \"ASIN\":\"12345ABCDE\"\n\t},\n\t\"{user_defined_merchant_sku}\": {\n \"product_title\": \"My Product\",\n \"jet_browse_node_id\": 1000001,\n \"standard_product_codes\": [\n {\n \"standard_product_code\": \"123456789012\",\n \"standard_product_code_type\": \"UPC\"\n }\n ],\n \"multipack_quantity\": 6,\n \"brand\": \"My Product's Brand\",\n \"manufacturer\": \"My Product's Manufacturer\",\n \"mfr_part_number\": \"AB-9874\",\n \"product_description\": \"This is a terrific product that everyone should own.\",\n \"bullets\": [\n \"This is bullet line 1\",\n \"This is bullet line 2\"\n ],\n\n \"shipping_weight_pounds\": 10,\n \"map_price\": 6.49,\n \"map_implementation\": \"102\",\n \"product_tax_code\": \"Generic Taxable Product\",\n \"attributes_node_specific\": [\n {\n \"attribute_id\": 95,\n \"attribute_value\": \"80\",\n \"attribute_value_unit\": \"count\"\n },\n {\n \"attribute_id\": 119,\n \"attribute_value\": \"aqua\"\n },\n {\n \"attribute_id\": 2,\n \"attribute_value\": \"blue\"\n }\n ],\n \"main_image_url\": \"http://www.mydomain.com/images/myImage.png\"\n\t}\n}", "language": "json", "name": "MerchantSKUs file" }, { "code": "{\n\t\"{user_defined_merchant_sku}\":{\n \t\"price\":12.33\n\t},\n \"{user_defined_merchant_sku}\":{\n \t\"price\":21.23\n\t}\n}", "language": "json", "name": "Price file" }, { "code": "{\n\t\"{user_defined_merchant_sku}\":{ \t\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"XISNDKSANDSFNCSJKFDNFKJHFJD\",\n \"quantity\": 100\n },\n {\n \"fulfillment_node_id\": \"AKSDKDJIJDISJFIDFJIDSIFFISI\",\n \"quantity\": 20\n }\n ]\n\t},\n \"{user_defined_merchant_sku}\":{\n \t\t\"fulfillment_nodes\": []\n\t}\n}", "language": "json", "name": "Inventory file" }, { "code": "{\n\t\"{user_defined_merchant_sku}\":{ \t\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"1234DKSANDSFNCSJKFDNFKJHFAZ\",\n \"shipping_exceptions\": [\n {\n \"shipping_method\": \"Freight\",\n \"override_type\": \"Additional charge\",\n \"shipping_charge_amount\": 3.25,\n \"shipping_exception_type\": \"exclusive\"\n }\n ]\n }\n ]\n\t},\n \"{user_defined_merchant_sku}\":{\n \t\t\"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"XISNDKSANDSFNCSJKFDNFKJHFJD\",\n \"shipping_exceptions\": [\n {\n \"service_level\": \"Standard\",\n \"shipping_exception_type\": \"restricted\"\n },\n {\n \"shipping_method\": \"UPS Ground\",\n \"shipping_exception_type\": \"restricted\"\n }\n ]\n }\n ]\n\t}\n}", "language": "json", "name": "ShippingException file" }, { "code": "{\n \t\"{user_defined_merchant_sku}\":{\n \"time_to_return\": 5,\n \"return_location_ids\": [\n \"9046335c27d146ee94b23ef61d8959bc\",\n \"e3100213167d4abaa43a1c1dd6e4dc04\"\n ]\n },\n \"{user_defined_merchant_sku}\":{\n \"time_to_return\": 5\n }\n}", "language": "json", "name": "ReturnsException file" }, { "code": "{\n\t\"{user_defined_merchant_sku}\":{ \t\n \"relationship\": \"Variation\",\n \"variation_refinements\": [12, 34],\n \"children_skus\": [\n \"abcd\",\n \"efgh\"\n ]\n\t},\n \"{user_defined_merchant_sku}\":{\n \t\t\"relationship\": \"Variation\",\n \"variation_refinements\": [12, 34],\n \"children_skus\": [\n \"zyxw\",\n \"dcba\"\n ]\n\t}\n}", "language": "json", "name": "Variation file" }, { "code": "{\n\t\"{user_defined_merchant_sku}\":{ \t\n\t\t\t\"is_archived\":true\n\t},\n \"{user_defined_merchant_sku}\":{\n \t\t\"is_archived\":false\n\t}\n}", "language": "json", "name": "Archive file" } ], "sidebar": true } [/block]
The File Upload API supports processing SKU information in bulk. This is the preferred method of integration for retailers with large catalogs. The following product files are accepted: * MerchantSKUs * Price * Inventory * InventoryPatch * ShippingException * ReturnsException * Variation * Archive There are four endpoints associated with the Bulk JSON File upload, all of which must be used to ensure that a file has been processed and will enter the Jet system successfully. From a high level, the workflow is as follows: * User [GETs](https://developer.jet.com/docs/upload-token-url) from Jet an Azure URL where the file is to be uploaded * User [PUTs](https://developer.jet.com/docs/testinput-1) a GZIP file to this Azure URL * User [POSTs](https://developer.jet.com/docs/uploaded-files) an instruction for Jet to process the upload file * User [GETs](https://developer.jet.com/docs/uploaded-files) the file status to ensure that Jet has successfully processed the file The body of each record in the file will correspond to whatever the request body is in the single case (e.g. a single [merchant SKU upload](https://developer.jet.com/docs/merchant-sku)). Samples for each of the file types are found to the right. More information about the file bodies can be found in the single case equivalent. Please note that it is possible for files to process in parallel. Therefore, if a user is uploading their products for the first time, it is recommended that they send the "MerchantSKUs" file first; other file types should only be uploaded once this initial load has been verified to be successfully processed. Uploaded files will only be accessible for 30 days after upload. [block:callout] { "type": "danger", "title": "File Processing and HTTP Codes", "body": "Please be aware that a \"200 OK\" HTTP code on any of the File Upload endpoints does not indicate that a file has been processed successfully. It merely indicates that the request in question was valid and accepted. \n\nFor information on whether the file has been processed successfully, users must refer to the \"status\" field returned by a GET to the [Verify Processing Success](https://developer.jet.com/docs/jet-file-id) endpoint. \n\nIf errors are returned, download the associated \"error_url\" to see the specific errors for each record." } [/block] [block:callout] { "type": "warning", "title": "File Sizes", "body": "The file size which will optimize processing time is **100K records.** \n\nWe ask that if the merchant plans to upload **500K or more records**, they space the uploads out over several hours. \n\nAdditionally, we ask that if the merchant plans to upload less than **10K records**, they use the merchant API as opposed to the bulk JSON file upload." } [/block] [block:api-header] { "type": "basic", "title": "File Examples", "sidebar": true } [/block] [block:textarea] { "text": "Example file constructions for each file type", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n\t\"{user_defined_merchant_sku}\": {\n \"product_title\": \"My Product\",\n \"standard_product_codes\": \n [\n {\n \"standard_product_code\": \"123456789012\",\n \"standard_product_code_type\": \"UPC\"\n }\n ],\n \"multipack_quantity\": 6,\n \"ASIN\":\"12345ABCDE\"\n\t},\n\t\"{user_defined_merchant_sku}\": {\n \"product_title\": \"My Product\",\n \"jet_browse_node_id\": 1000001,\n \"standard_product_codes\": [\n {\n \"standard_product_code\": \"123456789012\",\n \"standard_product_code_type\": \"UPC\"\n }\n ],\n \"multipack_quantity\": 6,\n \"brand\": \"My Product's Brand\",\n \"manufacturer\": \"My Product's Manufacturer\",\n \"mfr_part_number\": \"AB-9874\",\n \"product_description\": \"This is a terrific product that everyone should own.\",\n \"bullets\": [\n \"This is bullet line 1\",\n \"This is bullet line 2\"\n ],\n\n \"shipping_weight_pounds\": 10,\n \"map_price\": 6.49,\n \"map_implementation\": \"102\",\n \"product_tax_code\": \"Generic Taxable Product\",\n \"attributes_node_specific\": [\n {\n \"attribute_id\": 95,\n \"attribute_value\": \"80\",\n \"attribute_value_unit\": \"count\"\n },\n {\n \"attribute_id\": 119,\n \"attribute_value\": \"aqua\"\n },\n {\n \"attribute_id\": 2,\n \"attribute_value\": \"blue\"\n }\n ],\n \"main_image_url\": \"http://www.mydomain.com/images/myImage.png\"\n\t}\n}", "language": "json", "name": "MerchantSKUs file" }, { "code": "{\n\t\"{user_defined_merchant_sku}\":{\n \t\"price\":12.33\n\t},\n \"{user_defined_merchant_sku}\":{\n \t\"price\":21.23\n\t}\n}", "language": "json", "name": "Price file" }, { "code": "{\n\t\"{user_defined_merchant_sku}\":{ \t\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"XISNDKSANDSFNCSJKFDNFKJHFJD\",\n \"quantity\": 100\n },\n {\n \"fulfillment_node_id\": \"AKSDKDJIJDISJFIDFJIDSIFFISI\",\n \"quantity\": 20\n }\n ]\n\t},\n \"{user_defined_merchant_sku}\":{\n \t\t\"fulfillment_nodes\": []\n\t}\n}", "language": "json", "name": "Inventory file" }, { "code": "{\n\t\"{user_defined_merchant_sku}\":{ \t\n \"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"1234DKSANDSFNCSJKFDNFKJHFAZ\",\n \"shipping_exceptions\": [\n {\n \"shipping_method\": \"Freight\",\n \"override_type\": \"Additional charge\",\n \"shipping_charge_amount\": 3.25,\n \"shipping_exception_type\": \"exclusive\"\n }\n ]\n }\n ]\n\t},\n \"{user_defined_merchant_sku}\":{\n \t\t\"fulfillment_nodes\": [\n {\n \"fulfillment_node_id\": \"XISNDKSANDSFNCSJKFDNFKJHFJD\",\n \"shipping_exceptions\": [\n {\n \"service_level\": \"Standard\",\n \"shipping_exception_type\": \"restricted\"\n },\n {\n \"shipping_method\": \"UPS Ground\",\n \"shipping_exception_type\": \"restricted\"\n }\n ]\n }\n ]\n\t}\n}", "language": "json", "name": "ShippingException file" }, { "code": "{\n \t\"{user_defined_merchant_sku}\":{\n \"time_to_return\": 5,\n \"return_location_ids\": [\n \"9046335c27d146ee94b23ef61d8959bc\",\n \"e3100213167d4abaa43a1c1dd6e4dc04\"\n ]\n },\n \"{user_defined_merchant_sku}\":{\n \"time_to_return\": 5\n }\n}", "language": "json", "name": "ReturnsException file" }, { "code": "{\n\t\"{user_defined_merchant_sku}\":{ \t\n \"relationship\": \"Variation\",\n \"variation_refinements\": [12, 34],\n \"children_skus\": [\n \"abcd\",\n \"efgh\"\n ]\n\t},\n \"{user_defined_merchant_sku}\":{\n \t\t\"relationship\": \"Variation\",\n \"variation_refinements\": [12, 34],\n \"children_skus\": [\n \"zyxw\",\n \"dcba\"\n ]\n\t}\n}", "language": "json", "name": "Variation file" }, { "code": "{\n\t\"{user_defined_merchant_sku}\":{ \t\n\t\t\t\"is_archived\":true\n\t},\n \"{user_defined_merchant_sku}\":{\n \t\t\"is_archived\":false\n\t}\n}", "language": "json", "name": "Archive file" } ], "sidebar": true } [/block]
{"_id":"56fd2bf327b4321900186eec","order":1,"project":"562e25f2e01a430d00c2c91e","type":"get","excerpt":"","isReference":false,"link_external":false,"link_url":"","updates":[],"version":"56fd2bf327b4321900186ec6","githubsync":"","next":{"description":"","pages":[]},"parentDoc":null,"slug":"upload-token-url","title":"Request Upload URL","sync_unique":"","user":"562e25d24376430d006f1769","__v":1,"api":{"settings":"","url":"/files/uploadToken","auth":"required","examples":{"codes":[]},"method":"get","params":[],"results":{"codes":[{"status":200,"name":"Response","code":"{\n    \"url\" : \"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd?sv=2014-02-14&sr=b&sig=PCIQGWiwzHmdBeEQbFTnOeyAdGowKcQYbTg9OPIvEQo%3D&se=2014-10-15T22%3A23%3A28Z&sp=w\",\n  \"jet_file_id\" : \"dca10a71128940bf80aca9edee52e7cd\",\n  \"expires_in_seconds\" : 1800\n}","language":"json"}]}},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body\"\n}\n[/block]\nThe JET API also allows for a batched file upload. The file needs to be in a .json.gz format. All files have to be gzipped.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"\",\n    \"h-4\": \"\",\n    \"0-0\": \"**url***\\n\\n*string*\",\n    \"0-1\": \"The URL where the file should be uploaded\",\n    \"0-3\": \"\",\n    \"1-0\": \"**jet_file_id***\\n\\n*string*\",\n    \"1-1\": \"The Jet-defined ID associated with the file upload\",\n    \"1-3\": \"\",\n    \"2-0\": \"**expires_in_seconds***\\n\\n*integer*\",\n    \"2-1\": \"The amount of time in seconds the available URL will be open to put a file\",\n    \"2-3\": \"\",\n    \"0-4\": \"\",\n    \"1-4\": \"yes\",\n    \"2-4\": \"yes\",\n    \"1-2\": \"\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\\* denotes that the field will always come back in the response","category":"56fd2bf327b4321900186eca","createdAt":"2015-11-28T22:46:50.081Z","hidden":false,"childrenPages":[]}

getRequest Upload URL


[block:api-header] { "type": "basic", "title": "Response Body" } [/block] The JET API also allows for a batched file upload. The file needs to be in a .json.gz format. All files have to be gzipped. [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "", "h-4": "", "0-0": "**url***\n\n*string*", "0-1": "The URL where the file should be uploaded", "0-3": "", "1-0": "**jet_file_id***\n\n*string*", "1-1": "The Jet-defined ID associated with the file upload", "1-3": "", "2-0": "**expires_in_seconds***\n\n*integer*", "2-1": "The amount of time in seconds the available URL will be open to put a file", "2-3": "", "0-4": "", "1-4": "yes", "2-4": "yes", "1-2": "" }, "cols": 3, "rows": 3 } [/block] \* denotes that the field will always come back in the response

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response Body" } [/block] The JET API also allows for a batched file upload. The file needs to be in a .json.gz format. All files have to be gzipped. [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "", "h-4": "", "0-0": "**url***\n\n*string*", "0-1": "The URL where the file should be uploaded", "0-3": "", "1-0": "**jet_file_id***\n\n*string*", "1-1": "The Jet-defined ID associated with the file upload", "1-3": "", "2-0": "**expires_in_seconds***\n\n*integer*", "2-1": "The amount of time in seconds the available URL will be open to put a file", "2-3": "", "0-4": "", "1-4": "yes", "2-4": "yes", "1-2": "" }, "cols": 3, "rows": 3 } [/block] \* denotes that the field will always come back in the response
{"_id":"56fd2bf327b4321900186eed","version":"56fd2bf327b4321900186ec6","githubsync":"","hidden":false,"link_external":false,"parentDoc":null,"updates":[],"next":{"description":"","pages":[]},"title":"Upload File to URL","__v":1,"api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"56a39442dba3f40d00f9724f","url":"","auth":"required","examples":{"codes":[]},"method":"put"},"category":"56fd2bf327b4321900186eca","createdAt":"2016-01-23T16:32:31.749Z","isReference":false,"link_url":"","type":"put","user":"562e25d24376430d006f1769","body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Reminder that Files Must be GZIP\",\n  \"body\": \"Please remember to GZIP all JSON files before uploading.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Headers\",\n  \"body\": \"Please note that the only header is listed below. This endpoint requires no additional authorization.\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Header\",\n    \"h-1\": \"Value\",\n    \"0-0\": \"x-ms-blob-type\",\n    \"0-1\": \"blockblob\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]","order":2,"slug":"testinput-1","excerpt":"","project":"562e25f2e01a430d00c2c91e","sync_unique":"","childrenPages":[]}

putUpload File to URL


[block:callout] { "type": "warning", "title": "Reminder that Files Must be GZIP", "body": "Please remember to GZIP all JSON files before uploading." } [/block] [block:callout] { "type": "info", "title": "Headers", "body": "Please note that the only header is listed below. This endpoint requires no additional authorization." } [/block] [block:parameters] { "data": { "h-0": "Header", "h-1": "Value", "0-0": "x-ms-blob-type", "0-1": "blockblob" }, "cols": 2, "rows": 1 } [/block]
[block:callout] { "type": "warning", "title": "Reminder that Files Must be GZIP", "body": "Please remember to GZIP all JSON files before uploading." } [/block] [block:callout] { "type": "info", "title": "Headers", "body": "Please note that the only header is listed below. This endpoint requires no additional authorization." } [/block] [block:parameters] { "data": { "h-0": "Header", "h-1": "Value", "0-0": "x-ms-blob-type", "0-1": "blockblob" }, "cols": 2, "rows": 1 } [/block]
{"_id":"56fd2bf327b4321900186eee","__v":1,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request Body\"\n}\n[/block]\nUsing the JET API you can add a file to a generated URL specified. Once added you will then tell Jet using a POST method to process this file. The file will remain in our storage for 21 days. \n\nThe fields below will inform Jet that the file has been placed in the queue\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"\",\n    \"0-0\": \"**url***\\n\\n*string*\",\n    \"0-1\": \"Generated URL using the upload token\",\n    \"0-2\": \"\",\n    \"0-3\": \"\",\n    \"1-0\": \"**file_type***\\n\\n*string*\",\n    \"1-1\": \"Type of the file uploaded\",\n    \"1-2\": \"Must be one of the following values:\\n* MerchantSKUs\\n* Inventory\\n* Price\\n* Variation\\n* ReturnsException\\n* ShippingException\\n* Archive\",\n    \"1-3\": \"\",\n    \"2-0\": \"**file_name***\\n\\n*string*\",\n    \"2-1\": \"Original file name\",\n    \"2-2\": \"\",\n    \"2-3\": \"\",\n    \"h-4\": \"Required\",\n    \"0-4\": \"yes\",\n    \"1-4\": \"yes\",\n    \"2-4\": \"yes\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\\* denotes that the field is required\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use Cases\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Here are some more examples of possible implementations\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"url\\\": \\\"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd?sv=2014-02-14&sr=b&sig=PCIQGWiwzHmdBeEQbFTnOeyAdGowKcQYbTg9OPIvEQo%3D&se=2014-10-15T22%3A23%3A28Z&sp=w\\\",\\n  \\\"file_type\\\": \\\"MerchantSKUs\\\",\\n  \\\"file_name\\\": \\\"Merchant_skus.json.gz\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"MerchantSKUs\"\n    },\n    {\n      \"code\": \"{\\n  \\\"url\\\": \\\"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd?sv=2014-02-14&sr=b&sig=PCIQGWiwzHmdBeEQbFTnOeyAdGowKcQYbTg9OPIvEQo%3D&se=2014-10-15T22%3A23%3A28Z&sp=w\\\",\\n  \\\"file_type\\\": \\\"Inventory\\\",\\n  \\\"file_name\\\": \\\"inventory.json.gz\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Inventory\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","createdAt":"2015-11-30T22:31:08.832Z","isReference":false,"project":"562e25f2e01a430d00c2c91e","slug":"uploaded-files","title":"Request to Process Uploaded File","api":{"examples":{"codes":[]},"method":"post","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"url\": \"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd?sv=2014-02-14&sr=b&sig=PCIQGWiwzHmdBeEQbFTnOeyAdGowKcQYbTg9OPIvEQo%3D&se=2014-10-15T22%3A23%3A28Z&sp=w\",\n  \"file_type\": \"MerchantSKUs\",\n  \"file_name\": \"Merchant_skus.json\"\n}"}]},"settings":"","url":"/files/uploaded","auth":"required"},"category":"56fd2bf327b4321900186eca","githubsync":"","next":{"description":"","pages":[]},"order":3,"parentDoc":null,"updates":[],"user":"562e25d24376430d006f1769","excerpt":"","hidden":false,"link_external":false,"sync_unique":"","type":"post","version":"56fd2bf327b4321900186ec6","link_url":"","childrenPages":[]}

postRequest to Process Uploaded File


[block:api-header] { "type": "basic", "title": "Request Body" } [/block] Using the JET API you can add a file to a generated URL specified. Once added you will then tell Jet using a POST method to process this file. The file will remain in our storage for 21 days. The fields below will inform Jet that the file has been placed in the queue [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "", "0-0": "**url***\n\n*string*", "0-1": "Generated URL using the upload token", "0-2": "", "0-3": "", "1-0": "**file_type***\n\n*string*", "1-1": "Type of the file uploaded", "1-2": "Must be one of the following values:\n* MerchantSKUs\n* Inventory\n* Price\n* Variation\n* ReturnsException\n* ShippingException\n* Archive", "1-3": "", "2-0": "**file_name***\n\n*string*", "2-1": "Original file name", "2-2": "", "2-3": "", "h-4": "Required", "0-4": "yes", "1-4": "yes", "2-4": "yes" }, "cols": 3, "rows": 3 } [/block] \* denotes that the field is required [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Here are some more examples of possible implementations", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"url\": \"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd?sv=2014-02-14&sr=b&sig=PCIQGWiwzHmdBeEQbFTnOeyAdGowKcQYbTg9OPIvEQo%3D&se=2014-10-15T22%3A23%3A28Z&sp=w\",\n \"file_type\": \"MerchantSKUs\",\n \"file_name\": \"Merchant_skus.json.gz\"\n}", "language": "json", "name": "MerchantSKUs" }, { "code": "{\n \"url\": \"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd?sv=2014-02-14&sr=b&sig=PCIQGWiwzHmdBeEQbFTnOeyAdGowKcQYbTg9OPIvEQo%3D&se=2014-10-15T22%3A23%3A28Z&sp=w\",\n \"file_type\": \"Inventory\",\n \"file_name\": \"inventory.json.gz\"\n}", "language": "json", "name": "Inventory" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Request Body" } [/block] Using the JET API you can add a file to a generated URL specified. Once added you will then tell Jet using a POST method to process this file. The file will remain in our storage for 21 days. The fields below will inform Jet that the file has been placed in the queue [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "", "0-0": "**url***\n\n*string*", "0-1": "Generated URL using the upload token", "0-2": "", "0-3": "", "1-0": "**file_type***\n\n*string*", "1-1": "Type of the file uploaded", "1-2": "Must be one of the following values:\n* MerchantSKUs\n* Inventory\n* Price\n* Variation\n* ReturnsException\n* ShippingException\n* Archive", "1-3": "", "2-0": "**file_name***\n\n*string*", "2-1": "Original file name", "2-2": "", "2-3": "", "h-4": "Required", "0-4": "yes", "1-4": "yes", "2-4": "yes" }, "cols": 3, "rows": 3 } [/block] \* denotes that the field is required [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Here are some more examples of possible implementations", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"url\": \"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd?sv=2014-02-14&sr=b&sig=PCIQGWiwzHmdBeEQbFTnOeyAdGowKcQYbTg9OPIvEQo%3D&se=2014-10-15T22%3A23%3A28Z&sp=w\",\n \"file_type\": \"MerchantSKUs\",\n \"file_name\": \"Merchant_skus.json.gz\"\n}", "language": "json", "name": "MerchantSKUs" }, { "code": "{\n \"url\": \"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd?sv=2014-02-14&sr=b&sig=PCIQGWiwzHmdBeEQbFTnOeyAdGowKcQYbTg9OPIvEQo%3D&se=2014-10-15T22%3A23%3A28Z&sp=w\",\n \"file_type\": \"Inventory\",\n \"file_name\": \"inventory.json.gz\"\n}", "language": "json", "name": "Inventory" } ], "sidebar": true } [/block]
{"_id":"56fd2bf327b4321900186eef","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body\"\n}\n[/block]\nThe following fields are a part of the response body:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"\",\n    \"h-4\": \"Required\",\n    \"0-0\": \"**url***\\n\\n*string*\",\n    \"0-1\": \"The URL where the file was placed\",\n    \"0-3\": \"\",\n    \"1-0\": \"**file_type***\\n\\n*string*\",\n    \"1-1\": \"Type of file that was uploaded\",\n    \"1-2\": \"Must be one of the following values:\\n* MerchantSKUs\\n* Price\\n* Inventory\\n* Variation\\n* Archive\\n* ShippingException\\n* ReturnsException\",\n    \"1-3\": \"\",\n    \"2-0\": \"**file_name***\\n\\n*string*\",\n    \"2-1\": \"Merchant's name for the file\",\n    \"2-2\": \"\",\n    \"3-0\": \"**received***\\n\\n*string*\",\n    \"4-0\": \"**processing_start**\\n\\n*string*\",\n    \"5-0\": \"**processing_end**\\n\\n*string*\",\n    \"6-0\": \"**status***\\n\\n*string*\",\n    \"7-0\": \"**error_count**\\n\\n*integer*\",\n    \"8-0\": \"**error_url**\\n\\n*string*\",\n    \"9-0\": \"**error_excerpt**\\n\\n*string array*\",\n    \"10-0\": \"**jet_file_id***\\n\\n*string*\",\n    \"3-1\": \"The date-time the file was received\",\n    \"4-1\": \"The date-time the file started processing\",\n    \"5-1\": \"The date-time the file finished processing\",\n    \"6-1\": \"The status of the file\",\n    \"7-1\": \"Number of errors encountered when processing the file\",\n    \"8-1\": \"URL to the file with errors\",\n    \"9-1\": \"First 20 errors with description of location in the file\",\n    \"10-1\": \"An identification assigned by Jet to track the file.  This identification retrieves the file upload details including processing errors\",\n    \"3-2\": \"\",\n    \"4-2\": \"\",\n    \"5-2\": \"\",\n    \"6-2\": \"Must be one of the following values:\\n* Acknowledged\\n* Processing\\n* Processed with errors\\n* Processed successfully\",\n    \"2-3\": \"\",\n    \"3-3\": \"\",\n    \"4-3\": \"\",\n    \"5-3\": \"\",\n    \"6-3\": \"\",\n    \"7-3\": \"\",\n    \"8-3\": \"\",\n    \"9-3\": \"\",\n    \"10-3\": \"\",\n    \"2-4\": \"yes\",\n    \"1-4\": \"yes\",\n    \"0-4\": \"yes\",\n    \"6-4\": \"yes\",\n    \"5-4\": \"Optional\",\n    \"4-4\": \"yes\",\n    \"3-4\": \"yes\",\n    \"7-4\": \"Required if status is \\\"Processed with errors\\\"\",\n    \"8-4\": \"Required if status is \\\"Processed with errors\\\"\",\n    \"9-4\": \"Required if status is \\\"Processed with errors\\\"\",\n    \"10-4\": \"yes\",\n    \"10-2\": \"\"\n  },\n  \"cols\": 3,\n  \"rows\": 11\n}\n[/block]\n\\* denotes the field will always be returned in the response\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use Cases\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Examples for how the data might be returned\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"url\\\" : \\\"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd\\\",\\n    \\\"file_type\\\" : \\\"MerchantSKUs\\\",\\n    \\\"received\\\" : \\\"2014-07-26T:04:00.0000000Z\\\",\\n    \\\"processing_start\\\" : \\\"2014-07-26T:04:01.0000000Z\\\",\\n    \\\"processing_end\\\" : \\\"2014-07-26T:04:02.0000000Z\\\",\\n    \\\"file_name\\\" : \\\"dca10a71128940bf80aca9edee52e7cd\\\",\\n    \\\"status\\\" : \\\"Processed successfully\\\" //everything in the file has processed \\n}\",\n      \"language\": \"json\",\n      \"name\": \"Processed Successfully\"\n    },\n    {\n      \"code\": \"{\\n    \\\"url\\\" : \\\"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd\\\",\\n    \\\"file_type\\\" : \\\"MerchantSKUs\\\",\\n    \\\"received\\\" : \\\"2014-07-26T:04:00.0000000Z\\\",\\n    \\\"file_name\\\" : \\\"dca10a71128940bf80aca9edee52e7cd\\\",\\n    \\\"status\\\" : \\\"Acknowledged\\\" //file is sitting in queue\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Acknowledged File\"\n    },\n    {\n      \"code\": \"{\\n    \\\"url\\\" : \\\"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd\\\",\\n    \\\"file_type\\\" : \\\"MerchantSKUs\\\",\\n    \\\"received\\\" : \\\"2014-07-26T:04:00.0000000Z\\\",\\n    \\\"processing_start\\\" : \\\"2014-07-26T:04:01.0000000Z\\\",\\n    \\\"processing_end\\\" : \\\"2014-07-26T:04:02.0000000Z\\\",\\n    \\\"file_name\\\" : \\\"dca10a71128940bf80aca9edee52e7cd\\\",\\n    \\\"status\\\" : \\\"Processed with errors\\\", //This file had errors, please correct and upload again\\n    \\\"error_count\\\" : 1,\\n    \\\"error_url\\\" : \\\"https://jetupload.blob.core.windows.net/merchant-files-results/dca10a71128940bf80aca9edee52e7cd\\\",\\n    \\\"error_excerpt\\\" : [\\n      \\\"Position 12, 14: Error: parsing sku 'ABCD' You must supply either an ASIN, at least one standard product code, or a brand and a manufacturer part number\\\",\\n      \\\"Position 185, 1: Error: parsing sku 'EFGH' start_selling_date is not a valid date.\\\",\\n      \\\"Position 385, 1: Error: parsing sku 'EFGH' Invalid UPC Code.\\\"\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Processed with Errors\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","link_url":"","next":{"description":"","pages":[]},"order":4,"project":"562e25f2e01a430d00c2c91e","type":"get","user":"562e25d24376430d006f1769","__v":1,"api":{"params":[{"ref":"","required":false,"desc":"","default":"","type":"string","name":"jet_file_id","in":"path","_id":"565ccb70d18ae50d007183c9"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"url\" : \"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd\",\n    \"file_type\" : \"MerchantSKUs\",\n    \"received\" : \"2014-07-26T:04:00.0000000Z\",\n    \"processing_start\" : \"2014-07-26T:04:01.0000000Z\",\n    \"processing_end\" : \"2014-07-26T:04:02.0000000Z\",\n    \"file_name\" : \"dca10a71128940bf80aca9edee52e7cd\",\n    \"status\" : \"Processed successfully\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/files/{jet_file_id}","auth":"required","examples":{"codes":[]},"method":"get"},"createdAt":"2015-11-30T22:19:28.183Z","editedParams":true,"githubsync":"","parentDoc":null,"title":"Verify Processing Success","category":"56fd2bf327b4321900186eca","version":"56fd2bf327b4321900186ec6","editedParams2":true,"hidden":false,"isReference":false,"link_external":false,"slug":"jet-file-id","sync_unique":"","updates":[],"childrenPages":[]}

getVerify Processing Success


Path Params

jet_file_id:
string
[block:api-header] { "type": "basic", "title": "Response Body" } [/block] The following fields are a part of the response body: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "", "h-4": "Required", "0-0": "**url***\n\n*string*", "0-1": "The URL where the file was placed", "0-3": "", "1-0": "**file_type***\n\n*string*", "1-1": "Type of file that was uploaded", "1-2": "Must be one of the following values:\n* MerchantSKUs\n* Price\n* Inventory\n* Variation\n* Archive\n* ShippingException\n* ReturnsException", "1-3": "", "2-0": "**file_name***\n\n*string*", "2-1": "Merchant's name for the file", "2-2": "", "3-0": "**received***\n\n*string*", "4-0": "**processing_start**\n\n*string*", "5-0": "**processing_end**\n\n*string*", "6-0": "**status***\n\n*string*", "7-0": "**error_count**\n\n*integer*", "8-0": "**error_url**\n\n*string*", "9-0": "**error_excerpt**\n\n*string array*", "10-0": "**jet_file_id***\n\n*string*", "3-1": "The date-time the file was received", "4-1": "The date-time the file started processing", "5-1": "The date-time the file finished processing", "6-1": "The status of the file", "7-1": "Number of errors encountered when processing the file", "8-1": "URL to the file with errors", "9-1": "First 20 errors with description of location in the file", "10-1": "An identification assigned by Jet to track the file. This identification retrieves the file upload details including processing errors", "3-2": "", "4-2": "", "5-2": "", "6-2": "Must be one of the following values:\n* Acknowledged\n* Processing\n* Processed with errors\n* Processed successfully", "2-3": "", "3-3": "", "4-3": "", "5-3": "", "6-3": "", "7-3": "", "8-3": "", "9-3": "", "10-3": "", "2-4": "yes", "1-4": "yes", "0-4": "yes", "6-4": "yes", "5-4": "Optional", "4-4": "yes", "3-4": "yes", "7-4": "Required if status is \"Processed with errors\"", "8-4": "Required if status is \"Processed with errors\"", "9-4": "Required if status is \"Processed with errors\"", "10-4": "yes", "10-2": "" }, "cols": 3, "rows": 11 } [/block] \* denotes the field will always be returned in the response [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Examples for how the data might be returned", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"url\" : \"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd\",\n \"file_type\" : \"MerchantSKUs\",\n \"received\" : \"2014-07-26T:04:00.0000000Z\",\n \"processing_start\" : \"2014-07-26T:04:01.0000000Z\",\n \"processing_end\" : \"2014-07-26T:04:02.0000000Z\",\n \"file_name\" : \"dca10a71128940bf80aca9edee52e7cd\",\n \"status\" : \"Processed successfully\" //everything in the file has processed \n}", "language": "json", "name": "Processed Successfully" }, { "code": "{\n \"url\" : \"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd\",\n \"file_type\" : \"MerchantSKUs\",\n \"received\" : \"2014-07-26T:04:00.0000000Z\",\n \"file_name\" : \"dca10a71128940bf80aca9edee52e7cd\",\n \"status\" : \"Acknowledged\" //file is sitting in queue\n}", "language": "json", "name": "Acknowledged File" }, { "code": "{\n \"url\" : \"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd\",\n \"file_type\" : \"MerchantSKUs\",\n \"received\" : \"2014-07-26T:04:00.0000000Z\",\n \"processing_start\" : \"2014-07-26T:04:01.0000000Z\",\n \"processing_end\" : \"2014-07-26T:04:02.0000000Z\",\n \"file_name\" : \"dca10a71128940bf80aca9edee52e7cd\",\n \"status\" : \"Processed with errors\", //This file had errors, please correct and upload again\n \"error_count\" : 1,\n \"error_url\" : \"https://jetupload.blob.core.windows.net/merchant-files-results/dca10a71128940bf80aca9edee52e7cd\",\n \"error_excerpt\" : [\n \"Position 12, 14: Error: parsing sku 'ABCD' You must supply either an ASIN, at least one standard product code, or a brand and a manufacturer part number\",\n \"Position 185, 1: Error: parsing sku 'EFGH' start_selling_date is not a valid date.\",\n \"Position 385, 1: Error: parsing sku 'EFGH' Invalid UPC Code.\"\n ]\n}", "language": "json", "name": "Processed with Errors" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response Body" } [/block] The following fields are a part of the response body: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "", "h-4": "Required", "0-0": "**url***\n\n*string*", "0-1": "The URL where the file was placed", "0-3": "", "1-0": "**file_type***\n\n*string*", "1-1": "Type of file that was uploaded", "1-2": "Must be one of the following values:\n* MerchantSKUs\n* Price\n* Inventory\n* Variation\n* Archive\n* ShippingException\n* ReturnsException", "1-3": "", "2-0": "**file_name***\n\n*string*", "2-1": "Merchant's name for the file", "2-2": "", "3-0": "**received***\n\n*string*", "4-0": "**processing_start**\n\n*string*", "5-0": "**processing_end**\n\n*string*", "6-0": "**status***\n\n*string*", "7-0": "**error_count**\n\n*integer*", "8-0": "**error_url**\n\n*string*", "9-0": "**error_excerpt**\n\n*string array*", "10-0": "**jet_file_id***\n\n*string*", "3-1": "The date-time the file was received", "4-1": "The date-time the file started processing", "5-1": "The date-time the file finished processing", "6-1": "The status of the file", "7-1": "Number of errors encountered when processing the file", "8-1": "URL to the file with errors", "9-1": "First 20 errors with description of location in the file", "10-1": "An identification assigned by Jet to track the file. This identification retrieves the file upload details including processing errors", "3-2": "", "4-2": "", "5-2": "", "6-2": "Must be one of the following values:\n* Acknowledged\n* Processing\n* Processed with errors\n* Processed successfully", "2-3": "", "3-3": "", "4-3": "", "5-3": "", "6-3": "", "7-3": "", "8-3": "", "9-3": "", "10-3": "", "2-4": "yes", "1-4": "yes", "0-4": "yes", "6-4": "yes", "5-4": "Optional", "4-4": "yes", "3-4": "yes", "7-4": "Required if status is \"Processed with errors\"", "8-4": "Required if status is \"Processed with errors\"", "9-4": "Required if status is \"Processed with errors\"", "10-4": "yes", "10-2": "" }, "cols": 3, "rows": 11 } [/block] \* denotes the field will always be returned in the response [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Examples for how the data might be returned", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"url\" : \"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd\",\n \"file_type\" : \"MerchantSKUs\",\n \"received\" : \"2014-07-26T:04:00.0000000Z\",\n \"processing_start\" : \"2014-07-26T:04:01.0000000Z\",\n \"processing_end\" : \"2014-07-26T:04:02.0000000Z\",\n \"file_name\" : \"dca10a71128940bf80aca9edee52e7cd\",\n \"status\" : \"Processed successfully\" //everything in the file has processed \n}", "language": "json", "name": "Processed Successfully" }, { "code": "{\n \"url\" : \"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd\",\n \"file_type\" : \"MerchantSKUs\",\n \"received\" : \"2014-07-26T:04:00.0000000Z\",\n \"file_name\" : \"dca10a71128940bf80aca9edee52e7cd\",\n \"status\" : \"Acknowledged\" //file is sitting in queue\n}", "language": "json", "name": "Acknowledged File" }, { "code": "{\n \"url\" : \"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd\",\n \"file_type\" : \"MerchantSKUs\",\n \"received\" : \"2014-07-26T:04:00.0000000Z\",\n \"processing_start\" : \"2014-07-26T:04:01.0000000Z\",\n \"processing_end\" : \"2014-07-26T:04:02.0000000Z\",\n \"file_name\" : \"dca10a71128940bf80aca9edee52e7cd\",\n \"status\" : \"Processed with errors\", //This file had errors, please correct and upload again\n \"error_count\" : 1,\n \"error_url\" : \"https://jetupload.blob.core.windows.net/merchant-files-results/dca10a71128940bf80aca9edee52e7cd\",\n \"error_excerpt\" : [\n \"Position 12, 14: Error: parsing sku 'ABCD' You must supply either an ASIN, at least one standard product code, or a brand and a manufacturer part number\",\n \"Position 185, 1: Error: parsing sku 'EFGH' start_selling_date is not a valid date.\",\n \"Position 385, 1: Error: parsing sku 'EFGH' Invalid UPC Code.\"\n ]\n}", "language": "json", "name": "Processed with Errors" } ], "sidebar": true } [/block]
{"_id":"59b841e143d4820010c66996","project":"562e25f2e01a430d00c2c91e","version":"56fd2bf327b4321900186ec6","category":"56fd2bf327b4321900186eca","user":"562e25d24376430d006f1769","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-12T20:21:53.651Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"url\": \"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd?sv=2014-02-14&sr=b&sig=PCIQGWiwzHmdBeEQbFTnOeyAdGowKcQYbTg9OPIvEQo%3D&se=2014-10-15T22%3A23%3A28Z&sp=w\",\n  \"file_type\": \"MerchantSKUsV2\",\n  \"file_name\": \"Merchant_skus.json\"\n}"}]},"method":"post","examples":{"codes":[]},"auth":"required","params":[],"url":"/files/uploaded"},"isReference":false,"order":999,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request Body\"\n}\n[/block]\nUsing the JET API you can add a file to a generated URL specified. Once added you will then tell Jet using a POST method to process this file. The file will remain in our storage for 21 days. \n\nThe fields below will inform Jet that the file has been placed in the queue\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"\",\n    \"0-0\": \"**url***\\n\\n*string*\",\n    \"0-1\": \"Generated URL using the upload token\",\n    \"0-2\": \"\",\n    \"0-3\": \"\",\n    \"1-0\": \"**file_type***\\n\\n*string*\",\n    \"1-1\": \"Type of the file uploaded\",\n    \"1-2\": \"Must be one of the following values:\\n* MerchantSKUs\\n* Inventory\\n* Price\\n* Variation\\n* ReturnsException\\n* ShippingException\\n* Archive\\n* MerchantSKUsV2\",\n    \"1-3\": \"\",\n    \"2-0\": \"**file_name***\\n\\n*string*\",\n    \"2-1\": \"Original file name\",\n    \"2-2\": \"\",\n    \"2-3\": \"\",\n    \"h-4\": \"Required\",\n    \"0-4\": \"yes\",\n    \"1-4\": \"yes\",\n    \"2-4\": \"yes\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\\* denotes that the field is required\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use Cases\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Here are some more examples of possible implementations\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"url\\\": \\\"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd?sv=2014-02-14&sr=b&sig=PCIQGWiwzHmdBeEQbFTnOeyAdGowKcQYbTg9OPIvEQo%3D&se=2014-10-15T22%3A23%3A28Z&sp=w\\\",\\n  \\\"file_type\\\": \\\"MerchantSKUsV2\\\",\\n  \\\"file_name\\\": \\\"Merchant_skus.json.gz\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"MerchantSKUs\"\n    },\n    {\n      \"code\": \"{\\n  \\\"url\\\": \\\"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd?sv=2014-02-14&sr=b&sig=PCIQGWiwzHmdBeEQbFTnOeyAdGowKcQYbTg9OPIvEQo%3D&se=2014-10-15T22%3A23%3A28Z&sp=w\\\",\\n  \\\"file_type\\\": \\\"Inventory\\\",\\n  \\\"file_name\\\": \\\"inventory.json.gz\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Inventory\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"request-to-process-uploaded-file-with-shoe","type":"post","title":"Request to Process Uploaded File (Only Shoe Category)","__v":0,"childrenPages":[]}

postRequest to Process Uploaded File (Only Shoe Category)


[block:api-header] { "type": "basic", "title": "Request Body" } [/block] Using the JET API you can add a file to a generated URL specified. Once added you will then tell Jet using a POST method to process this file. The file will remain in our storage for 21 days. The fields below will inform Jet that the file has been placed in the queue [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "", "0-0": "**url***\n\n*string*", "0-1": "Generated URL using the upload token", "0-2": "", "0-3": "", "1-0": "**file_type***\n\n*string*", "1-1": "Type of the file uploaded", "1-2": "Must be one of the following values:\n* MerchantSKUs\n* Inventory\n* Price\n* Variation\n* ReturnsException\n* ShippingException\n* Archive\n* MerchantSKUsV2", "1-3": "", "2-0": "**file_name***\n\n*string*", "2-1": "Original file name", "2-2": "", "2-3": "", "h-4": "Required", "0-4": "yes", "1-4": "yes", "2-4": "yes" }, "cols": 3, "rows": 3 } [/block] \* denotes that the field is required [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Here are some more examples of possible implementations", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"url\": \"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd?sv=2014-02-14&sr=b&sig=PCIQGWiwzHmdBeEQbFTnOeyAdGowKcQYbTg9OPIvEQo%3D&se=2014-10-15T22%3A23%3A28Z&sp=w\",\n \"file_type\": \"MerchantSKUsV2\",\n \"file_name\": \"Merchant_skus.json.gz\"\n}", "language": "json", "name": "MerchantSKUs" }, { "code": "{\n \"url\": \"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd?sv=2014-02-14&sr=b&sig=PCIQGWiwzHmdBeEQbFTnOeyAdGowKcQYbTg9OPIvEQo%3D&se=2014-10-15T22%3A23%3A28Z&sp=w\",\n \"file_type\": \"Inventory\",\n \"file_name\": \"inventory.json.gz\"\n}", "language": "json", "name": "Inventory" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Request Body" } [/block] Using the JET API you can add a file to a generated URL specified. Once added you will then tell Jet using a POST method to process this file. The file will remain in our storage for 21 days. The fields below will inform Jet that the file has been placed in the queue [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "", "0-0": "**url***\n\n*string*", "0-1": "Generated URL using the upload token", "0-2": "", "0-3": "", "1-0": "**file_type***\n\n*string*", "1-1": "Type of the file uploaded", "1-2": "Must be one of the following values:\n* MerchantSKUs\n* Inventory\n* Price\n* Variation\n* ReturnsException\n* ShippingException\n* Archive\n* MerchantSKUsV2", "1-3": "", "2-0": "**file_name***\n\n*string*", "2-1": "Original file name", "2-2": "", "2-3": "", "h-4": "Required", "0-4": "yes", "1-4": "yes", "2-4": "yes" }, "cols": 3, "rows": 3 } [/block] \* denotes that the field is required [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Here are some more examples of possible implementations", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"url\": \"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd?sv=2014-02-14&sr=b&sig=PCIQGWiwzHmdBeEQbFTnOeyAdGowKcQYbTg9OPIvEQo%3D&se=2014-10-15T22%3A23%3A28Z&sp=w\",\n \"file_type\": \"MerchantSKUsV2\",\n \"file_name\": \"Merchant_skus.json.gz\"\n}", "language": "json", "name": "MerchantSKUs" }, { "code": "{\n \"url\": \"https://jetupload.blob.core.windows.net/merchant-files/dca10a71128940bf80aca9edee52e7cd?sv=2014-02-14&sr=b&sig=PCIQGWiwzHmdBeEQbFTnOeyAdGowKcQYbTg9OPIvEQo%3D&se=2014-10-15T22%3A23%3A28Z&sp=w\",\n \"file_type\": \"Inventory\",\n \"file_name\": \"inventory.json.gz\"\n}", "language": "json", "name": "Inventory" } ], "sidebar": true } [/block]
{"_id":"59b96ca494e988001c402113","project":"562e25f2e01a430d00c2c91e","version":"56fd2bf327b4321900186ec6","category":"56fd2bf327b4321900186eca","user":"562e25d24376430d006f1769","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-13T17:36:36.230Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"language":"json","status":200,"name":"","code":"{}"},{"status":400,"name":"","code":"{}","language":"json"}]},"auth":"required","params":[],"url":""},"isReference":false,"order":999,"body":"There are four endpoints associated with the Bulk JSON File upload, all of which must be used to ensure that a file has been processed and will enter the Jet system successfully. From a high level, the workflow is as follows: \n* User [GETs](https://developer.jet.com/docs/upload-token-url) from Jet an Azure URL where the file is to be uploaded \n* User [PUTs](https://developer.jet.com/docs/testinput-1) a GZIP file to this Azure URL\n* User [POSTs](https://developer.jet.com/docs/uploaded-files) an instruction for Jet to process the upload file \n* User [GETs](https://developer.jet.com/docs/uploaded-files) the file status to ensure that Jet has successfully processed the file \n\nUploaded files will only be accessible for 30 days after upload.\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"File Processing and HTTP Codes\",\n  \"body\": \"Please be aware that a \\\"200 OK\\\" HTTP code on any of the File Upload endpoints does not indicate that a file has been processed successfully. It merely indicates that the request in question was valid and accepted. \\n\\nFor information on whether the file has been processed successfully, users must refer to the \\\"status\\\" field returned by a GET to the [Verify Processing Success](https://developer.jet.com/docs/jet-file-id) endpoint. \\n\\nIf errors are returned, download the associated \\\"error_url\\\" to see the specific errors for each record.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"File Sizes\",\n  \"body\": \"The file size which will optimize processing time is **100K records.** \\n\\nWe ask that if the merchant plans to upload **500K or more records**, they space the uploads out over several hours. \\n\\nAdditionally, we ask that if the merchant plans to upload less than **10K records**, they use the merchant API as opposed to the bulk JSON file upload.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"File Examples\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Example file constructions for each file type\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"{user_defined_merchant_sku}\\\": {\\n        \\\"product_type_id\\\": 37005005000,\\n        \\\"product_title\\\": \\\"Nike Men's Air Max Running Shoe\\\",\\n        \\\"standard_product_codes\\\": [\\n          {\\n          \\\"standard_product_code\\\": \\\"123456789012\\\",\\n          \\\"standard_product_code_type\\\": \\\"UPC\\\"\\n          }\\n        ],\\n        \\\"multipack_quantity\\\": 1,\\n        \\\"brand\\\": \\\"Nike\\\",\\n        \\\"product_description\\\": \\\"This is a terrific product that everyone should own.\\\",\\n        \\\"bullets\\\": [\\n          \\\"This is bullet line 1\\\",\\n          \\\"This is bullet line 2\\\"\\n        ],\\n        \\\"main_image_url\\\": \\\"http://www.mydomain.com/images/myImage.png\\\", \\n        \\\"attributes_node_specific\\\": [\\n          {\\n          \\\"attribute_id\\\": 770703275075886,\\n          \\\"attribute_value\\\": \\\"Men\\\"\\n          },\\n          {\\n          \\\"attribute_id\\\": 969418632494197,\\n          \\\"attribute_value\\\": \\\"9.5\\\"\\n          },\\n          {\\n          \\\"attribute_id\\\": 951803048500342,\\n          \\\"attribute_value\\\": \\\"US\\\"\\n          },\\n          {\\n          \\\"attribute_id\\\": 805390093102030,\\n          \\\"attribute_value\\\": \\\"Blue\\\"\\n          },\\n          {\\n          \\\"attribute_id\\\": 80,\\n          \\\"attribute_value\\\": \\\"D\\\"\\n          },\\n          {\\n          \\\"attribute_id\\\": 656494019201798,\\n          \\\"attribute_value\\\": \\\"Synthetic\\\"\\n          },\\n          {\\n          \\\"attribute_id\\\": 782030647047910,\\n          \\\"attribute_value\\\": \\\"Air Max\\\"\\n          }\\n        ]\\n  },\\n  \\\"{user_defined_merchant_sku}\\\":{\\n        \\\"product_type_id\\\": 37005013000,\\n        \\\"attributes_node_specific\\\": [\\n           {\\n            \\\"attribute_id\\\": 770703275075886,\\n            \\\"attribute_value\\\": \\\"Men\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 969418632494197,\\n            \\\"attribute_value\\\": \\\"9.5\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 951803048500342,\\n            \\\"attribute_value\\\": \\\"US\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 805390093102030,\\n            \\\"attribute_value\\\": \\\"Blue\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 80,\\n            \\\"attribute_value\\\": \\\"D\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 656494019201798,\\n            \\\"attribute_value\\\": \\\"Synthetic\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 782030647047910,\\n            \\\"attribute_value\\\": \\\"Cameo\\\"\\n            }\\n      ],\\n        \\\"brand\\\": \\\"SkechersY\\\",\\n        \\\"main_image_url\\\": \\\"http://www.shoebuy.com/pi/skech/jb/skech766106_42986_jb.jpg\\\",\\n        \\\"multipack_quantity\\\": 1,\\n        \\\"product_description\\\": \\\"Give younglings an appreciation of the classics with the Star Wars Skechers: Tossers - Padawan shoe. Soft woven canvas fabric upper in a slip on retro skate sneaker with printed classic Star Wars logo design and cool printed insole. Memory Foam comfort.\\\",\\n        \\\"product_title\\\": \\\"Skechers Unisex Children's  Star Wars Tossers Padawan Slip On Charcoal/Black Size 12 M\\\",\\n        \\\"standard_product_codes\\\": [\\n          {\\n            \\\"standard_product_code\\\": \\\"889110600900\\\",\\n            \\\"standard_product_code_type\\\": \\\"UPC\\\"\\n          }\\n        ]\\n  },\\n  \\\"{user_defined_merchant_sku}\\\":{\\n        \\\"product_type_id\\\": 37005013000,\\n        \\\"attributes_node_specific\\\": [\\n           {\\n            \\\"attribute_id\\\": 770703275075886,\\n            \\\"attribute_value\\\": \\\"Men\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 969418632494197,\\n            \\\"attribute_value\\\": \\\"9.5\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 951803048500342,\\n            \\\"attribute_value\\\": \\\"US\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 805390093102030,\\n            \\\"attribute_value\\\": \\\"Blue\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 80,\\n            \\\"attribute_value\\\": \\\"D\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 656494019201798,\\n            \\\"attribute_value\\\": \\\"Synthetic\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 782030647047910,\\n            \\\"attribute_value\\\": \\\"Cameo\\\"\\n            }\\n      ],\\n        \\\"brand\\\": \\\"SkechersY\\\",\\n        \\\"main_image_url\\\": \\\"http://www.shoebuy.com/pi/skech/jb/skech766106_42986_jb.jpg\\\",\\n        \\\"multipack_quantity\\\": 1,\\n        \\\"product_description\\\": \\\"Give younglings an appreciation of the classics with the Star Wars Skechers: Tossers - Padawan shoe. Soft woven canvas fabric upper in a slip on retro skate sneaker with printed classic Star Wars logo design and cool printed insole. Memory Foam comfort.\\\",\\n        \\\"product_title\\\": \\\"Skechers Unisex Children's  Star Wars Tossers Padawan Slip On Charcoal/Black Size 12 M\\\",\\n        \\\"standard_product_codes\\\": [\\n          {\\n            \\\"standard_product_code\\\": \\\"889110600900\\\",\\n            \\\"standard_product_code_type\\\": \\\"UPC\\\"\\n          }\\n        ]\\n  },\\n  \\\"{user_defined_merchant_sku}\\\":{\\n        \\\"product_type_id\\\": 37005013000,\\n        \\\"attributes_node_specific\\\": [\\n           {\\n            \\\"attribute_id\\\": 770703275075886,\\n            \\\"attribute_value\\\": \\\"Men\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 969418632494197,\\n            \\\"attribute_value\\\": \\\"9.5\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 951803048500342,\\n            \\\"attribute_value\\\": \\\"US\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 805390093102030,\\n            \\\"attribute_value\\\": \\\"Blue\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 80,\\n            \\\"attribute_value\\\": \\\"D\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 656494019201798,\\n            \\\"attribute_value\\\": \\\"Synthetic\\\"\\n            },\\n            {\\n            \\\"attribute_id\\\": 782030647047910,\\n            \\\"attribute_value\\\": \\\"Cameo\\\"\\n            }\\n      ],\\n        \\\"brand\\\": \\\"SkechersY\\\",\\n        \\\"main_image_url\\\": \\\"http://www.shoebuy.com/pi/skech/jb/skech766106_42986_jb.jpg\\\",\\n        \\\"multipack_quantity\\\": 1,\\n        \\\"product_description\\\": \\\"Give younglings an appreciation of the classics with the Star Wars Skechers: Tossers - Padawan shoe. Soft woven canvas fabric upper in a slip on retro skate sneaker with printed classic Star Wars logo design and cool printed insole. Memory Foam comfort.\\\",\\n        \\\"product_title\\\": \\\"Skechers Unisex Children's  Star Wars Tossers Padawan Slip On Charcoal/Black Size 12 M\\\",\\n        \\\"standard_product_codes\\\": [\\n          {\\n            \\\"standard_product_code\\\": \\\"889110600900\\\",\\n            \\\"standard_product_code_type\\\": \\\"UPC\\\"\\n          }\\n        ]\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"MerchantSKUsV2 file\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"json-file-examples-shoe-category","type":"basic","title":"JSON File Examples (Only Shoe Category)","__v":0,"childrenPages":[]}

JSON File Examples (Only Shoe Category)


There are four endpoints associated with the Bulk JSON File upload, all of which must be used to ensure that a file has been processed and will enter the Jet system successfully. From a high level, the workflow is as follows: * User [GETs](https://developer.jet.com/docs/upload-token-url) from Jet an Azure URL where the file is to be uploaded * User [PUTs](https://developer.jet.com/docs/testinput-1) a GZIP file to this Azure URL * User [POSTs](https://developer.jet.com/docs/uploaded-files) an instruction for Jet to process the upload file * User [GETs](https://developer.jet.com/docs/uploaded-files) the file status to ensure that Jet has successfully processed the file Uploaded files will only be accessible for 30 days after upload. [block:callout] { "type": "danger", "title": "File Processing and HTTP Codes", "body": "Please be aware that a \"200 OK\" HTTP code on any of the File Upload endpoints does not indicate that a file has been processed successfully. It merely indicates that the request in question was valid and accepted. \n\nFor information on whether the file has been processed successfully, users must refer to the \"status\" field returned by a GET to the [Verify Processing Success](https://developer.jet.com/docs/jet-file-id) endpoint. \n\nIf errors are returned, download the associated \"error_url\" to see the specific errors for each record." } [/block] [block:callout] { "type": "warning", "title": "File Sizes", "body": "The file size which will optimize processing time is **100K records.** \n\nWe ask that if the merchant plans to upload **500K or more records**, they space the uploads out over several hours. \n\nAdditionally, we ask that if the merchant plans to upload less than **10K records**, they use the merchant API as opposed to the bulk JSON file upload." } [/block] [block:api-header] { "type": "basic", "title": "File Examples", "sidebar": true } [/block] [block:textarea] { "text": "Example file constructions for each file type", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"{user_defined_merchant_sku}\": {\n \"product_type_id\": 37005005000,\n \"product_title\": \"Nike Men's Air Max Running Shoe\",\n \"standard_product_codes\": [\n {\n \"standard_product_code\": \"123456789012\",\n \"standard_product_code_type\": \"UPC\"\n }\n ],\n \"multipack_quantity\": 1,\n \"brand\": \"Nike\",\n \"product_description\": \"This is a terrific product that everyone should own.\",\n \"bullets\": [\n \"This is bullet line 1\",\n \"This is bullet line 2\"\n ],\n \"main_image_url\": \"http://www.mydomain.com/images/myImage.png\", \n \"attributes_node_specific\": [\n {\n \"attribute_id\": 770703275075886,\n \"attribute_value\": \"Men\"\n },\n {\n \"attribute_id\": 969418632494197,\n \"attribute_value\": \"9.5\"\n },\n {\n \"attribute_id\": 951803048500342,\n \"attribute_value\": \"US\"\n },\n {\n \"attribute_id\": 805390093102030,\n \"attribute_value\": \"Blue\"\n },\n {\n \"attribute_id\": 80,\n \"attribute_value\": \"D\"\n },\n {\n \"attribute_id\": 656494019201798,\n \"attribute_value\": \"Synthetic\"\n },\n {\n \"attribute_id\": 782030647047910,\n \"attribute_value\": \"Air Max\"\n }\n ]\n },\n \"{user_defined_merchant_sku}\":{\n \"product_type_id\": 37005013000,\n \"attributes_node_specific\": [\n {\n \"attribute_id\": 770703275075886,\n \"attribute_value\": \"Men\"\n },\n {\n \"attribute_id\": 969418632494197,\n \"attribute_value\": \"9.5\"\n },\n {\n \"attribute_id\": 951803048500342,\n \"attribute_value\": \"US\"\n },\n {\n \"attribute_id\": 805390093102030,\n \"attribute_value\": \"Blue\"\n },\n {\n \"attribute_id\": 80,\n \"attribute_value\": \"D\"\n },\n {\n \"attribute_id\": 656494019201798,\n \"attribute_value\": \"Synthetic\"\n },\n {\n \"attribute_id\": 782030647047910,\n \"attribute_value\": \"Cameo\"\n }\n ],\n \"brand\": \"SkechersY\",\n \"main_image_url\": \"http://www.shoebuy.com/pi/skech/jb/skech766106_42986_jb.jpg\",\n \"multipack_quantity\": 1,\n \"product_description\": \"Give younglings an appreciation of the classics with the Star Wars Skechers: Tossers - Padawan shoe. Soft woven canvas fabric upper in a slip on retro skate sneaker with printed classic Star Wars logo design and cool printed insole. Memory Foam comfort.\",\n \"product_title\": \"Skechers Unisex Children's Star Wars Tossers Padawan Slip On Charcoal/Black Size 12 M\",\n \"standard_product_codes\": [\n {\n \"standard_product_code\": \"889110600900\",\n \"standard_product_code_type\": \"UPC\"\n }\n ]\n },\n \"{user_defined_merchant_sku}\":{\n \"product_type_id\": 37005013000,\n \"attributes_node_specific\": [\n {\n \"attribute_id\": 770703275075886,\n \"attribute_value\": \"Men\"\n },\n {\n \"attribute_id\": 969418632494197,\n \"attribute_value\": \"9.5\"\n },\n {\n \"attribute_id\": 951803048500342,\n \"attribute_value\": \"US\"\n },\n {\n \"attribute_id\": 805390093102030,\n \"attribute_value\": \"Blue\"\n },\n {\n \"attribute_id\": 80,\n \"attribute_value\": \"D\"\n },\n {\n \"attribute_id\": 656494019201798,\n \"attribute_value\": \"Synthetic\"\n },\n {\n \"attribute_id\": 782030647047910,\n \"attribute_value\": \"Cameo\"\n }\n ],\n \"brand\": \"SkechersY\",\n \"main_image_url\": \"http://www.shoebuy.com/pi/skech/jb/skech766106_42986_jb.jpg\",\n \"multipack_quantity\": 1,\n \"product_description\": \"Give younglings an appreciation of the classics with the Star Wars Skechers: Tossers - Padawan shoe. Soft woven canvas fabric upper in a slip on retro skate sneaker with printed classic Star Wars logo design and cool printed insole. Memory Foam comfort.\",\n \"product_title\": \"Skechers Unisex Children's Star Wars Tossers Padawan Slip On Charcoal/Black Size 12 M\",\n \"standard_product_codes\": [\n {\n \"standard_product_code\": \"889110600900\",\n \"standard_product_code_type\": \"UPC\"\n }\n ]\n },\n \"{user_defined_merchant_sku}\":{\n \"product_type_id\": 37005013000,\n \"attributes_node_specific\": [\n {\n \"attribute_id\": 770703275075886,\n \"attribute_value\": \"Men\"\n },\n {\n \"attribute_id\": 969418632494197,\n \"attribute_value\": \"9.5\"\n },\n {\n \"attribute_id\": 951803048500342,\n \"attribute_value\": \"US\"\n },\n {\n \"attribute_id\": 805390093102030,\n \"attribute_value\": \"Blue\"\n },\n {\n \"attribute_id\": 80,\n \"attribute_value\": \"D\"\n },\n {\n \"attribute_id\": 656494019201798,\n \"attribute_value\": \"Synthetic\"\n },\n {\n \"attribute_id\": 782030647047910,\n \"attribute_value\": \"Cameo\"\n }\n ],\n \"brand\": \"SkechersY\",\n \"main_image_url\": \"http://www.shoebuy.com/pi/skech/jb/skech766106_42986_jb.jpg\",\n \"multipack_quantity\": 1,\n \"product_description\": \"Give younglings an appreciation of the classics with the Star Wars Skechers: Tossers - Padawan shoe. Soft woven canvas fabric upper in a slip on retro skate sneaker with printed classic Star Wars logo design and cool printed insole. Memory Foam comfort.\",\n \"product_title\": \"Skechers Unisex Children's Star Wars Tossers Padawan Slip On Charcoal/Black Size 12 M\",\n \"standard_product_codes\": [\n {\n \"standard_product_code\": \"889110600900\",\n \"standard_product_code_type\": \"UPC\"\n }\n ]\n }\n}", "language": "json", "name": "MerchantSKUsV2 file" } ], "sidebar": true } [/block]
There are four endpoints associated with the Bulk JSON File upload, all of which must be used to ensure that a file has been processed and will enter the Jet system successfully. From a high level, the workflow is as follows: * User [GETs](https://developer.jet.com/docs/upload-token-url) from Jet an Azure URL where the file is to be uploaded * User [PUTs](https://developer.jet.com/docs/testinput-1) a GZIP file to this Azure URL * User [POSTs](https://developer.jet.com/docs/uploaded-files) an instruction for Jet to process the upload file * User [GETs](https://developer.jet.com/docs/uploaded-files) the file status to ensure that Jet has successfully processed the file Uploaded files will only be accessible for 30 days after upload. [block:callout] { "type": "danger", "title": "File Processing and HTTP Codes", "body": "Please be aware that a \"200 OK\" HTTP code on any of the File Upload endpoints does not indicate that a file has been processed successfully. It merely indicates that the request in question was valid and accepted. \n\nFor information on whether the file has been processed successfully, users must refer to the \"status\" field returned by a GET to the [Verify Processing Success](https://developer.jet.com/docs/jet-file-id) endpoint. \n\nIf errors are returned, download the associated \"error_url\" to see the specific errors for each record." } [/block] [block:callout] { "type": "warning", "title": "File Sizes", "body": "The file size which will optimize processing time is **100K records.** \n\nWe ask that if the merchant plans to upload **500K or more records**, they space the uploads out over several hours. \n\nAdditionally, we ask that if the merchant plans to upload less than **10K records**, they use the merchant API as opposed to the bulk JSON file upload." } [/block] [block:api-header] { "type": "basic", "title": "File Examples", "sidebar": true } [/block] [block:textarea] { "text": "Example file constructions for each file type", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"{user_defined_merchant_sku}\": {\n \"product_type_id\": 37005005000,\n \"product_title\": \"Nike Men's Air Max Running Shoe\",\n \"standard_product_codes\": [\n {\n \"standard_product_code\": \"123456789012\",\n \"standard_product_code_type\": \"UPC\"\n }\n ],\n \"multipack_quantity\": 1,\n \"brand\": \"Nike\",\n \"product_description\": \"This is a terrific product that everyone should own.\",\n \"bullets\": [\n \"This is bullet line 1\",\n \"This is bullet line 2\"\n ],\n \"main_image_url\": \"http://www.mydomain.com/images/myImage.png\", \n \"attributes_node_specific\": [\n {\n \"attribute_id\": 770703275075886,\n \"attribute_value\": \"Men\"\n },\n {\n \"attribute_id\": 969418632494197,\n \"attribute_value\": \"9.5\"\n },\n {\n \"attribute_id\": 951803048500342,\n \"attribute_value\": \"US\"\n },\n {\n \"attribute_id\": 805390093102030,\n \"attribute_value\": \"Blue\"\n },\n {\n \"attribute_id\": 80,\n \"attribute_value\": \"D\"\n },\n {\n \"attribute_id\": 656494019201798,\n \"attribute_value\": \"Synthetic\"\n },\n {\n \"attribute_id\": 782030647047910,\n \"attribute_value\": \"Air Max\"\n }\n ]\n },\n \"{user_defined_merchant_sku}\":{\n \"product_type_id\": 37005013000,\n \"attributes_node_specific\": [\n {\n \"attribute_id\": 770703275075886,\n \"attribute_value\": \"Men\"\n },\n {\n \"attribute_id\": 969418632494197,\n \"attribute_value\": \"9.5\"\n },\n {\n \"attribute_id\": 951803048500342,\n \"attribute_value\": \"US\"\n },\n {\n \"attribute_id\": 805390093102030,\n \"attribute_value\": \"Blue\"\n },\n {\n \"attribute_id\": 80,\n \"attribute_value\": \"D\"\n },\n {\n \"attribute_id\": 656494019201798,\n \"attribute_value\": \"Synthetic\"\n },\n {\n \"attribute_id\": 782030647047910,\n \"attribute_value\": \"Cameo\"\n }\n ],\n \"brand\": \"SkechersY\",\n \"main_image_url\": \"http://www.shoebuy.com/pi/skech/jb/skech766106_42986_jb.jpg\",\n \"multipack_quantity\": 1,\n \"product_description\": \"Give younglings an appreciation of the classics with the Star Wars Skechers: Tossers - Padawan shoe. Soft woven canvas fabric upper in a slip on retro skate sneaker with printed classic Star Wars logo design and cool printed insole. Memory Foam comfort.\",\n \"product_title\": \"Skechers Unisex Children's Star Wars Tossers Padawan Slip On Charcoal/Black Size 12 M\",\n \"standard_product_codes\": [\n {\n \"standard_product_code\": \"889110600900\",\n \"standard_product_code_type\": \"UPC\"\n }\n ]\n },\n \"{user_defined_merchant_sku}\":{\n \"product_type_id\": 37005013000,\n \"attributes_node_specific\": [\n {\n \"attribute_id\": 770703275075886,\n \"attribute_value\": \"Men\"\n },\n {\n \"attribute_id\": 969418632494197,\n \"attribute_value\": \"9.5\"\n },\n {\n \"attribute_id\": 951803048500342,\n \"attribute_value\": \"US\"\n },\n {\n \"attribute_id\": 805390093102030,\n \"attribute_value\": \"Blue\"\n },\n {\n \"attribute_id\": 80,\n \"attribute_value\": \"D\"\n },\n {\n \"attribute_id\": 656494019201798,\n \"attribute_value\": \"Synthetic\"\n },\n {\n \"attribute_id\": 782030647047910,\n \"attribute_value\": \"Cameo\"\n }\n ],\n \"brand\": \"SkechersY\",\n \"main_image_url\": \"http://www.shoebuy.com/pi/skech/jb/skech766106_42986_jb.jpg\",\n \"multipack_quantity\": 1,\n \"product_description\": \"Give younglings an appreciation of the classics with the Star Wars Skechers: Tossers - Padawan shoe. Soft woven canvas fabric upper in a slip on retro skate sneaker with printed classic Star Wars logo design and cool printed insole. Memory Foam comfort.\",\n \"product_title\": \"Skechers Unisex Children's Star Wars Tossers Padawan Slip On Charcoal/Black Size 12 M\",\n \"standard_product_codes\": [\n {\n \"standard_product_code\": \"889110600900\",\n \"standard_product_code_type\": \"UPC\"\n }\n ]\n },\n \"{user_defined_merchant_sku}\":{\n \"product_type_id\": 37005013000,\n \"attributes_node_specific\": [\n {\n \"attribute_id\": 770703275075886,\n \"attribute_value\": \"Men\"\n },\n {\n \"attribute_id\": 969418632494197,\n \"attribute_value\": \"9.5\"\n },\n {\n \"attribute_id\": 951803048500342,\n \"attribute_value\": \"US\"\n },\n {\n \"attribute_id\": 805390093102030,\n \"attribute_value\": \"Blue\"\n },\n {\n \"attribute_id\": 80,\n \"attribute_value\": \"D\"\n },\n {\n \"attribute_id\": 656494019201798,\n \"attribute_value\": \"Synthetic\"\n },\n {\n \"attribute_id\": 782030647047910,\n \"attribute_value\": \"Cameo\"\n }\n ],\n \"brand\": \"SkechersY\",\n \"main_image_url\": \"http://www.shoebuy.com/pi/skech/jb/skech766106_42986_jb.jpg\",\n \"multipack_quantity\": 1,\n \"product_description\": \"Give younglings an appreciation of the classics with the Star Wars Skechers: Tossers - Padawan shoe. Soft woven canvas fabric upper in a slip on retro skate sneaker with printed classic Star Wars logo design and cool printed insole. Memory Foam comfort.\",\n \"product_title\": \"Skechers Unisex Children's Star Wars Tossers Padawan Slip On Charcoal/Black Size 12 M\",\n \"standard_product_codes\": [\n {\n \"standard_product_code\": \"889110600900\",\n \"standard_product_code_type\": \"UPC\"\n }\n ]\n }\n}", "language": "json", "name": "MerchantSKUsV2 file" } ], "sidebar": true } [/block]
{"_id":"56fd2bf327b4321900186ef6","order":0,"user":"562e25d24376430d006f1769","excerpt":"","githubsync":"","hidden":false,"version":"56fd2bf327b4321900186ec6","__v":6,"category":"56fd2bf327b4321900186ecb","createdAt":"2015-11-19T21:54:22.087Z","link_url":"","slug":"order-status","sync_unique":"","editedParams2":true,"isReference":false,"link_external":false,"next":{"description":"","pages":[]},"project":"562e25f2e01a430d00c2c91e","title":"Check for Orders","type":"get","updates":[],"api":{"results":{"codes":[{"status":200,"language":"json","code":"{ \n  \"order_urls\": [\n    \"/orders/withoutShipmentDetail/57e542a613fa42d8b6e8362dbd5911f5\",\n    \"/orders/withoutShipmentDetail/a10b4b28467c490984e0b387e1cc2d9a\",\n    \"/orders/withoutShipmentDetail/32c05c3230fc498e95f82129efd10213\"\n  ]\n}"},{"code":"{ \n  \"order_urls\": [] // when there are no orders in this status\n}","language":"json","status":200}]},"settings":"","url":"/orders/{status}?isCancelled={true/false}&fulfillment_node={fulfillment_node_id}","auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"564e450eeb8e551700e5faf7","ref":"","in":"path","required":false,"desc":"The current status of merchant orders","default":"","type":"string","name":"status"},{"_id":"59c2bd5f9aea850010ac2e71","ref":"","in":"query","required":false,"desc":"The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.","default":"","type":"string","name":"fulfillment_node"},{"_id":"59c2bd8f9aea850010ac2e82","ref":"","in":"query","required":false,"desc":"This parameter allows a user to specify whether they wish to be returned orders cancelled by a customer before reaching the \"ready\" status.","default":"true/false","type":"boolean","name":"IsCancelled"}]},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"URL Parameter: {status}\"\n}\n[/block]\nUsing this endpoint you can access the first 1000 orders in a certain status. The {status} can be any of the following:\n  * 'created' - The order has just been placed.  Jet.com allows a half hour for fraud check and customer cancellation.  We ask that retailers NOT fulfill orders that are created.\n  * 'ready' - The order is ready to be fulfilled by the retailer\n  * 'acknowledged' - The order has been accepted by the retailer and is awaiting fulfillment\n  * 'inprogress' - The order is partially shipped\n  * 'complete' - The order is completely shipped or cancelled.  All units have been accounted for\n\nOrders will only be available by status for 90 days after order creation.\n[block:api-header]\n{\n  \"title\": \"Optional URL Parameter: {?IsCancelled=true/false}\"\n}\n[/block]\nThis parameter allows a user to specify whether they wish to be returned orders cancelled by a customer before reaching the \"ready\" status. This parameter is to be added on after the {status} parameter described above; and can only be used in conjunction with \"complete\" orders, as all cancelled orders enter the \"complete\" status. \n\nUsers who poll for \"ready\" orders will be **unconcerned with this parameter other than for reporting purposes.** This parameter will be most useful for users polling for \"created\" orders, but this method of polling is not recommended.  \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body\"\n}\n[/block]\nThe following field is included in the response body\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**order_urls***\\n\\n*string array*\",\n    \"0-1\": \"The URL links associated with orders in the status polled\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\\* denotes that the field will always be returned in the response","editedParams":true,"parentDoc":null,"childrenPages":[]}

getCheck for Orders


Path Params

status:
string
The current status of merchant orders

Query Params

fulfillment_node:
string
The ID of the fulfillment node that was created on partner.jet.com under fulfillment settings.
IsCancelled:
booleantrue/false
This parameter allows a user to specify whether they wish to be returned orders cancelled by a customer before reaching the "ready" status.
[block:api-header] { "type": "basic", "title": "URL Parameter: {status}" } [/block] Using this endpoint you can access the first 1000 orders in a certain status. The {status} can be any of the following: * 'created' - The order has just been placed. Jet.com allows a half hour for fraud check and customer cancellation. We ask that retailers NOT fulfill orders that are created. * 'ready' - The order is ready to be fulfilled by the retailer * 'acknowledged' - The order has been accepted by the retailer and is awaiting fulfillment * 'inprogress' - The order is partially shipped * 'complete' - The order is completely shipped or cancelled. All units have been accounted for Orders will only be available by status for 90 days after order creation. [block:api-header] { "title": "Optional URL Parameter: {?IsCancelled=true/false}" } [/block] This parameter allows a user to specify whether they wish to be returned orders cancelled by a customer before reaching the "ready" status. This parameter is to be added on after the {status} parameter described above; and can only be used in conjunction with "complete" orders, as all cancelled orders enter the "complete" status. Users who poll for "ready" orders will be **unconcerned with this parameter other than for reporting purposes.** This parameter will be most useful for users polling for "created" orders, but this method of polling is not recommended. [block:api-header] { "type": "basic", "title": "Response Body" } [/block] The following field is included in the response body [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**order_urls***\n\n*string array*", "0-1": "The URL links associated with orders in the status polled" }, "cols": 3, "rows": 1 } [/block] \* denotes that the field will always be returned in the response

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "URL Parameter: {status}" } [/block] Using this endpoint you can access the first 1000 orders in a certain status. The {status} can be any of the following: * 'created' - The order has just been placed. Jet.com allows a half hour for fraud check and customer cancellation. We ask that retailers NOT fulfill orders that are created. * 'ready' - The order is ready to be fulfilled by the retailer * 'acknowledged' - The order has been accepted by the retailer and is awaiting fulfillment * 'inprogress' - The order is partially shipped * 'complete' - The order is completely shipped or cancelled. All units have been accounted for Orders will only be available by status for 90 days after order creation. [block:api-header] { "title": "Optional URL Parameter: {?IsCancelled=true/false}" } [/block] This parameter allows a user to specify whether they wish to be returned orders cancelled by a customer before reaching the "ready" status. This parameter is to be added on after the {status} parameter described above; and can only be used in conjunction with "complete" orders, as all cancelled orders enter the "complete" status. Users who poll for "ready" orders will be **unconcerned with this parameter other than for reporting purposes.** This parameter will be most useful for users polling for "created" orders, but this method of polling is not recommended. [block:api-header] { "type": "basic", "title": "Response Body" } [/block] The following field is included in the response body [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**order_urls***\n\n*string array*", "0-1": "The URL links associated with orders in the status polled" }, "cols": 3, "rows": 1 } [/block] \* denotes that the field will always be returned in the response
{"_id":"56fd2bf327b4321900186ef8","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body: Order \\\"Created\\\"\"\n}\n[/block]\nThis endpoint will provide you with requisite fulfillment information for the order denoted by the Jet Defined Order ID.\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"**merchant_order_id**\\n\\n*string*\",\n    \"0-1\": \"Jet's unique ID for a given merchant order.\",\n    \"1-0\": \"**reference_order_id**\\n\\n*string*\",\n    \"1-1\": \"Jet's human readable order ID number that may have a small chance of collision overtime.\",\n    \"3-0\": \"**fulfillment_node**\\n\\n*string*\",\n    \"3-1\": \"The fulfillment node that the order should be shipped from.\",\n    \"4-0\": \"**alt_order_id**\\n\\n*string*\",\n    \"4-1\": \"Optional Merchant supplied order ID.If an alt_order_id has been associated with the merchant_order_id via the order accept message this will be passed as well.\",\n    \"5-0\": \"**hash_email**\\n\\n*string*\",\n    \"6-0\": \"**status**\\n\\n*string*\",\n    \"7-0\": \"**exception_state**\\n\\n*string*\",\n    \"8-0\": \"**order_placed_date***\\n\\n*string*\",\n    \"9-0\": \"**order_transmission_date***\\n\\n*string*\",\n    \"10-0\": \"**order_detail**\\n\\n*object*\",\n    \"5-1\": \"The email hash assigned by Jet to be used as the customer email address\",\n    \"6-1\": \"Current status of the order\\n\\nStatus descriptions:\\n* 'created' - order was created by Jet.com but not released for fulfillment\\n* 'ready' - order ready to be acknowledged by merchant\\n* 'acknowledged' - order was acknowledged by merchant\\n* 'inprogress' - one part of the order has been shipped or cancelled\\n* 'complete' - all parts of the order have shipped or cancelled\",\n    \"6-2\": \"Must be one of the following values:\\n* created \\n* ready\\n* acknowledged \\n* inprogress \\n* complete\",\n    \"7-1\": \"Signifies that something unexpected has occurred for this order. For example, too many units shipped by merchant, merchant failed to accept order.\\n\\nException State descriptions:\\n* 'exception - too many units cancelled'\\n* 'exception - jet manual canceled to complete state'\\n* 'exception - too many units shipped'\\n* 'exception - order rejected'\\n* 'resolved'\",\n    \"7-2\": \"Must be one of the following values:\\n* 'exception - too many units cancelled'\\n* 'exception - jet manual canceled to complete state'\\n* 'exception - too many units shipped'\\n* 'exception - order rejected'\\n* 'resolved'\",\n    \"8-1\": \"The date the merchant order was placed.\",\n    \"8-2\": \"This date should be in ISO 8601 format: yyyy-MM-DDThh:mm:ss.fffffff-hh:mm\\n\\nExample: 2009-06-15T13:45:30.0000000-07:00\",\n    \"9-2\": \"This date should be in ISO 8601 format: yyyy-MM-DDThh:mm:ss.fffffff-hh:mm\\n\\nExample: 2009-06-15T13:45:30.0000000-07:00\",\n    \"9-1\": \"The date/time the merchant order was sent to the merchant\",\n    \"h-2\": \"Validation\",\n    \"2-0\": \"**customer_reference_order_id**\\n\\n*string*\",\n    \"11-0\": \"**buyer**\\n\\n*buyer object*\",\n    \"12-0\": \"**shipping_to** \\n\\n*shipping_to object*\",\n    \"10-1\": \"Shipping details about the order\",\n    \"11-1\": \"Information about the buyer\",\n    \"12-1\": \"Information about who and where the order will be shipped to\",\n    \"13-0\": \"**order_totals*** \\n*order_totals object *\",\n    \"13-1\": \"This is an object of order totals. Please see our order totals object table below.\",\n    \"11-2\": \"* First name <= 255 chars.\\n* Last name <= 255 chars.\",\n    \"10-2\": \"\"\n  },\n  \"cols\": 3,\n  \"rows\": 14\n}\n[/block]\norder_totals object - The below table outlines the fields that are within the order totals object\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**item_price**\\n*object*\",\n    \"1-0\": \"**item_fees**\\n*float*\",\n    \"2-0\": \"**fee_adjustments**\\n*fee_adjustments object array*\",\n    \"3-0\": \"**regulatory_fees**\\n*float*\",\n    \"2-1\": \"The base and variable commissions paid to Jet on this order. Variable commissions are set through the Rules Engine in the Partner Portal\",\n    \"1-1\": \"The fees paid to Jet.com for the given quantity of the given merchant SKU in the given merchant order\",\n    \"0-1\": \"Price of the item\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\nitem_price object - The below table outlines the fields that are within the item price object \n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**base_price**\\n*float*\",\n    \"1-0\": \"**item_tax**\\n*float*\",\n    \"2-0\": \"**item_shipping_cost**\\n*float*\",\n    \"3-0\": \"**item_shipping_tax**\\n*float*\",\n    \"1-1\": \"The tax of the item\",\n    \"2-1\": \"The shipping cost of the item\",\n    \"3-1\": \"The shipping tax of the item\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\nfee_adjustments object array - The below table outlines the fields that are within the fee adjustments object array\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**adjustment_name**\\n*string*\",\n    \"1-0\": \"**adjustment_type**\\n*string*\",\n    \"2-0\": \"**commission_id**\\n*string*\",\n    \"3-0\": \"**value**\\n*float*\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**request_shipping_carrier**\\n\\n*string*\",\n    \"1-0\": \"**request_shipping_method** \\n\\n*string*\",\n    \"2-0\": \"**request_service_level** \\n\\n*string*\",\n    \"3-0\": \"**request_ship_by** \\n\\n*string*\",\n    \"4-0\": \"**request_delivery_by** \\n\\n*string*\",\n    \"0-1\": \"The shipping carrier that is delivering the shipment\",\n    \"1-1\": \"The shipping method for the given shipment_id\",\n    \"2-1\": \"Service level the customer will receive\",\n    \"3-1\": \"Expected date that the shipment will be tendered to the given carrier\",\n    \"4-1\": \"Date the customer has been promised delivery\",\n    \"2-2\": \"Must be one of the following values:\\n* Second Day\\n* Next Day\\n* Scheduled (freight)\\n* Expedited\\n* Standard\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**recipient**\\n\\n*person object*\",\n    \"1-0\": \"**address**\\n\\n*address object*\",\n    \"0-1\": \"Who is receiving the order\",\n    \"1-1\": \"Where the order is being shipped to\",\n    \"1-2\": \"\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**name**\\n\\n*string*\",\n    \"1-0\": \"**phone_number**\\n\\n*string*\",\n    \"0-1\": \"The name of the person\",\n    \"1-1\": \"The phone number for the person above\",\n    \"0-2\": \"* First name <= 255 chars.\\n* Last name <= 255 chars.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**address1**\\n\\n*string*\",\n    \"1-0\": \"**address2**\\n\\n*string*\",\n    \"2-0\": \"**city** \\n\\n*string*\",\n    \"3-0\": \"**state** \\n\\n*string*\",\n    \"4-0\": \"**zip_code**\\n\\n*string*\",\n    \"0-1\": \"Line 1 of the address\",\n    \"1-1\": \"Line 2 of the address\",\n    \"2-1\": \"City of the address\",\n    \"3-1\": \"State of the address\",\n    \"4-1\": \"Zip code of the address\",\n    \"4-2\": \"<= 5 chars.\",\n    \"0-2\": \"<= 255 chars.\",\n    \"1-2\": \"<= 255 chars.\",\n    \"2-2\": \"<= 255 chars.\",\n    \"3-2\": \"<= 2 chars.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**order_item_id** \\n\\n*string*\",\n    \"1-0\": \"**alt_order_item_id**\\n\\n*string*\",\n    \"2-0\": \"**merchant_sku** \\n\\n*string*\",\n    \"4-0\": \"**request_order_quantity**\\n\\n*integer*\",\n    \"5-0\": \"**adjustment_reason** \\n\\n*string*\",\n    \"6-0\": \"**item_tax_code** \\n\\n*string*\",\n    \"7-0\": \"**url** \\n\\n*string*\",\n    \"8-0\": \"**price_adjustment**\\n\\n*float*\",\n    \"9-0\": \"**item_fees**\\n\\n*float*\",\n    \"10-0\": \"**fee_adjustments** \\n\\n*fee_adjustments object array*\",\n    \"3-0\": \"**product_title** \\n\\n*string*\",\n    \"11-0\": \"**tax_info** \\n\\n*tax object*\",\n    \"12-0\": \"**regulatory_fees** \\n\\n*float*\",\n    \"0-1\": \"Jet's unique identifier for an item in a merchant order\",\n    \"1-1\": \"Optional merchant supplied ID for an item in an order\",\n    \"2-1\": \"The merchant SKU that is in the given merchant order\",\n    \"4-1\": \"The quantity of the given merchant SKU that is in the given merchant order\",\n    \"5-1\": \"This field is not used at this time\",\n    \"6-1\": \"The tax code associated with the given merchant SKU\",\n    \"7-1\": \"Image URL for the product\",\n    \"3-1\": \"Short product description\",\n    \"8-1\": \"Price adjustment occured as a result of the partial cancel\",\n    \"9-1\": \"The fees paid to Jet.com for the given quantity of the given merchant SKU in the given merchant order\",\n    \"10-1\": \"The base and variable commissions paid to Jet on this order.  Variable commissions are set through the Rules Engine in the Partner Portal\",\n    \"4-2\": \"\"\n  },\n  \"cols\": 3,\n  \"rows\": 13\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Shipments Array\",\n  \"body\": \"Upon order creation, the shipments array will be empty.  When an order has at least one unit shipped, the shipments array will be replaced with everything the merchant has sent through the shipped message.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body: Order \\\"Ready\\\"\"\n}\n[/block]\nWhen an order moves from \"created\" to \"ready\" \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**order_ready_date***\\n\\n*string*\",\n    \"0-1\": \"The date the order was switched to 'ready' state\",\n    \"0-2\": \"This date should be in ISO 8601 format: yyyy-MM-ddTHH:mm:ss.fffffff-HH:MM\\n\\nExample: 2009-06-15T13:45:30.0000000-07:00\",\n    \"1-0\": \"**has_shipments**\\n\\n*boolean*\",\n    \"1-1\": \"Determines whether Jet broke the order into shipments (this should always be false for order-only).\",\n    \"1-2\": \"Must be one of the following values:\\n* true\\n* false\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body: Order \\\"Acknowledged\\\"\"\n}\n[/block]\nWhen an order moves from \"ready\" to \"acknowledged\", the following fields are added\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**order_acknowledge_date**\\n\\n*string*\",\n    \"0-1\": \"The date the order was switched to 'acknowledged' state\",\n    \"0-2\": \"This date should be in ISO 8601 format: yyyy-MM-ddTHH:mm:ss.fffffff-HH:MM\\n\\nExample: 2009-06-15T13:45:30.0000000-07:00\",\n    \"1-0\": \"**acknowledgement_status**\\n\\n*string*\",\n    \"1-1\": \"Status to let Jet know whether you accept or reject the order. Errors that occur at the item level should be given the status 'rejected - item level error'. This is returned in the order acknowledgement message.\\n\\nValid Values\\n* 'rejected - item level error' - the error occurred at the item level\\n* 'rejected - ship from location not available' - the ship to location is invalid\\n* 'rejected - shipping method not supported' - the address requested cannot be shipped to\\n* 'rejected - unfulfillable address' - the address requested cannot be shipped to\\n* 'accepted' - all items in the order will be shipped'\",\n    \"1-2\": \"Must be one of the following values:\\n* 'rejected - item level error' \\n* 'rejected - ship from location not available'\\n* 'rejected - shipping method not supported'\\n* 'rejected - unfulfillable address'\\n* 'accepted'\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\nThe following fields are added to the **order_items** object\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**order_item_acknowledgement_status** \\n\\n*string*\",\n    \"0-2\": \"Must be one of the following values:\\n* 'fulfillable'\\n* 'nonfulfillable'\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body: Order \\\"Inprogress\\\" or \\\"Complete\\\"\"\n}\n[/block]\nThe following fields are provided by the merchant through the shipped message.  If multiple shipped messages are sent, shipment objects will be aggregated into the same shipments array\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**shipments **\\n\\n*shipments object array*\",\n    \"0-1\": \"This is an array of shipments. Please see our shipments array table below.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n**shipments object** - The below table outlines the fields that are within the shipments object:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-2\": \"Validation\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"**shipment_id** \\n\\n*string*\",\n    \"1-0\": \"**alt_shipment_id** \\n\\n*string*\",\n    \"2-0\": \"**shipment_tracking_number** \\n\\n*string*\",\n    \"3-0\": \"**response_shipment_date** \\n\\n*string*\",\n    \"4-0\": \"**response_shipment_method** \\n\\n*string*\",\n    \"5-0\": \"**expected_delivery_date**\\n\\n*string*\",\n    \"6-0\": \"**ship_from_zip_code** \\n\\n*string*\",\n    \"7-0\": \"**carrier** \\n\\n*string*\",\n    \"8-0\": \"**carrier_pick_up_date** \\n\\n*string*\",\n    \"9-0\": \"**shipment_items***\\n\\n*shipment_items object array*\",\n    \"3-2\": \"This date should be in ISO 8601 format: yyyy-MM-ddTHH:mm:ss.fffffff-HH:MM\\n\\nExample: 2009-06-15T13:45:30.0000000-07:00\",\n    \"7-2\": \"Must be one of the following values\\n* FedEx\\n* FedEx SmartPost\\n* FedEx Freight\\n* UPS\\n* UPS Freight\\n* UPS Mail Innovations\\n* UPS SurePost\\n* OnTrac\\n* OnTrac Direct Post\\n* DHL\\n* DHL Global Mail\\n* USPS\\n* CEVA\\n* Laser Ship\\n* Spee Dee\\n* A Duie Pyle\\n* A1\\n* ABF\\n* APEX\\n* Averitt\\n* Dynamex\\n* Eastern Connection\\n* Ensenda\\n* Estes\\n* Land Air Express\\n* Lone Star\\n* Meyer\\n* New Penn\\n* Pilot\\n* Prestige\\n* RBF\\n* Reddaway\\n* RL Carriers\\n* Roadrunner\\n* Southeastern Freight\\n* UDS\\n* UES\\n* YRC\\n* GSO\\n* A&M Trucking\\n* SAIA Freight\\n* Old Dominion\\n* Parcel\\n* Bekins / Home Direct\\n* Seko Worldwide\\n* Mail Express\\n* Newgistics\\n* Delivered by Walmart\\n* NonstopDelivery\\n* MPX\\n* Cagney Global\\n* Simmons Carrier\\n* Other\",\n    \"5-2\": \"This date should be in ISO 8601 format: yyyy-MM-ddTHH:mm:ss.fffffff-HH:MM\\n\\nExample: 2009-06-15T13:45:30.0000000-07:00\",\n    \"0-1\": \"Jet's unique ID for a given shipment.\",\n    \"1-1\": \"Optional merchant supplied shipment ID. Jet will map this ID to the Jet's shipment_id and you can then use this ID in subsequent messages relating to this shipment.\",\n    \"2-1\": \"Packaging tracking number that the carrier is using.\",\n    \"3-1\": \"Date/Time that a given shipment was shipped.\\n\\nExample: 2009-06-15T13:45:30.0000000-07:00.\\n\\nThis needs to be after order_create_date.\",\n    \"4-1\": \"Shipping method used for the given shipment.\",\n    \"5-1\": \"Date/Time that a given shipment is expected to be delivered.\\n\\nExample: 2009-06-15T13:45:30.0000000-07:00\\n\\nThis needs to be after order_create_date.\",\n    \"6-1\": \"The zip code of the locations from which the customer shipment is being shipped\",\n    \"8-2\": \"This date should be in ISO 8601 format: yyyy-MM-ddTHH:mm:ss.fffffff-HH:MM\\n\\nExample: 2009-06-15T13:45:30.0000000-07:00\",\n    \"9-1\": \"This is an array of shipment items. Please see our shipment item array table below.\",\n    \"0-2\": \"* This is not currently supported in any workflow.\",\n    \"8-1\": \"Date/Time that the carrier pick up the customer shipment from the facility where the shipment originated. (This is provided by merchant in shipment confirmation)\",\n    \"7-1\": \"The carrier that will complete final delivery of the shipment. The tracking number should be for this carrier. Must be one of the valid values. Please contact shipping@jet.com if you would like to see a carrier added to this list.\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\n}\n[/block]\n**shipment_items object** - The below table outlines the fields that are within the shipment items array:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**shipment_item_id** \\n\\n*string*\",\n    \"1-0\": \"**alt_shipment_item_id** \\n\\n*string*\",\n    \"2-0\": \"**merchant_sku***\\n\\n*string*\",\n    \"3-0\": \"**response_shipment_sku_quantity** \\n\\n*integer*\",\n    \"4-0\": \"**response_shipment_cancel_qty** \\n\\n*integer*\",\n    \"5-0\": \"**RMA_number** \\n\\n*string*\",\n    \"6-0\": \"**days_to_return** \\n\\n*integer*\",\n    \"7-0\": \"**return_location** \\n\\n*object*\",\n    \"0-1\": \"Jet's unique identifier for an item in a shipment.\",\n    \"1-1\": \"Optional seller supplied ID for an item in a specific shipment. If this value is specified with Jet's shipment_item_id, Jet will map the two IDs and you can then use your own shipment item ID for subsequent feeds relating to that order item.\",\n    \"2-1\": \"A merchant SKU that was set up in your catalog\",\n    \"3-1\": \"Quantity of the given SKU that was shipped in the given shipment\",\n    \"4-1\": \"Quantity of the given SKU that was cancelled in the given shipment\",\n    \"5-1\": \"The RMA # in your system associated with this order item if returned\",\n    \"6-1\": \"The number of days the customer has to return the shipment item\",\n    \"7-1\": \"In the event the item is returned, the location the item would go back.\",\n    \"2-2\": \"\",\n    \"3-2\": \"Required if no units are cancelled: response_shipment_cancel_qty = 0 or is omitted\",\n    \"4-2\": \"Required if no units are shipped: response_shipment_sku_quantity= 0 or is omitted\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]\n**returns location object** - The below table outlines the fields that are within the returns location object:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**address1***\\n\\n*string*\",\n    \"1-0\": \"**address2**\\n\\n*string*\",\n    \"2-0\": \"**city***\\n\\n*string*\",\n    \"3-0\": \"**state***\\n\\n*string*\",\n    \"4-0\": \"**zip_code***\\n\\n*string*\",\n    \"0-1\": \"The first address line for the return location\",\n    \"1-1\": \"The second address line for the return location\",\n    \"2-1\": \"The city, town, or village of the return location\",\n    \"3-1\": \"The state of the return location\",\n    \"4-1\": \"The postal code for the return location\",\n    \"0-2\": \"Required if return_location is provided\",\n    \"2-2\": \"Required if return_location is provided\",\n    \"3-2\": \"Required if return_location is provided\",\n    \"4-2\": \"Required if return_location is provided\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","editedParams":true,"editedParams2":true,"excerpt":"","isReference":false,"next":{"description":"","pages":[]},"api":{"results":{"codes":[{"code":"{\n    \"merchant_order_id\" : \"9b13bdd68c314d1b9c8b93277dea4da1\",\n    \"reference_order_id\" : \"123456789012\",\n    \"fulfillment_node\" : \"EIDIDSNKDSFDKSJDKJSDJKFJF\",\n    \"order_placed_date\" : \"2014-07-24T17:00:00.0000000Z\",\n    \"order_transmission_date\" : \"2014-07-24T17:01:00.0000000Z\",\n    \"order_ready_date\" : \"2014-07-24T20:00:00.0000000Z\",\n    \"order_acknowledge_date\" : \"2014-07-24T20:01:00.0000000Z\",\n    \"status\" : \"created\",\n    \"hash_email\" : \"aj45894Ifklsdjfkdshfioweiorjfiurser93djfh@customer.jet.com\",\n    \"buyer\": {\n        \"name\": \"Tony Stark\",\n        \"phone_number\": \"555-999-9999\"\n                \n    },\n    \"shipping_to\": {\n        \"recipient\" : {\n                \"name\" : \"Pepper Potts\",\n                \"phone_number\" : \" 555-888-8888\"\n            },\n        \"address\" : {\n                \"address1\": \"10880 Malibu Point\",\n                \"address2\": \"\",\n                \"city\": \"Malibu\",\n                \"state\": \"CA\",\n                \"zip_code\": \"90265\"\n            }\n        \n    },\n    \"order_totals\": {\n        \"item_price\": {\n            \"base_price\": 20,\n            \"item_tax\" : 0.14,\n            \"item_shipping_cost\" : 5,\n            \"item_shipping_tax\" : 0.35\n        },\n        \"item_fees\": 2.01,\n        \"fee_adjustments\": [\n            {\n                \"adjustment_name\": \"\",\n                \"adjustment_type\": \"base\",\n                \"commission_id\":\"\",\n                \"value\": 1.20\n            }\n        ],\n        \"regulatory_fees\" : 0.00\n    }, \n    \"order_items\": [\n        {\n            \"order_item_id\": \"8f5ae15b6b414b00a1b9d6ad99166a00\",\n            \"merchant_sku\": \"B289B4B\",\n            \"request_order_quantity\": 2,\n            \"item_tax_code\": \"\",\n            \"item_price\": {\n                \"base_price\": 20,\n                \"item_tax\" : 0.14,\n                \"item_shipping_cost\" : 5,\n                \"item_shipping_tax\" : 0.35\n            },\n            \"item_fees\": 2.01,\n            \"fee_adjustments\": [\n                {\n                    \"adjustment_name\": \"\",\n                    \"adjustment_type\": \"base\",\n                    \"commission_id\":\"\",\n                    \"value\": 1.20\n                }\n            ],\n            \"regulatory_fees\" : 0.00,\n\t\t\t\t\t\t\"product_title\": \"blue pair of socks\",\n            \"url\": \"\"\n        }\n    ],\n    \"order_detail\": {\n        \"request_shipping_carrier\" : \"UPS\",\n        \"request_shipping_method\" : \"UPS_ground\",\n        \"request_service_level\" : \"Standard\",\n        \"request_ship_by\": \"2014-07-26T04:04:00.0000000Z\",\n        \"request_delivery_by\": \"2014-07-28T04:00:00.0000000Z\"            \n    }\n}","language":"json","status":200}]},"settings":"","url":"/orders/withoutShipmentDetail/{jet_defined_order_id}","auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"564e450eeb8e551700e5faf7","ref":"","required":false,"desc":"The ID returned in the Check for Orders call that will allow you to collect order information","default":"","type":"string","name":"jet_defined_order_id","in":"path"}]},"sync_unique":"","title":"Check Order Details","order":1,"slug":"check-new-order-details","githubsync":"","type":"get","createdAt":"2016-02-02T21:55:29.443Z","hidden":false,"link_url":"","parentDoc":null,"project":"562e25f2e01a430d00c2c91e","user":"562e25d24376430d006f1769","__v":1,"category":"56fd2bf327b4321900186ecb","version":"56fd2bf327b4321900186ec6","link_external":false,"updates":[],"childrenPages":[]}

getCheck Order Details


Path Params

jet_defined_order_id:
string
The ID returned in the Check for Orders call that will allow you to collect order information
[block:api-header] { "type": "basic", "title": "Response Body: Order \"Created\"" } [/block] This endpoint will provide you with requisite fulfillment information for the order denoted by the Jet Defined Order ID. [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "0-0": "**merchant_order_id**\n\n*string*", "0-1": "Jet's unique ID for a given merchant order.", "1-0": "**reference_order_id**\n\n*string*", "1-1": "Jet's human readable order ID number that may have a small chance of collision overtime.", "3-0": "**fulfillment_node**\n\n*string*", "3-1": "The fulfillment node that the order should be shipped from.", "4-0": "**alt_order_id**\n\n*string*", "4-1": "Optional Merchant supplied order ID.If an alt_order_id has been associated with the merchant_order_id via the order accept message this will be passed as well.", "5-0": "**hash_email**\n\n*string*", "6-0": "**status**\n\n*string*", "7-0": "**exception_state**\n\n*string*", "8-0": "**order_placed_date***\n\n*string*", "9-0": "**order_transmission_date***\n\n*string*", "10-0": "**order_detail**\n\n*object*", "5-1": "The email hash assigned by Jet to be used as the customer email address", "6-1": "Current status of the order\n\nStatus descriptions:\n* 'created' - order was created by Jet.com but not released for fulfillment\n* 'ready' - order ready to be acknowledged by merchant\n* 'acknowledged' - order was acknowledged by merchant\n* 'inprogress' - one part of the order has been shipped or cancelled\n* 'complete' - all parts of the order have shipped or cancelled", "6-2": "Must be one of the following values:\n* created \n* ready\n* acknowledged \n* inprogress \n* complete", "7-1": "Signifies that something unexpected has occurred for this order. For example, too many units shipped by merchant, merchant failed to accept order.\n\nException State descriptions:\n* 'exception - too many units cancelled'\n* 'exception - jet manual canceled to complete state'\n* 'exception - too many units shipped'\n* 'exception - order rejected'\n* 'resolved'", "7-2": "Must be one of the following values:\n* 'exception - too many units cancelled'\n* 'exception - jet manual canceled to complete state'\n* 'exception - too many units shipped'\n* 'exception - order rejected'\n* 'resolved'", "8-1": "The date the merchant order was placed.", "8-2": "This date should be in ISO 8601 format: yyyy-MM-DDThh:mm:ss.fffffff-hh:mm\n\nExample: 2009-06-15T13:45:30.0000000-07:00", "9-2": "This date should be in ISO 8601 format: yyyy-MM-DDThh:mm:ss.fffffff-hh:mm\n\nExample: 2009-06-15T13:45:30.0000000-07:00", "9-1": "The date/time the merchant order was sent to the merchant", "h-2": "Validation", "2-0": "**customer_reference_order_id**\n\n*string*", "11-0": "**buyer**\n\n*buyer object*", "12-0": "**shipping_to** \n\n*shipping_to object*", "10-1": "Shipping details about the order", "11-1": "Information about the buyer", "12-1": "Information about who and where the order will be shipped to", "13-0": "**order_totals*** \n*order_totals object *", "13-1": "This is an object of order totals. Please see our order totals object table below.", "11-2": "* First name <= 255 chars.\n* Last name <= 255 chars.", "10-2": "" }, "cols": 3, "rows": 14 } [/block] order_totals object - The below table outlines the fields that are within the order totals object [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**item_price**\n*object*", "1-0": "**item_fees**\n*float*", "2-0": "**fee_adjustments**\n*fee_adjustments object array*", "3-0": "**regulatory_fees**\n*float*", "2-1": "The base and variable commissions paid to Jet on this order. Variable commissions are set through the Rules Engine in the Partner Portal", "1-1": "The fees paid to Jet.com for the given quantity of the given merchant SKU in the given merchant order", "0-1": "Price of the item" }, "cols": 3, "rows": 4 } [/block] item_price object - The below table outlines the fields that are within the item price object [block:parameters] { "data": { "0-0": "**base_price**\n*float*", "1-0": "**item_tax**\n*float*", "2-0": "**item_shipping_cost**\n*float*", "3-0": "**item_shipping_tax**\n*float*", "1-1": "The tax of the item", "2-1": "The shipping cost of the item", "3-1": "The shipping tax of the item" }, "cols": 3, "rows": 4 } [/block] fee_adjustments object array - The below table outlines the fields that are within the fee adjustments object array [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**adjustment_name**\n*string*", "1-0": "**adjustment_type**\n*string*", "2-0": "**commission_id**\n*string*", "3-0": "**value**\n*float*" }, "cols": 3, "rows": 4 } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**request_shipping_carrier**\n\n*string*", "1-0": "**request_shipping_method** \n\n*string*", "2-0": "**request_service_level** \n\n*string*", "3-0": "**request_ship_by** \n\n*string*", "4-0": "**request_delivery_by** \n\n*string*", "0-1": "The shipping carrier that is delivering the shipment", "1-1": "The shipping method for the given shipment_id", "2-1": "Service level the customer will receive", "3-1": "Expected date that the shipment will be tendered to the given carrier", "4-1": "Date the customer has been promised delivery", "2-2": "Must be one of the following values:\n* Second Day\n* Next Day\n* Scheduled (freight)\n* Expedited\n* Standard" }, "cols": 3, "rows": 5 } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**recipient**\n\n*person object*", "1-0": "**address**\n\n*address object*", "0-1": "Who is receiving the order", "1-1": "Where the order is being shipped to", "1-2": "" }, "cols": 3, "rows": 2 } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**name**\n\n*string*", "1-0": "**phone_number**\n\n*string*", "0-1": "The name of the person", "1-1": "The phone number for the person above", "0-2": "* First name <= 255 chars.\n* Last name <= 255 chars." }, "cols": 3, "rows": 2 } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**address1**\n\n*string*", "1-0": "**address2**\n\n*string*", "2-0": "**city** \n\n*string*", "3-0": "**state** \n\n*string*", "4-0": "**zip_code**\n\n*string*", "0-1": "Line 1 of the address", "1-1": "Line 2 of the address", "2-1": "City of the address", "3-1": "State of the address", "4-1": "Zip code of the address", "4-2": "<= 5 chars.", "0-2": "<= 255 chars.", "1-2": "<= 255 chars.", "2-2": "<= 255 chars.", "3-2": "<= 2 chars." }, "cols": 3, "rows": 5 } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**order_item_id** \n\n*string*", "1-0": "**alt_order_item_id**\n\n*string*", "2-0": "**merchant_sku** \n\n*string*", "4-0": "**request_order_quantity**\n\n*integer*", "5-0": "**adjustment_reason** \n\n*string*", "6-0": "**item_tax_code** \n\n*string*", "7-0": "**url** \n\n*string*", "8-0": "**price_adjustment**\n\n*float*", "9-0": "**item_fees**\n\n*float*", "10-0": "**fee_adjustments** \n\n*fee_adjustments object array*", "3-0": "**product_title** \n\n*string*", "11-0": "**tax_info** \n\n*tax object*", "12-0": "**regulatory_fees** \n\n*float*", "0-1": "Jet's unique identifier for an item in a merchant order", "1-1": "Optional merchant supplied ID for an item in an order", "2-1": "The merchant SKU that is in the given merchant order", "4-1": "The quantity of the given merchant SKU that is in the given merchant order", "5-1": "This field is not used at this time", "6-1": "The tax code associated with the given merchant SKU", "7-1": "Image URL for the product", "3-1": "Short product description", "8-1": "Price adjustment occured as a result of the partial cancel", "9-1": "The fees paid to Jet.com for the given quantity of the given merchant SKU in the given merchant order", "10-1": "The base and variable commissions paid to Jet on this order. Variable commissions are set through the Rules Engine in the Partner Portal", "4-2": "" }, "cols": 3, "rows": 13 } [/block] [block:callout] { "type": "info", "title": "Shipments Array", "body": "Upon order creation, the shipments array will be empty. When an order has at least one unit shipped, the shipments array will be replaced with everything the merchant has sent through the shipped message." } [/block] [block:api-header] { "type": "basic", "title": "Response Body: Order \"Ready\"" } [/block] When an order moves from "created" to "ready" [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**order_ready_date***\n\n*string*", "0-1": "The date the order was switched to 'ready' state", "0-2": "This date should be in ISO 8601 format: yyyy-MM-ddTHH:mm:ss.fffffff-HH:MM\n\nExample: 2009-06-15T13:45:30.0000000-07:00", "1-0": "**has_shipments**\n\n*boolean*", "1-1": "Determines whether Jet broke the order into shipments (this should always be false for order-only).", "1-2": "Must be one of the following values:\n* true\n* false" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Response Body: Order \"Acknowledged\"" } [/block] When an order moves from "ready" to "acknowledged", the following fields are added [block:parameters] { "data": { "0-0": "**order_acknowledge_date**\n\n*string*", "0-1": "The date the order was switched to 'acknowledged' state", "0-2": "This date should be in ISO 8601 format: yyyy-MM-ddTHH:mm:ss.fffffff-HH:MM\n\nExample: 2009-06-15T13:45:30.0000000-07:00", "1-0": "**acknowledgement_status**\n\n*string*", "1-1": "Status to let Jet know whether you accept or reject the order. Errors that occur at the item level should be given the status 'rejected - item level error'. This is returned in the order acknowledgement message.\n\nValid Values\n* 'rejected - item level error' - the error occurred at the item level\n* 'rejected - ship from location not available' - the ship to location is invalid\n* 'rejected - shipping method not supported' - the address requested cannot be shipped to\n* 'rejected - unfulfillable address' - the address requested cannot be shipped to\n* 'accepted' - all items in the order will be shipped'", "1-2": "Must be one of the following values:\n* 'rejected - item level error' \n* 'rejected - ship from location not available'\n* 'rejected - shipping method not supported'\n* 'rejected - unfulfillable address'\n* 'accepted'", "h-0": "Field", "h-1": "Description", "h-2": "Validation" }, "cols": 3, "rows": 2 } [/block] The following fields are added to the **order_items** object [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**order_item_acknowledgement_status** \n\n*string*", "0-2": "Must be one of the following values:\n* 'fulfillable'\n* 'nonfulfillable'" }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Response Body: Order \"Inprogress\" or \"Complete\"" } [/block] The following fields are provided by the merchant through the shipped message. If multiple shipped messages are sent, shipment objects will be aggregated into the same shipments array [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**shipments **\n\n*shipments object array*", "0-1": "This is an array of shipments. Please see our shipments array table below." }, "cols": 3, "rows": 1 } [/block] **shipments object** - The below table outlines the fields that are within the shipments object: [block:parameters] { "data": { "h-0": "Field", "h-2": "Validation", "h-1": "Description", "0-0": "**shipment_id** \n\n*string*", "1-0": "**alt_shipment_id** \n\n*string*", "2-0": "**shipment_tracking_number** \n\n*string*", "3-0": "**response_shipment_date** \n\n*string*", "4-0": "**response_shipment_method** \n\n*string*", "5-0": "**expected_delivery_date**\n\n*string*", "6-0": "**ship_from_zip_code** \n\n*string*", "7-0": "**carrier** \n\n*string*", "8-0": "**carrier_pick_up_date** \n\n*string*", "9-0": "**shipment_items***\n\n*shipment_items object array*", "3-2": "This date should be in ISO 8601 format: yyyy-MM-ddTHH:mm:ss.fffffff-HH:MM\n\nExample: 2009-06-15T13:45:30.0000000-07:00", "7-2": "Must be one of the following values\n* FedEx\n* FedEx SmartPost\n* FedEx Freight\n* UPS\n* UPS Freight\n* UPS Mail Innovations\n* UPS SurePost\n* OnTrac\n* OnTrac Direct Post\n* DHL\n* DHL Global Mail\n* USPS\n* CEVA\n* Laser Ship\n* Spee Dee\n* A Duie Pyle\n* A1\n* ABF\n* APEX\n* Averitt\n* Dynamex\n* Eastern Connection\n* Ensenda\n* Estes\n* Land Air Express\n* Lone Star\n* Meyer\n* New Penn\n* Pilot\n* Prestige\n* RBF\n* Reddaway\n* RL Carriers\n* Roadrunner\n* Southeastern Freight\n* UDS\n* UES\n* YRC\n* GSO\n* A&M Trucking\n* SAIA Freight\n* Old Dominion\n* Parcel\n* Bekins / Home Direct\n* Seko Worldwide\n* Mail Express\n* Newgistics\n* Delivered by Walmart\n* NonstopDelivery\n* MPX\n* Cagney Global\n* Simmons Carrier\n* Other", "5-2": "This date should be in ISO 8601 format: yyyy-MM-ddTHH:mm:ss.fffffff-HH:MM\n\nExample: 2009-06-15T13:45:30.0000000-07:00", "0-1": "Jet's unique ID for a given shipment.", "1-1": "Optional merchant supplied shipment ID. Jet will map this ID to the Jet's shipment_id and you can then use this ID in subsequent messages relating to this shipment.", "2-1": "Packaging tracking number that the carrier is using.", "3-1": "Date/Time that a given shipment was shipped.\n\nExample: 2009-06-15T13:45:30.0000000-07:00.\n\nThis needs to be after order_create_date.", "4-1": "Shipping method used for the given shipment.", "5-1": "Date/Time that a given shipment is expected to be delivered.\n\nExample: 2009-06-15T13:45:30.0000000-07:00\n\nThis needs to be after order_create_date.", "6-1": "The zip code of the locations from which the customer shipment is being shipped", "8-2": "This date should be in ISO 8601 format: yyyy-MM-ddTHH:mm:ss.fffffff-HH:MM\n\nExample: 2009-06-15T13:45:30.0000000-07:00", "9-1": "This is an array of shipment items. Please see our shipment item array table below.", "0-2": "* This is not currently supported in any workflow.", "8-1": "Date/Time that the carrier pick up the customer shipment from the facility where the shipment originated. (This is provided by merchant in shipment confirmation)", "7-1": "The carrier that will complete final delivery of the shipment. The tracking number should be for this carrier. Must be one of the valid values. Please contact shipping@jet.com if you would like to see a carrier added to this list." }, "cols": 3, "rows": 10 } [/block] **shipment_items object** - The below table outlines the fields that are within the shipment items array: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**shipment_item_id** \n\n*string*", "1-0": "**alt_shipment_item_id** \n\n*string*", "2-0": "**merchant_sku***\n\n*string*", "3-0": "**response_shipment_sku_quantity** \n\n*integer*", "4-0": "**response_shipment_cancel_qty** \n\n*integer*", "5-0": "**RMA_number** \n\n*string*", "6-0": "**days_to_return** \n\n*integer*", "7-0": "**return_location** \n\n*object*", "0-1": "Jet's unique identifier for an item in a shipment.", "1-1": "Optional seller supplied ID for an item in a specific shipment. If this value is specified with Jet's shipment_item_id, Jet will map the two IDs and you can then use your own shipment item ID for subsequent feeds relating to that order item.", "2-1": "A merchant SKU that was set up in your catalog", "3-1": "Quantity of the given SKU that was shipped in the given shipment", "4-1": "Quantity of the given SKU that was cancelled in the given shipment", "5-1": "The RMA # in your system associated with this order item if returned", "6-1": "The number of days the customer has to return the shipment item", "7-1": "In the event the item is returned, the location the item would go back.", "2-2": "", "3-2": "Required if no units are cancelled: response_shipment_cancel_qty = 0 or is omitted", "4-2": "Required if no units are shipped: response_shipment_sku_quantity= 0 or is omitted" }, "cols": 3, "rows": 8 } [/block] **returns location object** - The below table outlines the fields that are within the returns location object: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**address1***\n\n*string*", "1-0": "**address2**\n\n*string*", "2-0": "**city***\n\n*string*", "3-0": "**state***\n\n*string*", "4-0": "**zip_code***\n\n*string*", "0-1": "The first address line for the return location", "1-1": "The second address line for the return location", "2-1": "The city, town, or village of the return location", "3-1": "The state of the return location", "4-1": "The postal code for the return location", "0-2": "Required if return_location is provided", "2-2": "Required if return_location is provided", "3-2": "Required if return_location is provided", "4-2": "Required if return_location is provided" }, "cols": 3, "rows": 5 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response Body: Order \"Created\"" } [/block] This endpoint will provide you with requisite fulfillment information for the order denoted by the Jet Defined Order ID. [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "0-0": "**merchant_order_id**\n\n*string*", "0-1": "Jet's unique ID for a given merchant order.", "1-0": "**reference_order_id**\n\n*string*", "1-1": "Jet's human readable order ID number that may have a small chance of collision overtime.", "3-0": "**fulfillment_node**\n\n*string*", "3-1": "The fulfillment node that the order should be shipped from.", "4-0": "**alt_order_id**\n\n*string*", "4-1": "Optional Merchant supplied order ID.If an alt_order_id has been associated with the merchant_order_id via the order accept message this will be passed as well.", "5-0": "**hash_email**\n\n*string*", "6-0": "**status**\n\n*string*", "7-0": "**exception_state**\n\n*string*", "8-0": "**order_placed_date***\n\n*string*", "9-0": "**order_transmission_date***\n\n*string*", "10-0": "**order_detail**\n\n*object*", "5-1": "The email hash assigned by Jet to be used as the customer email address", "6-1": "Current status of the order\n\nStatus descriptions:\n* 'created' - order was created by Jet.com but not released for fulfillment\n* 'ready' - order ready to be acknowledged by merchant\n* 'acknowledged' - order was acknowledged by merchant\n* 'inprogress' - one part of the order has been shipped or cancelled\n* 'complete' - all parts of the order have shipped or cancelled", "6-2": "Must be one of the following values:\n* created \n* ready\n* acknowledged \n* inprogress \n* complete", "7-1": "Signifies that something unexpected has occurred for this order. For example, too many units shipped by merchant, merchant failed to accept order.\n\nException State descriptions:\n* 'exception - too many units cancelled'\n* 'exception - jet manual canceled to complete state'\n* 'exception - too many units shipped'\n* 'exception - order rejected'\n* 'resolved'", "7-2": "Must be one of the following values:\n* 'exception - too many units cancelled'\n* 'exception - jet manual canceled to complete state'\n* 'exception - too many units shipped'\n* 'exception - order rejected'\n* 'resolved'", "8-1": "The date the merchant order was placed.", "8-2": "This date should be in ISO 8601 format: yyyy-MM-DDThh:mm:ss.fffffff-hh:mm\n\nExample: 2009-06-15T13:45:30.0000000-07:00", "9-2": "This date should be in ISO 8601 format: yyyy-MM-DDThh:mm:ss.fffffff-hh:mm\n\nExample: 2009-06-15T13:45:30.0000000-07:00", "9-1": "The date/time the merchant order was sent to the merchant", "h-2": "Validation", "2-0": "**customer_reference_order_id**\n\n*string*", "11-0": "**buyer**\n\n*buyer object*", "12-0": "**shipping_to** \n\n*shipping_to object*", "10-1": "Shipping details about the order", "11-1": "Information about the buyer", "12-1": "Information about who and where the order will be shipped to", "13-0": "**order_totals*** \n*order_totals object *", "13-1": "This is an object of order totals. Please see our order totals object table below.", "11-2": "* First name <= 255 chars.\n* Last name <= 255 chars.", "10-2": "" }, "cols": 3, "rows": 14 } [/block] order_totals object - The below table outlines the fields that are within the order totals object [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**item_price**\n*object*", "1-0": "**item_fees**\n*float*", "2-0": "**fee_adjustments**\n*fee_adjustments object array*", "3-0": "**regulatory_fees**\n*float*", "2-1": "The base and variable commissions paid to Jet on this order. Variable commissions are set through the Rules Engine in the Partner Portal", "1-1": "The fees paid to Jet.com for the given quantity of the given merchant SKU in the given merchant order", "0-1": "Price of the item" }, "cols": 3, "rows": 4 } [/block] item_price object - The below table outlines the fields that are within the item price object [block:parameters] { "data": { "0-0": "**base_price**\n*float*", "1-0": "**item_tax**\n*float*", "2-0": "**item_shipping_cost**\n*float*", "3-0": "**item_shipping_tax**\n*float*", "1-1": "The tax of the item", "2-1": "The shipping cost of the item", "3-1": "The shipping tax of the item" }, "cols": 3, "rows": 4 } [/block] fee_adjustments object array - The below table outlines the fields that are within the fee adjustments object array [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**adjustment_name**\n*string*", "1-0": "**adjustment_type**\n*string*", "2-0": "**commission_id**\n*string*", "3-0": "**value**\n*float*" }, "cols": 3, "rows": 4 } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**request_shipping_carrier**\n\n*string*", "1-0": "**request_shipping_method** \n\n*string*", "2-0": "**request_service_level** \n\n*string*", "3-0": "**request_ship_by** \n\n*string*", "4-0": "**request_delivery_by** \n\n*string*", "0-1": "The shipping carrier that is delivering the shipment", "1-1": "The shipping method for the given shipment_id", "2-1": "Service level the customer will receive", "3-1": "Expected date that the shipment will be tendered to the given carrier", "4-1": "Date the customer has been promised delivery", "2-2": "Must be one of the following values:\n* Second Day\n* Next Day\n* Scheduled (freight)\n* Expedited\n* Standard" }, "cols": 3, "rows": 5 } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**recipient**\n\n*person object*", "1-0": "**address**\n\n*address object*", "0-1": "Who is receiving the order", "1-1": "Where the order is being shipped to", "1-2": "" }, "cols": 3, "rows": 2 } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**name**\n\n*string*", "1-0": "**phone_number**\n\n*string*", "0-1": "The name of the person", "1-1": "The phone number for the person above", "0-2": "* First name <= 255 chars.\n* Last name <= 255 chars." }, "cols": 3, "rows": 2 } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**address1**\n\n*string*", "1-0": "**address2**\n\n*string*", "2-0": "**city** \n\n*string*", "3-0": "**state** \n\n*string*", "4-0": "**zip_code**\n\n*string*", "0-1": "Line 1 of the address", "1-1": "Line 2 of the address", "2-1": "City of the address", "3-1": "State of the address", "4-1": "Zip code of the address", "4-2": "<= 5 chars.", "0-2": "<= 255 chars.", "1-2": "<= 255 chars.", "2-2": "<= 255 chars.", "3-2": "<= 2 chars." }, "cols": 3, "rows": 5 } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**order_item_id** \n\n*string*", "1-0": "**alt_order_item_id**\n\n*string*", "2-0": "**merchant_sku** \n\n*string*", "4-0": "**request_order_quantity**\n\n*integer*", "5-0": "**adjustment_reason** \n\n*string*", "6-0": "**item_tax_code** \n\n*string*", "7-0": "**url** \n\n*string*", "8-0": "**price_adjustment**\n\n*float*", "9-0": "**item_fees**\n\n*float*", "10-0": "**fee_adjustments** \n\n*fee_adjustments object array*", "3-0": "**product_title** \n\n*string*", "11-0": "**tax_info** \n\n*tax object*", "12-0": "**regulatory_fees** \n\n*float*", "0-1": "Jet's unique identifier for an item in a merchant order", "1-1": "Optional merchant supplied ID for an item in an order", "2-1": "The merchant SKU that is in the given merchant order", "4-1": "The quantity of the given merchant SKU that is in the given merchant order", "5-1": "This field is not used at this time", "6-1": "The tax code associated with the given merchant SKU", "7-1": "Image URL for the product", "3-1": "Short product description", "8-1": "Price adjustment occured as a result of the partial cancel", "9-1": "The fees paid to Jet.com for the given quantity of the given merchant SKU in the given merchant order", "10-1": "The base and variable commissions paid to Jet on this order. Variable commissions are set through the Rules Engine in the Partner Portal", "4-2": "" }, "cols": 3, "rows": 13 } [/block] [block:callout] { "type": "info", "title": "Shipments Array", "body": "Upon order creation, the shipments array will be empty. When an order has at least one unit shipped, the shipments array will be replaced with everything the merchant has sent through the shipped message." } [/block] [block:api-header] { "type": "basic", "title": "Response Body: Order \"Ready\"" } [/block] When an order moves from "created" to "ready" [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**order_ready_date***\n\n*string*", "0-1": "The date the order was switched to 'ready' state", "0-2": "This date should be in ISO 8601 format: yyyy-MM-ddTHH:mm:ss.fffffff-HH:MM\n\nExample: 2009-06-15T13:45:30.0000000-07:00", "1-0": "**has_shipments**\n\n*boolean*", "1-1": "Determines whether Jet broke the order into shipments (this should always be false for order-only).", "1-2": "Must be one of the following values:\n* true\n* false" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Response Body: Order \"Acknowledged\"" } [/block] When an order moves from "ready" to "acknowledged", the following fields are added [block:parameters] { "data": { "0-0": "**order_acknowledge_date**\n\n*string*", "0-1": "The date the order was switched to 'acknowledged' state", "0-2": "This date should be in ISO 8601 format: yyyy-MM-ddTHH:mm:ss.fffffff-HH:MM\n\nExample: 2009-06-15T13:45:30.0000000-07:00", "1-0": "**acknowledgement_status**\n\n*string*", "1-1": "Status to let Jet know whether you accept or reject the order. Errors that occur at the item level should be given the status 'rejected - item level error'. This is returned in the order acknowledgement message.\n\nValid Values\n* 'rejected - item level error' - the error occurred at the item level\n* 'rejected - ship from location not available' - the ship to location is invalid\n* 'rejected - shipping method not supported' - the address requested cannot be shipped to\n* 'rejected - unfulfillable address' - the address requested cannot be shipped to\n* 'accepted' - all items in the order will be shipped'", "1-2": "Must be one of the following values:\n* 'rejected - item level error' \n* 'rejected - ship from location not available'\n* 'rejected - shipping method not supported'\n* 'rejected - unfulfillable address'\n* 'accepted'", "h-0": "Field", "h-1": "Description", "h-2": "Validation" }, "cols": 3, "rows": 2 } [/block] The following fields are added to the **order_items** object [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**order_item_acknowledgement_status** \n\n*string*", "0-2": "Must be one of the following values:\n* 'fulfillable'\n* 'nonfulfillable'" }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Response Body: Order \"Inprogress\" or \"Complete\"" } [/block] The following fields are provided by the merchant through the shipped message. If multiple shipped messages are sent, shipment objects will be aggregated into the same shipments array [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**shipments **\n\n*shipments object array*", "0-1": "This is an array of shipments. Please see our shipments array table below." }, "cols": 3, "rows": 1 } [/block] **shipments object** - The below table outlines the fields that are within the shipments object: [block:parameters] { "data": { "h-0": "Field", "h-2": "Validation", "h-1": "Description", "0-0": "**shipment_id** \n\n*string*", "1-0": "**alt_shipment_id** \n\n*string*", "2-0": "**shipment_tracking_number** \n\n*string*", "3-0": "**response_shipment_date** \n\n*string*", "4-0": "**response_shipment_method** \n\n*string*", "5-0": "**expected_delivery_date**\n\n*string*", "6-0": "**ship_from_zip_code** \n\n*string*", "7-0": "**carrier** \n\n*string*", "8-0": "**carrier_pick_up_date** \n\n*string*", "9-0": "**shipment_items***\n\n*shipment_items object array*", "3-2": "This date should be in ISO 8601 format: yyyy-MM-ddTHH:mm:ss.fffffff-HH:MM\n\nExample: 2009-06-15T13:45:30.0000000-07:00", "7-2": "Must be one of the following values\n* FedEx\n* FedEx SmartPost\n* FedEx Freight\n* UPS\n* UPS Freight\n* UPS Mail Innovations\n* UPS SurePost\n* OnTrac\n* OnTrac Direct Post\n* DHL\n* DHL Global Mail\n* USPS\n* CEVA\n* Laser Ship\n* Spee Dee\n* A Duie Pyle\n* A1\n* ABF\n* APEX\n* Averitt\n* Dynamex\n* Eastern Connection\n* Ensenda\n* Estes\n* Land Air Express\n* Lone Star\n* Meyer\n* New Penn\n* Pilot\n* Prestige\n* RBF\n* Reddaway\n* RL Carriers\n* Roadrunner\n* Southeastern Freight\n* UDS\n* UES\n* YRC\n* GSO\n* A&M Trucking\n* SAIA Freight\n* Old Dominion\n* Parcel\n* Bekins / Home Direct\n* Seko Worldwide\n* Mail Express\n* Newgistics\n* Delivered by Walmart\n* NonstopDelivery\n* MPX\n* Cagney Global\n* Simmons Carrier\n* Other", "5-2": "This date should be in ISO 8601 format: yyyy-MM-ddTHH:mm:ss.fffffff-HH:MM\n\nExample: 2009-06-15T13:45:30.0000000-07:00", "0-1": "Jet's unique ID for a given shipment.", "1-1": "Optional merchant supplied shipment ID. Jet will map this ID to the Jet's shipment_id and you can then use this ID in subsequent messages relating to this shipment.", "2-1": "Packaging tracking number that the carrier is using.", "3-1": "Date/Time that a given shipment was shipped.\n\nExample: 2009-06-15T13:45:30.0000000-07:00.\n\nThis needs to be after order_create_date.", "4-1": "Shipping method used for the given shipment.", "5-1": "Date/Time that a given shipment is expected to be delivered.\n\nExample: 2009-06-15T13:45:30.0000000-07:00\n\nThis needs to be after order_create_date.", "6-1": "The zip code of the locations from which the customer shipment is being shipped", "8-2": "This date should be in ISO 8601 format: yyyy-MM-ddTHH:mm:ss.fffffff-HH:MM\n\nExample: 2009-06-15T13:45:30.0000000-07:00", "9-1": "This is an array of shipment items. Please see our shipment item array table below.", "0-2": "* This is not currently supported in any workflow.", "8-1": "Date/Time that the carrier pick up the customer shipment from the facility where the shipment originated. (This is provided by merchant in shipment confirmation)", "7-1": "The carrier that will complete final delivery of the shipment. The tracking number should be for this carrier. Must be one of the valid values. Please contact shipping@jet.com if you would like to see a carrier added to this list." }, "cols": 3, "rows": 10 } [/block] **shipment_items object** - The below table outlines the fields that are within the shipment items array: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**shipment_item_id** \n\n*string*", "1-0": "**alt_shipment_item_id** \n\n*string*", "2-0": "**merchant_sku***\n\n*string*", "3-0": "**response_shipment_sku_quantity** \n\n*integer*", "4-0": "**response_shipment_cancel_qty** \n\n*integer*", "5-0": "**RMA_number** \n\n*string*", "6-0": "**days_to_return** \n\n*integer*", "7-0": "**return_location** \n\n*object*", "0-1": "Jet's unique identifier for an item in a shipment.", "1-1": "Optional seller supplied ID for an item in a specific shipment. If this value is specified with Jet's shipment_item_id, Jet will map the two IDs and you can then use your own shipment item ID for subsequent feeds relating to that order item.", "2-1": "A merchant SKU that was set up in your catalog", "3-1": "Quantity of the given SKU that was shipped in the given shipment", "4-1": "Quantity of the given SKU that was cancelled in the given shipment", "5-1": "The RMA # in your system associated with this order item if returned", "6-1": "The number of days the customer has to return the shipment item", "7-1": "In the event the item is returned, the location the item would go back.", "2-2": "", "3-2": "Required if no units are cancelled: response_shipment_cancel_qty = 0 or is omitted", "4-2": "Required if no units are shipped: response_shipment_sku_quantity= 0 or is omitted" }, "cols": 3, "rows": 8 } [/block] **returns location object** - The below table outlines the fields that are within the returns location object: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**address1***\n\n*string*", "1-0": "**address2**\n\n*string*", "2-0": "**city***\n\n*string*", "3-0": "**state***\n\n*string*", "4-0": "**zip_code***\n\n*string*", "0-1": "The first address line for the return location", "1-1": "The second address line for the return location", "2-1": "The city, town, or village of the return location", "3-1": "The state of the return location", "4-1": "The postal code for the return location", "0-2": "Required if return_location is provided", "2-2": "Required if return_location is provided", "3-2": "Required if return_location is provided", "4-2": "Required if return_location is provided" }, "cols": 3, "rows": 5 } [/block]
{"_id":"56fd2bf327b4321900186ef9","order":2,"parentDoc":null,"title":"Acknowledge Order","type":"put","category":"56fd2bf327b4321900186ecb","createdAt":"2015-11-04T16:11:03.177Z","link_url":"","link_external":false,"user":"562e25d24376430d006f1769","hidden":false,"isReference":false,"sync_unique":"","api":{"examples":{"codes":[]},"method":"put","params":[{"desc":"The Jet defined order ID","default":"","type":"string","name":"jet_defined_order_id","in":"path","_id":"563a2e17f0c29b1700daafa6","ref":"","required":false}],"results":{"codes":[{"status":204,"code":"","language":"json"},{"code":"{\n  \"errors\": [\n    \"order_item_id doesn't match: \\\"21b5a551d31541eea8f36f05385d2f90\\\"\"\n  ]\n}","language":"json","status":400}]},"settings":"","url":"/orders/{jet_defined_order_id}/acknowledge","auth":"required"},"editedParams":true,"excerpt":"","githubsync":"","project":"562e25f2e01a430d00c2c91e","slug":"acknowledge-order","updates":["574892de919ad20e00b6c747"],"version":"56fd2bf327b4321900186ec6","__v":1,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request Body\"\n}\n[/block]\nThe order acknowledge call is utilized to allow a retailer to accept or reject an order. If there are any skus in the order that cannot be fulfilled then you will reject the order.\n\nThe fields for the order acknowledged call are outlined below:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"h-4\": \"Defined by\",\n    \"0-0\": \"**acknowledgement_status***\\n\\n*string*\",\n    \"0-1\": \"Status to let Jet know whether you accept or reject the order.\",\n    \"0-3\": \"\",\n    \"0-4\": \"Merchant\",\n    \"0-2\": \"Must be one of the following values:\\n* rejected - other\\n* rejected - fraud\\n* rejected - item level error\\n* rejected - ship from location not available\\n* rejected - shipping method not supported \\n* rejected - unfulfillable address\\n* accepted\",\n    \"1-0\": \"**alt_order_id**\\n\\n*string*\",\n    \"1-1\": \"Option merchant supplied order ID. Jet will map this ID to Jet's order_id and you can then use this ID in subsequent messages related to the order.\",\n    \"2-0\": \"**order_items***\\n\\n*order_items object array*\",\n    \"2-1\": \"This is an array of order items. Please see our order item array table below.\",\n    \"1-4\": \"Merchant\",\n    \"2-4\": \"Merchant\",\n    \"1-3\": \"\",\n    \"2-3\": \"\",\n    \"h-5\": \"Required\",\n    \"0-5\": \"Yes\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n**order_items object** - The below table outlines the fields that are within the order_items array:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"h-4\": \"Defined by\",\n    \"0-3\": \"\",\n    \"1-3\": \"\",\n    \"2-3\": \"\",\n    \"0-0\": \"**order_item_acknowledgement_status***\\n\\n*string*\",\n    \"1-0\": \"**order_item_id***\\n\\n*string*\",\n    \"2-0\": \"**alt_order_item_id**\\n\\n*string*\",\n    \"0-1\": \"Merchant defined fulfillable or nonfulfillable skus within the order.\",\n    \"1-1\": \"Jet's unique identifier for an item in a merchant order.\",\n    \"2-1\": \"Optional seller-supplied ID for an item in an order. If this value is specified with the Jet's order_item_id, Jet will map the two IDs and you can then use your own order item ID for subsequent feeds relating to that order item.\",\n    \"0-4\": \"Merchant\",\n    \"1-4\": \"Jet\",\n    \"2-4\": \"Merchant\",\n    \"1-2\": \"\",\n    \"0-2\": \"Must be one of the following values:\\n* nonfulfillable - invalid merchant SKU\\n* nonfulfillable - no inventory\\n* fulfillable\",\n    \"h-5\": \"Required\",\n    \"1-5\": \"Required if alt_order_item_id not provided\",\n    \"2-5\": \"Required if order_item_id not provided\",\n    \"0-5\": \"yes\",\n    \"2-2\": \"\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\\* denotes a required field if the object is provided\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use Cases\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Example Request bodies for this endpoint:\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"acknowledgement_status\\\": \\\"accepted\\\", //this order will moved to the 'acknowledged' status\\n  \\\"alt_order_id\\\": \\\"232145\\\",\\n  \\\"order_items\\\": [\\n    {\\n      \\\"order_item_acknowledgement_status\\\": \\\"fulfillable\\\",\\n      \\\"order_item_id\\\": \\\"8f5ae15b6b414b00a1b9d6ad99166a00\\\",\\n      \\\"alt_order_item_id\\\": \\\"76-i105\\\"\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Accepted Order\"\n    },\n    {\n      \"code\": \"{\\n  \\\"acknowledgement_status\\\": \\\"rejected - item level error\\\", //this order will move to the 'complete' state with an exception_state 'order rejected'\\n  \\\"alt_order_id\\\": \\\"232145\\\",\\n  \\\"order_items\\\": [\\n    {\\n      \\\"order_item_acknowledgement_status\\\": \\\"nonfulfillable - no inventory\\\", // any SKUs marked with this status will have its inventory set to 0\\n      \\\"order_item_id\\\": \\\"8f5ae15b6b414b00a1b9d6ad99166a00\\\",\\n      \\\"alt_order_item_id\\\": \\\"76-i105\\\"\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Rejected Order\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","editedParams2":true,"childrenPages":[]}

putAcknowledge Order


Path Params

jet_defined_order_id:
string
The Jet defined order ID
[block:api-header] { "type": "basic", "title": "Request Body" } [/block] The order acknowledge call is utilized to allow a retailer to accept or reject an order. If there are any skus in the order that cannot be fulfilled then you will reject the order. The fields for the order acknowledged call are outlined below: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "h-4": "Defined by", "0-0": "**acknowledgement_status***\n\n*string*", "0-1": "Status to let Jet know whether you accept or reject the order.", "0-3": "", "0-4": "Merchant", "0-2": "Must be one of the following values:\n* rejected - other\n* rejected - fraud\n* rejected - item level error\n* rejected - ship from location not available\n* rejected - shipping method not supported \n* rejected - unfulfillable address\n* accepted", "1-0": "**alt_order_id**\n\n*string*", "1-1": "Option merchant supplied order ID. Jet will map this ID to Jet's order_id and you can then use this ID in subsequent messages related to the order.", "2-0": "**order_items***\n\n*order_items object array*", "2-1": "This is an array of order items. Please see our order item array table below.", "1-4": "Merchant", "2-4": "Merchant", "1-3": "", "2-3": "", "h-5": "Required", "0-5": "Yes" }, "cols": 3, "rows": 3 } [/block] **order_items object** - The below table outlines the fields that are within the order_items array: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "h-4": "Defined by", "0-3": "", "1-3": "", "2-3": "", "0-0": "**order_item_acknowledgement_status***\n\n*string*", "1-0": "**order_item_id***\n\n*string*", "2-0": "**alt_order_item_id**\n\n*string*", "0-1": "Merchant defined fulfillable or nonfulfillable skus within the order.", "1-1": "Jet's unique identifier for an item in a merchant order.", "2-1": "Optional seller-supplied ID for an item in an order. If this value is specified with the Jet's order_item_id, Jet will map the two IDs and you can then use your own order item ID for subsequent feeds relating to that order item.", "0-4": "Merchant", "1-4": "Jet", "2-4": "Merchant", "1-2": "", "0-2": "Must be one of the following values:\n* nonfulfillable - invalid merchant SKU\n* nonfulfillable - no inventory\n* fulfillable", "h-5": "Required", "1-5": "Required if alt_order_item_id not provided", "2-5": "Required if order_item_id not provided", "0-5": "yes", "2-2": "" }, "cols": 3, "rows": 3 } [/block] \* denotes a required field if the object is provided [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Example Request bodies for this endpoint:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"acknowledgement_status\": \"accepted\", //this order will moved to the 'acknowledged' status\n \"alt_order_id\": \"232145\",\n \"order_items\": [\n {\n \"order_item_acknowledgement_status\": \"fulfillable\",\n \"order_item_id\": \"8f5ae15b6b414b00a1b9d6ad99166a00\",\n \"alt_order_item_id\": \"76-i105\"\n }\n ]\n}", "language": "json", "name": "Accepted Order" }, { "code": "{\n \"acknowledgement_status\": \"rejected - item level error\", //this order will move to the 'complete' state with an exception_state 'order rejected'\n \"alt_order_id\": \"232145\",\n \"order_items\": [\n {\n \"order_item_acknowledgement_status\": \"nonfulfillable - no inventory\", // any SKUs marked with this status will have its inventory set to 0\n \"order_item_id\": \"8f5ae15b6b414b00a1b9d6ad99166a00\",\n \"alt_order_item_id\": \"76-i105\"\n }\n ]\n}", "language": "json", "name": "Rejected Order" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


[block:api-header] { "type": "basic", "title": "Request Body" } [/block] The order acknowledge call is utilized to allow a retailer to accept or reject an order. If there are any skus in the order that cannot be fulfilled then you will reject the order. The fields for the order acknowledged call are outlined below: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "h-4": "Defined by", "0-0": "**acknowledgement_status***\n\n*string*", "0-1": "Status to let Jet know whether you accept or reject the order.", "0-3": "", "0-4": "Merchant", "0-2": "Must be one of the following values:\n* rejected - other\n* rejected - fraud\n* rejected - item level error\n* rejected - ship from location not available\n* rejected - shipping method not supported \n* rejected - unfulfillable address\n* accepted", "1-0": "**alt_order_id**\n\n*string*", "1-1": "Option merchant supplied order ID. Jet will map this ID to Jet's order_id and you can then use this ID in subsequent messages related to the order.", "2-0": "**order_items***\n\n*order_items object array*", "2-1": "This is an array of order items. Please see our order item array table below.", "1-4": "Merchant", "2-4": "Merchant", "1-3": "", "2-3": "", "h-5": "Required", "0-5": "Yes" }, "cols": 3, "rows": 3 } [/block] **order_items object** - The below table outlines the fields that are within the order_items array: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "h-4": "Defined by", "0-3": "", "1-3": "", "2-3": "", "0-0": "**order_item_acknowledgement_status***\n\n*string*", "1-0": "**order_item_id***\n\n*string*", "2-0": "**alt_order_item_id**\n\n*string*", "0-1": "Merchant defined fulfillable or nonfulfillable skus within the order.", "1-1": "Jet's unique identifier for an item in a merchant order.", "2-1": "Optional seller-supplied ID for an item in an order. If this value is specified with the Jet's order_item_id, Jet will map the two IDs and you can then use your own order item ID for subsequent feeds relating to that order item.", "0-4": "Merchant", "1-4": "Jet", "2-4": "Merchant", "1-2": "", "0-2": "Must be one of the following values:\n* nonfulfillable - invalid merchant SKU\n* nonfulfillable - no inventory\n* fulfillable", "h-5": "Required", "1-5": "Required if alt_order_item_id not provided", "2-5": "Required if order_item_id not provided", "0-5": "yes", "2-2": "" }, "cols": 3, "rows": 3 } [/block] \* denotes a required field if the object is provided [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Example Request bodies for this endpoint:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"acknowledgement_status\": \"accepted\", //this order will moved to the 'acknowledged' status\n \"alt_order_id\": \"232145\",\n \"order_items\": [\n {\n \"order_item_acknowledgement_status\": \"fulfillable\",\n \"order_item_id\": \"8f5ae15b6b414b00a1b9d6ad99166a00\",\n \"alt_order_item_id\": \"76-i105\"\n }\n ]\n}", "language": "json", "name": "Accepted Order" }, { "code": "{\n \"acknowledgement_status\": \"rejected - item level error\", //this order will move to the 'complete' state with an exception_state 'order rejected'\n \"alt_order_id\": \"232145\",\n \"order_items\": [\n {\n \"order_item_acknowledgement_status\": \"nonfulfillable - no inventory\", // any SKUs marked with this status will have its inventory set to 0\n \"order_item_id\": \"8f5ae15b6b414b00a1b9d6ad99166a00\",\n \"alt_order_item_id\": \"76-i105\"\n }\n ]\n}", "language": "json", "name": "Rejected Order" } ], "sidebar": true } [/block]
{"_id":"56fd2bf327b4321900186efa","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request Body\"\n}\n[/block]\nThe order shipped call is utilized to provide Jet with the SKUs that have been shipped or cancelled in an order, the tracking information, carrier information and any additional returns information for the order.\n\nThe fields for the order shipped call are outlined below:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**alt_order_id** \\n\\n*string*\",\n    \"1-0\": \"**shipments ***\\n\\n*shipments object array*\",\n    \"0-1\": \"Optional merchant supplied order ID. Jet will map this ID to Jet's order_id and you can then use this ID in subsequent messages relating to this order.\",\n    \"1-1\": \"This is an array of shipments. Please see our shipments array table below.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n**shipments array** - The below table outlines the fields that are within the shipments array:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-2\": \"Validation\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"**alt_shipment_id** \\n\\n*string*\",\n    \"1-0\": \"**shipment_tracking_number** \\n\\n*string*\",\n    \"2-0\": \"**response_shipment_date** \\n\\n*string*\",\n    \"3-0\": \"**response_shipment_method** \\n\\n*string*\",\n    \"4-0\": \"**expected_delivery_date**\\n\\n*string*\",\n    \"5-0\": \"**ship_from_zip_code** \\n\\n*string*\",\n    \"6-0\": \"**carrier** \\n\\n*string*\",\n    \"7-0\": \"**carrier_pick_up_date** \\n\\n*string*\",\n    \"8-0\": \"**shipment_items***\\n\\n*shipment_items object array*\",\n    \"2-2\": \"The \\\"response_shipment_date\\\" must adhere to ISO 8601 format, YYYY-MM-DDThh:mm:ss.fffffff-hh:mm.\\n\\nExample: 2009-06-15T13:45:30.0000000-07:00\",\n    \"6-2\": \"Required when \\n\\\"response_shipment_sku_quantity\\\" >= 1. \\n\\nMust be one of the following values\\n* FedEx\\n* FedEx SmartPost\\n* FedEx Freight\\n* UPS\\n* UPS Freight\\n* UPS Mail Innovations\\n* UPS SurePost\\n* OnTrac\\n* OnTrac Direct Post\\n* DHL\\n* DHL Global Mail\\n* USPS\\n* CEVA\\n* Laser Ship\\n* LaserShip\\n* Spee Dee\\n* A Duie Pyle\\n* A1\\n* ABF\\n* APEX\\n* Averitt\\n* Dynamex\\n* Eastern Connection\\n* Ensenda\\n* Estes\\n* Land Air Express\\n* Lone Star\\n* Meyer\\n* New Penn\\n* Pilot\\n* Prestige\\n* RBF\\n* Reddaway\\n* RL Carriers\\n* Roadrunner\\n* SAIA Freight\\n* Southeastern Freight\\n* UDS\\n* UES\\n* YRC\\n* GSO\\n* A&M Trucking\\n* Old Dominion\\n* Parcel\\n* ConveyDecisioning\\n* JetExpress\\n* Bekins / Home Direct\\n* Seko Worldwide\\n* Mail Express\\n* Dynamex\\n* Newgistics\\n* Delivered by Walmart\\n* NonstopDelivery\\n* MPX\\n* Cagney Global\\n* Simmons Carrier\\n* DeliveryCourier\\n* AGS\\n* Watkins & Shepard\\n* WN Direct\\n* Royal Mail International\\n* Doorman\\n* Other\",\n    \"4-2\": \"The \\\"expected_delivery_date\\\" must adhere to ISO 8601 format, YYYY-MM-DDThh:mm:ss.fffffff-hh:mm.\\n\\nExample: 2009-06-15T13:45:30.0000000-07:00\",\n    \"0-1\": \"Merchant supplied shipment ID.\",\n    \"1-1\": \"Packaging tracking number that the carrier is using.\",\n    \"2-1\": \"Date/Time that a given shipment was shipped.\\n\\nExample: 2009-06-15T13:45:30.0000000-07:00.\\n\\nThis needs to be after order_create_date.\",\n    \"3-1\": \"Shipping method used for the given shipment.\",\n    \"4-1\": \"Date/Time that a given shipment is expected to be delivered.\\n\\nExample: 2009-06-15T13:45:30.0000000-07:00\\n\\nThis needs to be after order_create_date.\",\n    \"5-1\": \"The zip code of the locations from which the customer shipment is being shipped\",\n    \"7-2\": \"The \\\"carrier_pick_up_date\\\" must adhere to ISO 8601 format, YYYY-MM-DDThh:mm:ss.fffffff-hh:mm.\\n\\nExample: 2009-06-15T13:45:30.0000000-07:00\",\n    \"8-1\": \"This is an array of shipment items. Please see our shipment item array table below.\",\n    \"6-1\": \"The carrier that will complete final delivery of the shipment. The tracking number should be for this carrier. Must be one of the valid values. Please contact shipping@jet.com if you would like to see a carrier added to this list.\",\n    \"7-1\": \"The date the carrier picked up the shipment.\",\n    \"3-2\": \"The \\\"response_shipment_method\\\" value will have to be a valid value. It will not, however, have to match the \\\"request_shipping_method\\\" from the order_ready payload. Must be one of the following values\\n* A1\\n* ABF\\n* ADuiePyle\\n* APEX\\n* Averitt\\n* A&MTrucking\\n* CEVA\\n* DHLEasyReturnPlus\\n* DHLExpress12\\n* DHLExpress9\\n* DHLExpressEnvelope\\n* DHLExpressWorldwide\\n* DHLeCommerce\\n* DHLSmartmailFlatsGround\\n* DHLSmartmailParcelGround\\n* DHLSmartmailParcelPlusGround\\n* DynamexSameDay\\n* EasternConnectionExpeditedMail\\n* EasternConnectionGround\\n* EasternConnectionPriority\\n* EasternConnectionSameDay\\n* EnsendaHome\\n* EnsendaNextDay\\n* EnsendaSameDay\\n* EnsendaTwoMan\\n* Estes\\n* Fedex2Day\\n* FedExExpeditedFreight\\n* FedexExpressSaver\\n* FedexFirstOvernight\\n* FedexFreight\\n* FedExGround\\n* FedExHome\\n* FedexPriorityOvernight\\n* FedexSameDay\\n* FedExSmartPost\\n* FedExSmartPostReturns\\n* FedexStandardOvernight\\n* GSOGround\\n* LandAirExpress\\n* LasershipSameDay\\n* LaserShipNextDay\\n* LaserShipGlobalPriority\\n* Prestige\\n* LSO2ndDay\\n* LSOEarlyNexyDay\\n* LSOEconomyNextDay\\n* LSOGround\\n* LSOPriorityNextDay\\n* LSOSaturday\\n* Meyer\\n* NewPenn\\n* OnTracDirectPost\\n* OnTracGround\\n* OnTracPalletizedFreight\\n* OnTracSaturdayDelivery\\n* OnTracSunrise\\n* OnTracSunriseGold\\n* Other\\n* Pilot\\n* RBF\\n* Reddaway\\n* RLCarriers\\n* RoadRunner\\n* SAIAFreight\\n* SoutheasternFreight\\n* SpeeDee\\n* UDSNextDay\\n* UDSSameDay\\n* UES\\n* UPSSurepost\\n* UPS2ndDayAir\\n* UPS2ndDayAirAM\\n* UPS2ndDayAirFreight\\n* UPS2ndDayAirFreightNGS\\n* UPS3DayFreight\\n* UPS3DayFreightNGS\\n* UPS3DaySelect\\n* UPSExpressCritical\\n* UPSFreight\\n* UPSGround\\n* UPSGroundFreightPricing\\n* UPSHundredweightService\\n* UPSMailInnovations\\n* UPSNextDayAir\\n* UPSNextDayAirEarly\\n* UPSNextDayAirFreight\\n* UPSNextDayAirFreightNGS\\n* UPSNextDayAirSaver\\n* UPSStandard\\n* USPSFirstClassMail\\n* USPSMediaMail\\n* USPSPriorityMail\\n* USPSPriorityMailExpress\\n* USPSRetailGround\\n* YRC\\n* DHLEasyReturnLight\\n* DHLEasyReturnGround\\n* DHLSmartmailFlatsExpedited\\n* DHLSmartmailParcelExpedited\\n* DHLSmartmailParcelPlusExpedited\\n* GSOPriority\\n* GSOFreight\",\n    \"1-2\": \"Must not be populated for any shipment message which contains a total \\\"response_shipment_sku_quantity\\\" of 0.\\n\\nBeginning May 29, 2017, multiple, concatenated tracking numbers should not be sent for an individual SKU.\",\n    \"9-0\": \"**redirect_notification**\\n\\n*redirect_notification object*\",\n    \"9-1\": \"This is an object for indicating if a shipment has come out of a different fulfillment node than the one originally asserted by Jet. Please see our redirect notification object table below.\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\n}\n[/block]\n**shipment_items array** - The below table outlines the fields that are within the shipment items array:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**alt_shipment_item_id** \\n\\n*string*\",\n    \"1-0\": \"**merchant_sku***\\n\\n*string*\",\n    \"2-0\": \"**response_shipment_sku_quantity** \\n\\n*integer*\",\n    \"3-0\": \"**response_shipment_cancel_qty** \\n\\n*integer*\",\n    \"4-0\": \"**RMA_number** \\n\\n*string*\",\n    \"5-0\": \"**return_location** \\n\\n*object*\",\n    \"0-1\": \"Optional seller supplied ID for an item in a specific shipment.\",\n    \"1-1\": \"A merchant SKU that was set up in your catalog\",\n    \"2-1\": \"Quantity of the given SKU that was shipped in the given shipment\",\n    \"3-1\": \"Quantity of the given SKU that was cancelled in the given shipment\",\n    \"4-1\": \"The RMA # in your system associated with this order item if returned\",\n    \"5-1\": \"In the event the item is return, the location the item would go back.\",\n    \"1-2\": \"The \\\"merchant_sku\\\" in any shipment item must have appeared in the original order.\",\n    \"2-2\": \"Required if no units are cancelled: response_shipment_cancel_qty = 0 or is omitted\",\n    \"3-2\": \"Required if no units are shipped: response_shipment_sku_quantity= 0 or is omitted\",\n    \"5-2\": \"The \\\"return_location\\\" value cannot be Jet HQ and cannot have placeholder values (e.g. zip code of \\\"00000\\\") - it must be a real, non-Jet address.\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Cancellations after accepting an order\",\n  \"body\": \"If the merchant has accepted an order and need to cancel a unit, please use the response_shipment_cancel_qty field to indicate to Jet the number of units for the line item that can't be fulfilled\"\n}\n[/block]\n**return location object** - The below table outlines the fields that are within the returns location object:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**address1***\\n\\n*string*\",\n    \"1-0\": \"**address2**\\n\\n*string*\",\n    \"2-0\": \"**city***\\n\\n*string*\",\n    \"3-0\": \"**state***\\n\\n*string*\",\n    \"4-0\": \"**zip_code***\\n\\n*string*\",\n    \"0-1\": \"The first address line for the return location\",\n    \"1-1\": \"The second address line for the return location\",\n    \"2-1\": \"The city, town, or village of the return location\",\n    \"3-1\": \"The state of the return location\",\n    \"4-1\": \"The postal code for the return location\",\n    \"0-2\": \"Required if return_location is provided\",\n    \"2-2\": \"Required if return_location is provided\",\n    \"3-2\": \"Required if return_location is provided\",\n    \"4-2\": \"Required if return_location is provided\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n**redirect notification object** - The below table outlines the fields that are within the redirect notification object:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"**redirect_node***\\n\\n*string*\",\n    \"1-0\": \"**is_redirect_for_zero_inventory**\\n\\n*string*\",\n    \"h-2\": \"Validation\",\n    \"0-2\": \"Must be a valid fulfillment node ID set up by the merchant\",\n    \"1-1\": \"Was this order redirected to a new node because of Jet's having bad inventory data, or for another reason? \\n\\nIf set to true, Jet will zero the inventory at this node.\",\n    \"0-1\": \"The fulfillment node the merchant ultimately chose to ship out of.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use Cases\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Examples of request bodies\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"alt_order_id\\\": \\\"12345\\\",\\n  \\\"shipments\\\": [\\n    {\\n      \\\"alt_shipment_id\\\": \\\"11223344\\\",\\n      \\\"shipment_tracking_number\\\": \\\"1Z12342452342\\\",\\n      \\\"response_shipment_date\\\": \\\"2014-06-11T18:00:00.0000000-04:00\\\",\\n      \\\"response_shipment_method\\\": \\\"ups_ground\\\",\\n      \\\"expected_delivery_date\\\": \\\"2014-06-11T18:00:00.0000000-04:00\\\",\\n      \\\"ship_from_zip_code\\\": \\\"12061\\\",\\n      \\\"carrier_pick_up_date\\\": \\\"2014-06-11T18:00:00.0000000-04:00\\\",\\n      \\\"carrier\\\": \\\"UPS\\\",\\n      \\\"shipment_items\\\": [\\n        {\\n          \\\"alt_shipment_item_id\\\": \\\"129900120\\\",\\n          \\\"merchant_sku\\\": \\\"15a1010\\\",\\n          \\\"response_shipment_sku_quantity\\\": 1\\n        }\\n      ]\\n    }\\n  ]\\n}\\n\",\n      \"language\": \"json\",\n      \"name\": \"Units Shipped\"\n    },\n    {\n      \"code\": \"{\\n  \\\"alt_order_id\\\": \\\"12345\\\",\\n  \\\"shipments\\\": [\\n    {\\n      \\\"alt_shipment_id\\\": \\\"11223344\\\",\\n      \\\"shipment_items\\\": [\\n        {\\n          \\\"alt_shipment_item_id\\\": \\\"129900120\\\",\\n          \\\"merchant_sku\\\": \\\"15a1010\\\",\\n          \\\"response_shipment_cancel_qty\\\": 1\\n        }\\n      ]\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Units Cancelled\"\n    },\n    {\n      \"code\": \"{\\n  \\\"alt_order_id\\\": \\\"12345\\\",\\n  \\\"shipments\\\": [\\n    {\\n      \\\"alt_shipment_id\\\": \\\"11223344\\\",\\n      \\\"shipment_tracking_number\\\": \\\"1Z12342452342\\\",\\n      \\\"response_shipment_date\\\": \\\"2014-06-11T18:00:00.0000000-04:00\\\",\\n      \\\"response_shipment_method\\\": \\\"ups_ground\\\",\\n      \\\"expected_delivery_date\\\": \\\"2014-06-11T18:00:00.0000000-04:00\\\",\\n      \\\"ship_from_zip_code\\\": \\\"12061\\\",\\n      \\\"carrier_pick_up_date\\\": \\\"2014-06-11T18:00:00.0000000-04:00\\\",\\n      \\\"carrier\\\": \\\"UPS\\\",\\n      \\\"shipment_items\\\": [\\n        {\\n          \\\"alt_shipment_item_id\\\": \\\"129900120\\\",\\n          \\\"merchant_sku\\\": \\\"15a1010\\\",\\n          \\\"response_shipment_sku_quantity\\\": 1,\\n          \\\"response_shipment_cancel_qty\\\": 1,\\n          \\\"RMA_number\\\": \\\"abcdef\\\", //in the event this item is returned, 'abcdef' \\n          \\\"return_location\\\": { //in the event the item is returned, we will send it back to this location\\n            \\\"address1\\\": \\\"12 Location Street\\\",\\n            \\\"address2\\\": \\\"\\\",\\n            \\\"city\\\": \\\"Somewhere\\\",\\n            \\\"state\\\": \\\"NY\\\",\\n            \\\"zip_code\\\": \\\"12345\\\"\\n          }\\n        }\\n      ]\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"RMA Number with Return Location\"\n    },\n    {\n      \"code\": \"{\\n  \\\"alt_order_id\\\": \\\"12345\\\",\\n  \\\"shipments\\\": [\\n    {\\n      \\\"alt_shipment_id\\\": \\\"11223344\\\",\\n      \\\"shipment_tracking_number\\\": \\\"1Z12342452342\\\",\\n      \\\"response_shipment_date\\\": \\\"2014-06-11T18:00:00.0000000-04:00\\\",\\n      \\\"response_shipment_method\\\": \\\"ups_ground\\\",\\n      \\\"expected_delivery_date\\\": \\\"2014-06-11T18:00:00.0000000-04:00\\\",\\n      \\\"ship_from_zip_code\\\": \\\"12061\\\",\\n      \\\"carrier_pick_up_date\\\": \\\"2014-06-11T18:00:00.0000000-04:00\\\",\\n      \\\"carrier\\\": \\\"UPS\\\",\\n      \\\"shipment_items\\\": [\\n        {\\n          \\\"alt_shipment_item_id\\\": \\\"129900120\\\",\\n          \\\"merchant_sku\\\": \\\"15a1010\\\",\\n          \\\"response_shipment_sku_quantity\\\": 1,\\n          \\\"response_shipment_cancel_qty\\\": 1,\\n          \\\"RMA_number\\\": \\\"abcdef\\\",\\n          \\\"return_location\\\": {\\n            \\\"address1\\\": \\\"12 Location Street\\\",\\n            \\\"city\\\": \\\"Somewhere\\\",\\n            \\\"state\\\": \\\"NY\\\",\\n            \\\"zip_code\\\": \\\"12345\\\"\\n          }\\n        },\\n        {\\n          \\\"alt_shipment_item_id\\\": \\\"129900121\\\",\\n          \\\"merchant_sku\\\": \\\"15a1011\\\",\\n          \\\"response_shipment_cancel_qty\\\": 1\\n        }\\n      ]\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Mixed Example\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","createdAt":"2015-11-19T20:46:10.878Z","excerpt":"","link_external":false,"updates":["58f71acf8ffdd20f00db731b"],"user":"562e25d24376430d006f1769","__v":3,"api":{"method":"put","params":[{"_id":"564e3512e964972100508e69","ref":"","in":"path","required":false,"desc":"The Jet defined order ID","default":"","type":"string","name":"jet_defined_order_id"}],"results":{"codes":[{"language":"json","status":204,"code":""},{"status":400,"language":"json","code":"{\n  \"errors\": [\n    \"The value is expected to be an integer. Path: /shipments[0]/shipment_items[0]/response_shipment_sku_quantity\"\n  ]\n}"}]},"settings":"","url":"/orders/{jet_defined_order_id}/shipped","auth":"required","examples":{"codes":[]}},"category":"56fd2bf327b4321900186ecb","githubsync":"","hidden":false,"link_url":"","next":{"description":"","pages":[]},"order":3,"slug":"ship-order","editedParams2":true,"isReference":false,"project":"562e25f2e01a430d00c2c91e","type":"put","version":"56fd2bf327b4321900186ec6","editedParams":true,"parentDoc":null,"sync_unique":"","title":"Ship Order","childrenPages":[]}

putShip Order


Path Params

jet_defined_order_id:
string
The Jet defined order ID
[block:api-header] { "type": "basic", "title": "Request Body" } [/block] The order shipped call is utilized to provide Jet with the SKUs that have been shipped or cancelled in an order, the tracking information, carrier information and any additional returns information for the order. The fields for the order shipped call are outlined below: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**alt_order_id** \n\n*string*", "1-0": "**shipments ***\n\n*shipments object array*", "0-1": "Optional merchant supplied order ID. Jet will map this ID to Jet's order_id and you can then use this ID in subsequent messages relating to this order.", "1-1": "This is an array of shipments. Please see our shipments array table below." }, "cols": 3, "rows": 2 } [/block] **shipments array** - The below table outlines the fields that are within the shipments array: [block:parameters] { "data": { "h-0": "Field", "h-2": "Validation", "h-1": "Description", "0-0": "**alt_shipment_id** \n\n*string*", "1-0": "**shipment_tracking_number** \n\n*string*", "2-0": "**response_shipment_date** \n\n*string*", "3-0": "**response_shipment_method** \n\n*string*", "4-0": "**expected_delivery_date**\n\n*string*", "5-0": "**ship_from_zip_code** \n\n*string*", "6-0": "**carrier** \n\n*string*", "7-0": "**carrier_pick_up_date** \n\n*string*", "8-0": "**shipment_items***\n\n*shipment_items object array*", "2-2": "The \"response_shipment_date\" must adhere to ISO 8601 format, YYYY-MM-DDThh:mm:ss.fffffff-hh:mm.\n\nExample: 2009-06-15T13:45:30.0000000-07:00", "6-2": "Required when \n\"response_shipment_sku_quantity\" >= 1. \n\nMust be one of the following values\n* FedEx\n* FedEx SmartPost\n* FedEx Freight\n* UPS\n* UPS Freight\n* UPS Mail Innovations\n* UPS SurePost\n* OnTrac\n* OnTrac Direct Post\n* DHL\n* DHL Global Mail\n* USPS\n* CEVA\n* Laser Ship\n* LaserShip\n* Spee Dee\n* A Duie Pyle\n* A1\n* ABF\n* APEX\n* Averitt\n* Dynamex\n* Eastern Connection\n* Ensenda\n* Estes\n* Land Air Express\n* Lone Star\n* Meyer\n* New Penn\n* Pilot\n* Prestige\n* RBF\n* Reddaway\n* RL Carriers\n* Roadrunner\n* SAIA Freight\n* Southeastern Freight\n* UDS\n* UES\n* YRC\n* GSO\n* A&M Trucking\n* Old Dominion\n* Parcel\n* ConveyDecisioning\n* JetExpress\n* Bekins / Home Direct\n* Seko Worldwide\n* Mail Express\n* Dynamex\n* Newgistics\n* Delivered by Walmart\n* NonstopDelivery\n* MPX\n* Cagney Global\n* Simmons Carrier\n* DeliveryCourier\n* AGS\n* Watkins & Shepard\n* WN Direct\n* Royal Mail International\n* Doorman\n* Other", "4-2": "The \"expected_delivery_date\" must adhere to ISO 8601 format, YYYY-MM-DDThh:mm:ss.fffffff-hh:mm.\n\nExample: 2009-06-15T13:45:30.0000000-07:00", "0-1": "Merchant supplied shipment ID.", "1-1": "Packaging tracking number that the carrier is using.", "2-1": "Date/Time that a given shipment was shipped.\n\nExample: 2009-06-15T13:45:30.0000000-07:00.\n\nThis needs to be after order_create_date.", "3-1": "Shipping method used for the given shipment.", "4-1": "Date/Time that a given shipment is expected to be delivered.\n\nExample: 2009-06-15T13:45:30.0000000-07:00\n\nThis needs to be after order_create_date.", "5-1": "The zip code of the locations from which the customer shipment is being shipped", "7-2": "The \"carrier_pick_up_date\" must adhere to ISO 8601 format, YYYY-MM-DDThh:mm:ss.fffffff-hh:mm.\n\nExample: 2009-06-15T13:45:30.0000000-07:00", "8-1": "This is an array of shipment items. Please see our shipment item array table below.", "6-1": "The carrier that will complete final delivery of the shipment. The tracking number should be for this carrier. Must be one of the valid values. Please contact shipping@jet.com if you would like to see a carrier added to this list.", "7-1": "The date the carrier picked up the shipment.", "3-2": "The \"response_shipment_method\" value will have to be a valid value. It will not, however, have to match the \"request_shipping_method\" from the order_ready payload. Must be one of the following values\n* A1\n* ABF\n* ADuiePyle\n* APEX\n* Averitt\n* A&MTrucking\n* CEVA\n* DHLEasyReturnPlus\n* DHLExpress12\n* DHLExpress9\n* DHLExpressEnvelope\n* DHLExpressWorldwide\n* DHLeCommerce\n* DHLSmartmailFlatsGround\n* DHLSmartmailParcelGround\n* DHLSmartmailParcelPlusGround\n* DynamexSameDay\n* EasternConnectionExpeditedMail\n* EasternConnectionGround\n* EasternConnectionPriority\n* EasternConnectionSameDay\n* EnsendaHome\n* EnsendaNextDay\n* EnsendaSameDay\n* EnsendaTwoMan\n* Estes\n* Fedex2Day\n* FedExExpeditedFreight\n* FedexExpressSaver\n* FedexFirstOvernight\n* FedexFreight\n* FedExGround\n* FedExHome\n* FedexPriorityOvernight\n* FedexSameDay\n* FedExSmartPost\n* FedExSmartPostReturns\n* FedexStandardOvernight\n* GSOGround\n* LandAirExpress\n* LasershipSameDay\n* LaserShipNextDay\n* LaserShipGlobalPriority\n* Prestige\n* LSO2ndDay\n* LSOEarlyNexyDay\n* LSOEconomyNextDay\n* LSOGround\n* LSOPriorityNextDay\n* LSOSaturday\n* Meyer\n* NewPenn\n* OnTracDirectPost\n* OnTracGround\n* OnTracPalletizedFreight\n* OnTracSaturdayDelivery\n* OnTracSunrise\n* OnTracSunriseGold\n* Other\n* Pilot\n* RBF\n* Reddaway\n* RLCarriers\n* RoadRunner\n* SAIAFreight\n* SoutheasternFreight\n* SpeeDee\n* UDSNextDay\n* UDSSameDay\n* UES\n* UPSSurepost\n* UPS2ndDayAir\n* UPS2ndDayAirAM\n* UPS2ndDayAirFreight\n* UPS2ndDayAirFreightNGS\n* UPS3DayFreight\n* UPS3DayFreightNGS\n* UPS3DaySelect\n* UPSExpressCritical\n* UPSFreight\n* UPSGround\n* UPSGroundFreightPricing\n* UPSHundredweightService\n* UPSMailInnovations\n* UPSNextDayAir\n* UPSNextDayAirEarly\n* UPSNextDayAirFreight\n* UPSNextDayAirFreightNGS\n* UPSNextDayAirSaver\n* UPSStandard\n* USPSFirstClassMail\n* USPSMediaMail\n* USPSPriorityMail\n* USPSPriorityMailExpress\n* USPSRetailGround\n* YRC\n* DHLEasyReturnLight\n* DHLEasyReturnGround\n* DHLSmartmailFlatsExpedited\n* DHLSmartmailParcelExpedited\n* DHLSmartmailParcelPlusExpedited\n* GSOPriority\n* GSOFreight", "1-2": "Must not be populated for any shipment message which contains a total \"response_shipment_sku_quantity\" of 0.\n\nBeginning May 29, 2017, multiple, concatenated tracking numbers should not be sent for an individual SKU.", "9-0": "**redirect_notification**\n\n*redirect_notification object*", "9-1": "This is an object for indicating if a shipment has come out of a different fulfillment node than the one originally asserted by Jet. Please see our redirect notification object table below." }, "cols": 3, "rows": 10 } [/block] **shipment_items array** - The below table outlines the fields that are within the shipment items array: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**alt_shipment_item_id** \n\n*string*", "1-0": "**merchant_sku***\n\n*string*", "2-0": "**response_shipment_sku_quantity** \n\n*integer*", "3-0": "**response_shipment_cancel_qty** \n\n*integer*", "4-0": "**RMA_number** \n\n*string*", "5-0": "**return_location** \n\n*object*", "0-1": "Optional seller supplied ID for an item in a specific shipment.", "1-1": "A merchant SKU that was set up in your catalog", "2-1": "Quantity of the given SKU that was shipped in the given shipment", "3-1": "Quantity of the given SKU that was cancelled in the given shipment", "4-1": "The RMA # in your system associated with this order item if returned", "5-1": "In the event the item is return, the location the item would go back.", "1-2": "The \"merchant_sku\" in any shipment item must have appeared in the original order.", "2-2": "Required if no units are cancelled: response_shipment_cancel_qty = 0 or is omitted", "3-2": "Required if no units are shipped: response_shipment_sku_quantity= 0 or is omitted", "5-2": "The \"return_location\" value cannot be Jet HQ and cannot have placeholder values (e.g. zip code of \"00000\") - it must be a real, non-Jet address." }, "cols": 3, "rows": 6 } [/block] [block:callout] { "type": "warning", "title": "Cancellations after accepting an order", "body": "If the merchant has accepted an order and need to cancel a unit, please use the response_shipment_cancel_qty field to indicate to Jet the number of units for the line item that can't be fulfilled" } [/block] **return location object** - The below table outlines the fields that are within the returns location object: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**address1***\n\n*string*", "1-0": "**address2**\n\n*string*", "2-0": "**city***\n\n*string*", "3-0": "**state***\n\n*string*", "4-0": "**zip_code***\n\n*string*", "0-1": "The first address line for the return location", "1-1": "The second address line for the return location", "2-1": "The city, town, or village of the return location", "3-1": "The state of the return location", "4-1": "The postal code for the return location", "0-2": "Required if return_location is provided", "2-2": "Required if return_location is provided", "3-2": "Required if return_location is provided", "4-2": "Required if return_location is provided" }, "cols": 3, "rows": 5 } [/block] **redirect notification object** - The below table outlines the fields that are within the redirect notification object: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "0-0": "**redirect_node***\n\n*string*", "1-0": "**is_redirect_for_zero_inventory**\n\n*string*", "h-2": "Validation", "0-2": "Must be a valid fulfillment node ID set up by the merchant", "1-1": "Was this order redirected to a new node because of Jet's having bad inventory data, or for another reason? \n\nIf set to true, Jet will zero the inventory at this node.", "0-1": "The fulfillment node the merchant ultimately chose to ship out of." }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Examples of request bodies", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"alt_order_id\": \"12345\",\n \"shipments\": [\n {\n \"alt_shipment_id\": \"11223344\",\n \"shipment_tracking_number\": \"1Z12342452342\",\n \"response_shipment_date\": \"2014-06-11T18:00:00.0000000-04:00\",\n \"response_shipment_method\": \"ups_ground\",\n \"expected_delivery_date\": \"2014-06-11T18:00:00.0000000-04:00\",\n \"ship_from_zip_code\": \"12061\",\n \"carrier_pick_up_date\": \"2014-06-11T18:00:00.0000000-04:00\",\n \"carrier\": \"UPS\",\n \"shipment_items\": [\n {\n \"alt_shipment_item_id\": \"129900120\",\n \"merchant_sku\": \"15a1010\",\n \"response_shipment_sku_quantity\": 1\n }\n ]\n }\n ]\n}\n", "language": "json", "name": "Units Shipped" }, { "code": "{\n \"alt_order_id\": \"12345\",\n \"shipments\": [\n {\n \"alt_shipment_id\": \"11223344\",\n \"shipment_items\": [\n {\n \"alt_shipment_item_id\": \"129900120\",\n \"merchant_sku\": \"15a1010\",\n \"response_shipment_cancel_qty\": 1\n }\n ]\n }\n ]\n}", "language": "json", "name": "Units Cancelled" }, { "code": "{\n \"alt_order_id\": \"12345\",\n \"shipments\": [\n {\n \"alt_shipment_id\": \"11223344\",\n \"shipment_tracking_number\": \"1Z12342452342\",\n \"response_shipment_date\": \"2014-06-11T18:00:00.0000000-04:00\",\n \"response_shipment_method\": \"ups_ground\",\n \"expected_delivery_date\": \"2014-06-11T18:00:00.0000000-04:00\",\n \"ship_from_zip_code\": \"12061\",\n \"carrier_pick_up_date\": \"2014-06-11T18:00:00.0000000-04:00\",\n \"carrier\": \"UPS\",\n \"shipment_items\": [\n {\n \"alt_shipment_item_id\": \"129900120\",\n \"merchant_sku\": \"15a1010\",\n \"response_shipment_sku_quantity\": 1,\n \"response_shipment_cancel_qty\": 1,\n \"RMA_number\": \"abcdef\", //in the event this item is returned, 'abcdef' \n \"return_location\": { //in the event the item is returned, we will send it back to this location\n \"address1\": \"12 Location Street\",\n \"address2\": \"\",\n \"city\": \"Somewhere\",\n \"state\": \"NY\",\n \"zip_code\": \"12345\"\n }\n }\n ]\n }\n ]\n}", "language": "json", "name": "RMA Number with Return Location" }, { "code": "{\n \"alt_order_id\": \"12345\",\n \"shipments\": [\n {\n \"alt_shipment_id\": \"11223344\",\n \"shipment_tracking_number\": \"1Z12342452342\",\n \"response_shipment_date\": \"2014-06-11T18:00:00.0000000-04:00\",\n \"response_shipment_method\": \"ups_ground\",\n \"expected_delivery_date\": \"2014-06-11T18:00:00.0000000-04:00\",\n \"ship_from_zip_code\": \"12061\",\n \"carrier_pick_up_date\": \"2014-06-11T18:00:00.0000000-04:00\",\n \"carrier\": \"UPS\",\n \"shipment_items\": [\n {\n \"alt_shipment_item_id\": \"129900120\",\n \"merchant_sku\": \"15a1010\",\n \"response_shipment_sku_quantity\": 1,\n \"response_shipment_cancel_qty\": 1,\n \"RMA_number\": \"abcdef\",\n \"return_location\": {\n \"address1\": \"12 Location Street\",\n \"city\": \"Somewhere\",\n \"state\": \"NY\",\n \"zip_code\": \"12345\"\n }\n },\n {\n \"alt_shipment_item_id\": \"129900121\",\n \"merchant_sku\": \"15a1011\",\n \"response_shipment_cancel_qty\": 1\n }\n ]\n }\n ]\n}", "language": "json", "name": "Mixed Example" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


[block:api-header] { "type": "basic", "title": "Request Body" } [/block] The order shipped call is utilized to provide Jet with the SKUs that have been shipped or cancelled in an order, the tracking information, carrier information and any additional returns information for the order. The fields for the order shipped call are outlined below: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**alt_order_id** \n\n*string*", "1-0": "**shipments ***\n\n*shipments object array*", "0-1": "Optional merchant supplied order ID. Jet will map this ID to Jet's order_id and you can then use this ID in subsequent messages relating to this order.", "1-1": "This is an array of shipments. Please see our shipments array table below." }, "cols": 3, "rows": 2 } [/block] **shipments array** - The below table outlines the fields that are within the shipments array: [block:parameters] { "data": { "h-0": "Field", "h-2": "Validation", "h-1": "Description", "0-0": "**alt_shipment_id** \n\n*string*", "1-0": "**shipment_tracking_number** \n\n*string*", "2-0": "**response_shipment_date** \n\n*string*", "3-0": "**response_shipment_method** \n\n*string*", "4-0": "**expected_delivery_date**\n\n*string*", "5-0": "**ship_from_zip_code** \n\n*string*", "6-0": "**carrier** \n\n*string*", "7-0": "**carrier_pick_up_date** \n\n*string*", "8-0": "**shipment_items***\n\n*shipment_items object array*", "2-2": "The \"response_shipment_date\" must adhere to ISO 8601 format, YYYY-MM-DDThh:mm:ss.fffffff-hh:mm.\n\nExample: 2009-06-15T13:45:30.0000000-07:00", "6-2": "Required when \n\"response_shipment_sku_quantity\" >= 1. \n\nMust be one of the following values\n* FedEx\n* FedEx SmartPost\n* FedEx Freight\n* UPS\n* UPS Freight\n* UPS Mail Innovations\n* UPS SurePost\n* OnTrac\n* OnTrac Direct Post\n* DHL\n* DHL Global Mail\n* USPS\n* CEVA\n* Laser Ship\n* LaserShip\n* Spee Dee\n* A Duie Pyle\n* A1\n* ABF\n* APEX\n* Averitt\n* Dynamex\n* Eastern Connection\n* Ensenda\n* Estes\n* Land Air Express\n* Lone Star\n* Meyer\n* New Penn\n* Pilot\n* Prestige\n* RBF\n* Reddaway\n* RL Carriers\n* Roadrunner\n* SAIA Freight\n* Southeastern Freight\n* UDS\n* UES\n* YRC\n* GSO\n* A&M Trucking\n* Old Dominion\n* Parcel\n* ConveyDecisioning\n* JetExpress\n* Bekins / Home Direct\n* Seko Worldwide\n* Mail Express\n* Dynamex\n* Newgistics\n* Delivered by Walmart\n* NonstopDelivery\n* MPX\n* Cagney Global\n* Simmons Carrier\n* DeliveryCourier\n* AGS\n* Watkins & Shepard\n* WN Direct\n* Royal Mail International\n* Doorman\n* Other", "4-2": "The \"expected_delivery_date\" must adhere to ISO 8601 format, YYYY-MM-DDThh:mm:ss.fffffff-hh:mm.\n\nExample: 2009-06-15T13:45:30.0000000-07:00", "0-1": "Merchant supplied shipment ID.", "1-1": "Packaging tracking number that the carrier is using.", "2-1": "Date/Time that a given shipment was shipped.\n\nExample: 2009-06-15T13:45:30.0000000-07:00.\n\nThis needs to be after order_create_date.", "3-1": "Shipping method used for the given shipment.", "4-1": "Date/Time that a given shipment is expected to be delivered.\n\nExample: 2009-06-15T13:45:30.0000000-07:00\n\nThis needs to be after order_create_date.", "5-1": "The zip code of the locations from which the customer shipment is being shipped", "7-2": "The \"carrier_pick_up_date\" must adhere to ISO 8601 format, YYYY-MM-DDThh:mm:ss.fffffff-hh:mm.\n\nExample: 2009-06-15T13:45:30.0000000-07:00", "8-1": "This is an array of shipment items. Please see our shipment item array table below.", "6-1": "The carrier that will complete final delivery of the shipment. The tracking number should be for this carrier. Must be one of the valid values. Please contact shipping@jet.com if you would like to see a carrier added to this list.", "7-1": "The date the carrier picked up the shipment.", "3-2": "The \"response_shipment_method\" value will have to be a valid value. It will not, however, have to match the \"request_shipping_method\" from the order_ready payload. Must be one of the following values\n* A1\n* ABF\n* ADuiePyle\n* APEX\n* Averitt\n* A&MTrucking\n* CEVA\n* DHLEasyReturnPlus\n* DHLExpress12\n* DHLExpress9\n* DHLExpressEnvelope\n* DHLExpressWorldwide\n* DHLeCommerce\n* DHLSmartmailFlatsGround\n* DHLSmartmailParcelGround\n* DHLSmartmailParcelPlusGround\n* DynamexSameDay\n* EasternConnectionExpeditedMail\n* EasternConnectionGround\n* EasternConnectionPriority\n* EasternConnectionSameDay\n* EnsendaHome\n* EnsendaNextDay\n* EnsendaSameDay\n* EnsendaTwoMan\n* Estes\n* Fedex2Day\n* FedExExpeditedFreight\n* FedexExpressSaver\n* FedexFirstOvernight\n* FedexFreight\n* FedExGround\n* FedExHome\n* FedexPriorityOvernight\n* FedexSameDay\n* FedExSmartPost\n* FedExSmartPostReturns\n* FedexStandardOvernight\n* GSOGround\n* LandAirExpress\n* LasershipSameDay\n* LaserShipNextDay\n* LaserShipGlobalPriority\n* Prestige\n* LSO2ndDay\n* LSOEarlyNexyDay\n* LSOEconomyNextDay\n* LSOGround\n* LSOPriorityNextDay\n* LSOSaturday\n* Meyer\n* NewPenn\n* OnTracDirectPost\n* OnTracGround\n* OnTracPalletizedFreight\n* OnTracSaturdayDelivery\n* OnTracSunrise\n* OnTracSunriseGold\n* Other\n* Pilot\n* RBF\n* Reddaway\n* RLCarriers\n* RoadRunner\n* SAIAFreight\n* SoutheasternFreight\n* SpeeDee\n* UDSNextDay\n* UDSSameDay\n* UES\n* UPSSurepost\n* UPS2ndDayAir\n* UPS2ndDayAirAM\n* UPS2ndDayAirFreight\n* UPS2ndDayAirFreightNGS\n* UPS3DayFreight\n* UPS3DayFreightNGS\n* UPS3DaySelect\n* UPSExpressCritical\n* UPSFreight\n* UPSGround\n* UPSGroundFreightPricing\n* UPSHundredweightService\n* UPSMailInnovations\n* UPSNextDayAir\n* UPSNextDayAirEarly\n* UPSNextDayAirFreight\n* UPSNextDayAirFreightNGS\n* UPSNextDayAirSaver\n* UPSStandard\n* USPSFirstClassMail\n* USPSMediaMail\n* USPSPriorityMail\n* USPSPriorityMailExpress\n* USPSRetailGround\n* YRC\n* DHLEasyReturnLight\n* DHLEasyReturnGround\n* DHLSmartmailFlatsExpedited\n* DHLSmartmailParcelExpedited\n* DHLSmartmailParcelPlusExpedited\n* GSOPriority\n* GSOFreight", "1-2": "Must not be populated for any shipment message which contains a total \"response_shipment_sku_quantity\" of 0.\n\nBeginning May 29, 2017, multiple, concatenated tracking numbers should not be sent for an individual SKU.", "9-0": "**redirect_notification**\n\n*redirect_notification object*", "9-1": "This is an object for indicating if a shipment has come out of a different fulfillment node than the one originally asserted by Jet. Please see our redirect notification object table below." }, "cols": 3, "rows": 10 } [/block] **shipment_items array** - The below table outlines the fields that are within the shipment items array: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**alt_shipment_item_id** \n\n*string*", "1-0": "**merchant_sku***\n\n*string*", "2-0": "**response_shipment_sku_quantity** \n\n*integer*", "3-0": "**response_shipment_cancel_qty** \n\n*integer*", "4-0": "**RMA_number** \n\n*string*", "5-0": "**return_location** \n\n*object*", "0-1": "Optional seller supplied ID for an item in a specific shipment.", "1-1": "A merchant SKU that was set up in your catalog", "2-1": "Quantity of the given SKU that was shipped in the given shipment", "3-1": "Quantity of the given SKU that was cancelled in the given shipment", "4-1": "The RMA # in your system associated with this order item if returned", "5-1": "In the event the item is return, the location the item would go back.", "1-2": "The \"merchant_sku\" in any shipment item must have appeared in the original order.", "2-2": "Required if no units are cancelled: response_shipment_cancel_qty = 0 or is omitted", "3-2": "Required if no units are shipped: response_shipment_sku_quantity= 0 or is omitted", "5-2": "The \"return_location\" value cannot be Jet HQ and cannot have placeholder values (e.g. zip code of \"00000\") - it must be a real, non-Jet address." }, "cols": 3, "rows": 6 } [/block] [block:callout] { "type": "warning", "title": "Cancellations after accepting an order", "body": "If the merchant has accepted an order and need to cancel a unit, please use the response_shipment_cancel_qty field to indicate to Jet the number of units for the line item that can't be fulfilled" } [/block] **return location object** - The below table outlines the fields that are within the returns location object: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**address1***\n\n*string*", "1-0": "**address2**\n\n*string*", "2-0": "**city***\n\n*string*", "3-0": "**state***\n\n*string*", "4-0": "**zip_code***\n\n*string*", "0-1": "The first address line for the return location", "1-1": "The second address line for the return location", "2-1": "The city, town, or village of the return location", "3-1": "The state of the return location", "4-1": "The postal code for the return location", "0-2": "Required if return_location is provided", "2-2": "Required if return_location is provided", "3-2": "Required if return_location is provided", "4-2": "Required if return_location is provided" }, "cols": 3, "rows": 5 } [/block] **redirect notification object** - The below table outlines the fields that are within the redirect notification object: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "0-0": "**redirect_node***\n\n*string*", "1-0": "**is_redirect_for_zero_inventory**\n\n*string*", "h-2": "Validation", "0-2": "Must be a valid fulfillment node ID set up by the merchant", "1-1": "Was this order redirected to a new node because of Jet's having bad inventory data, or for another reason? \n\nIf set to true, Jet will zero the inventory at this node.", "0-1": "The fulfillment node the merchant ultimately chose to ship out of." }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Examples of request bodies", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"alt_order_id\": \"12345\",\n \"shipments\": [\n {\n \"alt_shipment_id\": \"11223344\",\n \"shipment_tracking_number\": \"1Z12342452342\",\n \"response_shipment_date\": \"2014-06-11T18:00:00.0000000-04:00\",\n \"response_shipment_method\": \"ups_ground\",\n \"expected_delivery_date\": \"2014-06-11T18:00:00.0000000-04:00\",\n \"ship_from_zip_code\": \"12061\",\n \"carrier_pick_up_date\": \"2014-06-11T18:00:00.0000000-04:00\",\n \"carrier\": \"UPS\",\n \"shipment_items\": [\n {\n \"alt_shipment_item_id\": \"129900120\",\n \"merchant_sku\": \"15a1010\",\n \"response_shipment_sku_quantity\": 1\n }\n ]\n }\n ]\n}\n", "language": "json", "name": "Units Shipped" }, { "code": "{\n \"alt_order_id\": \"12345\",\n \"shipments\": [\n {\n \"alt_shipment_id\": \"11223344\",\n \"shipment_items\": [\n {\n \"alt_shipment_item_id\": \"129900120\",\n \"merchant_sku\": \"15a1010\",\n \"response_shipment_cancel_qty\": 1\n }\n ]\n }\n ]\n}", "language": "json", "name": "Units Cancelled" }, { "code": "{\n \"alt_order_id\": \"12345\",\n \"shipments\": [\n {\n \"alt_shipment_id\": \"11223344\",\n \"shipment_tracking_number\": \"1Z12342452342\",\n \"response_shipment_date\": \"2014-06-11T18:00:00.0000000-04:00\",\n \"response_shipment_method\": \"ups_ground\",\n \"expected_delivery_date\": \"2014-06-11T18:00:00.0000000-04:00\",\n \"ship_from_zip_code\": \"12061\",\n \"carrier_pick_up_date\": \"2014-06-11T18:00:00.0000000-04:00\",\n \"carrier\": \"UPS\",\n \"shipment_items\": [\n {\n \"alt_shipment_item_id\": \"129900120\",\n \"merchant_sku\": \"15a1010\",\n \"response_shipment_sku_quantity\": 1,\n \"response_shipment_cancel_qty\": 1,\n \"RMA_number\": \"abcdef\", //in the event this item is returned, 'abcdef' \n \"return_location\": { //in the event the item is returned, we will send it back to this location\n \"address1\": \"12 Location Street\",\n \"address2\": \"\",\n \"city\": \"Somewhere\",\n \"state\": \"NY\",\n \"zip_code\": \"12345\"\n }\n }\n ]\n }\n ]\n}", "language": "json", "name": "RMA Number with Return Location" }, { "code": "{\n \"alt_order_id\": \"12345\",\n \"shipments\": [\n {\n \"alt_shipment_id\": \"11223344\",\n \"shipment_tracking_number\": \"1Z12342452342\",\n \"response_shipment_date\": \"2014-06-11T18:00:00.0000000-04:00\",\n \"response_shipment_method\": \"ups_ground\",\n \"expected_delivery_date\": \"2014-06-11T18:00:00.0000000-04:00\",\n \"ship_from_zip_code\": \"12061\",\n \"carrier_pick_up_date\": \"2014-06-11T18:00:00.0000000-04:00\",\n \"carrier\": \"UPS\",\n \"shipment_items\": [\n {\n \"alt_shipment_item_id\": \"129900120\",\n \"merchant_sku\": \"15a1010\",\n \"response_shipment_sku_quantity\": 1,\n \"response_shipment_cancel_qty\": 1,\n \"RMA_number\": \"abcdef\",\n \"return_location\": {\n \"address1\": \"12 Location Street\",\n \"city\": \"Somewhere\",\n \"state\": \"NY\",\n \"zip_code\": \"12345\"\n }\n },\n {\n \"alt_shipment_item_id\": \"129900121\",\n \"merchant_sku\": \"15a1011\",\n \"response_shipment_cancel_qty\": 1\n }\n ]\n }\n ]\n}", "language": "json", "name": "Mixed Example" } ], "sidebar": true } [/block]
{"_id":"58c2d60f142bb22d0069c34d","githubsync":"","link_external":false,"link_url":"","order":4,"project":"562e25f2e01a430d00c2c91e","slug":"tag-order","type":"put","__v":0,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Overwriting Tags\",\n  \"body\": \"Only one tag can be applied to a given merchant order id at a time. Thus, if one tag is applied and then later overwritten, the order will retain only the most recent tag.\\n\\nTo clear a tag, simply send a blank object.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request Body\"\n}\n[/block]\nThe PUT tagging functionality allows a user to: apply to an order a string of the user's choice; group SKUs by a common string; and when combined with a GET request for orders by status and tag, manage which orders are returned. It is generally meant to be used to achieve pseudo-pagination. \n\nThe fields for the order tagged PUT call are outlined below:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"h-4\": \"Defined by\",\n    \"0-0\": \"**tag***\\n\\n*string*\",\n    \"0-1\": \"The tag the user wishes to apply to the order referenced in the URL.\",\n    \"0-3\": \"\",\n    \"0-4\": \"Merchant\",\n    \"0-2\": \"\",\n    \"1-0\": \"**alt_order_id**\\n\\n*string*\",\n    \"1-1\": \"Option merchant supplied order ID. Jet will map this ID to Jet's order_id and you can then use this ID in subsequent messages related to the order.\",\n    \"2-0\": \"**order_items***\\n\\n*order_items object array*\",\n    \"2-1\": \"This is an array of order items. Please see our order item array table below.\",\n    \"1-4\": \"Merchant\",\n    \"2-4\": \"Merchant\",\n    \"1-3\": \"\",\n    \"2-3\": \"\",\n    \"h-5\": \"Required\",\n    \"0-5\": \"Yes\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use Cases\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Example Request bodies for this endpoint:\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n\\t\\\"tag\\\": \\\"viewed\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Tagged Order\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","hidden":false,"next":{"pages":[],"description":""},"updates":[],"version":"56fd2bf327b4321900186ec6","excerpt":"","sync_unique":"","user":"562e25d24376430d006f1769","api":{"url":"/orders/{jet_defined_order_id}/tag","settings":"","results":{"codes":[{"status":204,"code":"","language":"json"},{"code":"{\n  \"errors\": [\n    \"order_item_id doesn't match: \\\"21b5a551d31541eea8f36f05385d2f90\\\"\"\n  ]\n}","language":"json","status":400}]},"method":"put","examples":{"codes":[]},"auth":"required","params":[{"ref":"","in":"path","required":false,"desc":"The Jet defined order ID","default":"","type":"string","name":"jet_defined_order_id","_id":"563a2e17f0c29b1700daafa6"}]},"category":"56fd2bf327b4321900186ecb","createdAt":"2017-03-10T16:36:31.708Z","isReference":false,"title":"Tag Order","parentDoc":null,"childrenPages":[]}

putTag Order


Path Params

jet_defined_order_id:
string
The Jet defined order ID
[block:callout] { "type": "warning", "title": "Overwriting Tags", "body": "Only one tag can be applied to a given merchant order id at a time. Thus, if one tag is applied and then later overwritten, the order will retain only the most recent tag.\n\nTo clear a tag, simply send a blank object." } [/block] [block:api-header] { "type": "basic", "title": "Request Body" } [/block] The PUT tagging functionality allows a user to: apply to an order a string of the user's choice; group SKUs by a common string; and when combined with a GET request for orders by status and tag, manage which orders are returned. It is generally meant to be used to achieve pseudo-pagination. The fields for the order tagged PUT call are outlined below: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "h-4": "Defined by", "0-0": "**tag***\n\n*string*", "0-1": "The tag the user wishes to apply to the order referenced in the URL.", "0-3": "", "0-4": "Merchant", "0-2": "", "1-0": "**alt_order_id**\n\n*string*", "1-1": "Option merchant supplied order ID. Jet will map this ID to Jet's order_id and you can then use this ID in subsequent messages related to the order.", "2-0": "**order_items***\n\n*order_items object array*", "2-1": "This is an array of order items. Please see our order item array table below.", "1-4": "Merchant", "2-4": "Merchant", "1-3": "", "2-3": "", "h-5": "Required", "0-5": "Yes" }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Example Request bodies for this endpoint:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n\t\"tag\": \"viewed\"\n}", "language": "json", "name": "Tagged Order" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


[block:callout] { "type": "warning", "title": "Overwriting Tags", "body": "Only one tag can be applied to a given merchant order id at a time. Thus, if one tag is applied and then later overwritten, the order will retain only the most recent tag.\n\nTo clear a tag, simply send a blank object." } [/block] [block:api-header] { "type": "basic", "title": "Request Body" } [/block] The PUT tagging functionality allows a user to: apply to an order a string of the user's choice; group SKUs by a common string; and when combined with a GET request for orders by status and tag, manage which orders are returned. It is generally meant to be used to achieve pseudo-pagination. The fields for the order tagged PUT call are outlined below: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "h-4": "Defined by", "0-0": "**tag***\n\n*string*", "0-1": "The tag the user wishes to apply to the order referenced in the URL.", "0-3": "", "0-4": "Merchant", "0-2": "", "1-0": "**alt_order_id**\n\n*string*", "1-1": "Option merchant supplied order ID. Jet will map this ID to Jet's order_id and you can then use this ID in subsequent messages related to the order.", "2-0": "**order_items***\n\n*order_items object array*", "2-1": "This is an array of order items. Please see our order item array table below.", "1-4": "Merchant", "2-4": "Merchant", "1-3": "", "2-3": "", "h-5": "Required", "0-5": "Yes" }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Example Request bodies for this endpoint:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n\t\"tag\": \"viewed\"\n}", "language": "json", "name": "Tagged Order" } ], "sidebar": true } [/block]
{"_id":"58c2da83258e5a1900b60a14","hidden":false,"body":"[block:api-header]\n{\n  \"title\": \"URL Parameter: {status}\"\n}\n[/block]\nThe PUT tagging functionality allows a user to: apply to an order a string of the user's choice; group SKUs by a common string; and when combined with a GET request for orders by status and tag, manage which orders are returned. It is generally meant to be used to achieve pseudo-pagination. \n\nUsing this endpoint you can access the first 1000 orders in a certain status. \n\nThe {status} can be any of the following:\n  * 'created' - The order has just been placed.  Jet.com allows a half hour for fraud check and customer cancellation.  We ask that retailers NOT fulfill orders that are created.\n  * 'ready' - The order is ready to be fulfilled by the retailer\n  * 'acknowledged' - The order has been accepted by the retailer and is awaiting fulfillment\n  * 'inprogress' - The order is partially shipped\n  * 'complete' - The order is completely shipped or cancelled.  All units have been accounted for\n\nStarting on April 10, 2017, orders will only be available by status for 90 days after order creation.\n[block:api-header]\n{\n  \"title\": \"URL Parameter: {tag}\"\n}\n[/block]\nThe {tag} can be any string that has previously been set as the tag for an order.\n[block:api-header]\n{\n  \"title\": \"URL Parameter: {true/false}\"\n}\n[/block]\nWhen set to true, the response will include any orders that bear the {tag}. When set to false, the response will include any orders that do not bear the {tag}. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body\"\n}\n[/block]\nThe response fields for the order tagged GET call are outlined below:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\",\n    \"h-4\": \"Defined by\",\n    \"0-0\": \"**order_urls***\\n\\n*string array*\",\n    \"0-1\": \"The URL links associated with orders in the status polled\",\n    \"0-3\": \"\",\n    \"0-4\": \"Merchant\",\n    \"0-2\": \"\",\n    \"1-0\": \"**alt_order_id**\\n\\n*string*\",\n    \"1-1\": \"Option merchant supplied order ID. Jet will map this ID to Jet's order_id and you can then use this ID in subsequent messages related to the order.\",\n    \"2-0\": \"**order_items***\\n\\n*order_items object array*\",\n    \"2-1\": \"This is an array of order items. Please see our order item array table below.\",\n    \"1-4\": \"Merchant\",\n    \"2-4\": \"Merchant\",\n    \"1-3\": \"\",\n    \"2-3\": \"\",\n    \"h-5\": \"Required\",\n    \"0-5\": \"Yes\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\nExample Request bodies for this endpoint:","category":"56fd2bf327b4321900186ecb","api":{"examples":{"codes":[]},"method":"get","params":[{"in":"path","name":"status","ref":"","required":false,"type":"string","_id":"563a2e17f0c29b1700daafa6","default":"","desc":"The current status of merchant orders"},{"type":"string","name":"tag","_id":"58c2de7a42641e0f00fa43dc","ref":"","in":"path","required":false,"desc":"A tag that has previously been applied to one or more orders","default":""},{"desc":"Indication of whether results with the {tag} or without the {tag} should be returned","default":"","type":"string","name":"true/false","_id":"58c2de7a42641e0f00fa43db","ref":"","in":"path","required":false}],"results":{"codes":[{"language":"json","code":"{ \n  \"order_urls\": [\n    \"/orders/withoutShipmentDetail/57e542a613fa42d8b6e8362dbd5911f5\",\n    \"/orders/withoutShipmentDetail/a10b4b28467c490984e0b387e1cc2d9a\",\n    \"/orders/withoutShipmentDetail/32c05c3230fc498e95f82129efd10213\"\n  ]\n}","status":200},{"status":200,"language":"json","code":"{ \n  \"order_urls\": [] // when there are no orders with this status and tag\n}\n"}]},"settings":"","url":"/orders/{status}/{tag}/{true/false}","auth":"required"},"excerpt":"","next":{"description":"","pages":[]},"sync_unique":"","title":"Check for Tagged Orders","updates":[],"__v":1,"user":"562e25d24376430d006f1769","type":"get","project":"562e25f2e01a430d00c2c91e","slug":"check-for-tagged-orders","isReference":false,"link_external":false,"link_url":"","order":5,"version":"56fd2bf327b4321900186ec6","createdAt":"2017-03-10T16:55:31.762Z","githubsync":"","parentDoc":null,"childrenPages":[]}

getCheck for Tagged Orders


Path Params

status:
string
The current status of merchant orders
tag:
string
A tag that has previously been applied to one or more orders
true:
string
Indication of whether results with the {tag} or without the {tag} should be returned
[block:api-header] { "title": "URL Parameter: {status}" } [/block] The PUT tagging functionality allows a user to: apply to an order a string of the user's choice; group SKUs by a common string; and when combined with a GET request for orders by status and tag, manage which orders are returned. It is generally meant to be used to achieve pseudo-pagination. Using this endpoint you can access the first 1000 orders in a certain status. The {status} can be any of the following: * 'created' - The order has just been placed. Jet.com allows a half hour for fraud check and customer cancellation. We ask that retailers NOT fulfill orders that are created. * 'ready' - The order is ready to be fulfilled by the retailer * 'acknowledged' - The order has been accepted by the retailer and is awaiting fulfillment * 'inprogress' - The order is partially shipped * 'complete' - The order is completely shipped or cancelled. All units have been accounted for Starting on April 10, 2017, orders will only be available by status for 90 days after order creation. [block:api-header] { "title": "URL Parameter: {tag}" } [/block] The {tag} can be any string that has previously been set as the tag for an order. [block:api-header] { "title": "URL Parameter: {true/false}" } [/block] When set to true, the response will include any orders that bear the {tag}. When set to false, the response will include any orders that do not bear the {tag}. [block:api-header] { "type": "basic", "title": "Response Body" } [/block] The response fields for the order tagged GET call are outlined below: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "h-4": "Defined by", "0-0": "**order_urls***\n\n*string array*", "0-1": "The URL links associated with orders in the status polled", "0-3": "", "0-4": "Merchant", "0-2": "", "1-0": "**alt_order_id**\n\n*string*", "1-1": "Option merchant supplied order ID. Jet will map this ID to Jet's order_id and you can then use this ID in subsequent messages related to the order.", "2-0": "**order_items***\n\n*order_items object array*", "2-1": "This is an array of order items. Please see our order item array table below.", "1-4": "Merchant", "2-4": "Merchant", "1-3": "", "2-3": "", "h-5": "Required", "0-5": "Yes" }, "cols": 3, "rows": 1 } [/block] Example Request bodies for this endpoint:

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "title": "URL Parameter: {status}" } [/block] The PUT tagging functionality allows a user to: apply to an order a string of the user's choice; group SKUs by a common string; and when combined with a GET request for orders by status and tag, manage which orders are returned. It is generally meant to be used to achieve pseudo-pagination. Using this endpoint you can access the first 1000 orders in a certain status. The {status} can be any of the following: * 'created' - The order has just been placed. Jet.com allows a half hour for fraud check and customer cancellation. We ask that retailers NOT fulfill orders that are created. * 'ready' - The order is ready to be fulfilled by the retailer * 'acknowledged' - The order has been accepted by the retailer and is awaiting fulfillment * 'inprogress' - The order is partially shipped * 'complete' - The order is completely shipped or cancelled. All units have been accounted for Starting on April 10, 2017, orders will only be available by status for 90 days after order creation. [block:api-header] { "title": "URL Parameter: {tag}" } [/block] The {tag} can be any string that has previously been set as the tag for an order. [block:api-header] { "title": "URL Parameter: {true/false}" } [/block] When set to true, the response will include any orders that bear the {tag}. When set to false, the response will include any orders that do not bear the {tag}. [block:api-header] { "type": "basic", "title": "Response Body" } [/block] The response fields for the order tagged GET call are outlined below: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description", "h-4": "Defined by", "0-0": "**order_urls***\n\n*string array*", "0-1": "The URL links associated with orders in the status polled", "0-3": "", "0-4": "Merchant", "0-2": "", "1-0": "**alt_order_id**\n\n*string*", "1-1": "Option merchant supplied order ID. Jet will map this ID to Jet's order_id and you can then use this ID in subsequent messages related to the order.", "2-0": "**order_items***\n\n*order_items object array*", "2-1": "This is an array of order items. Please see our order item array table below.", "1-4": "Merchant", "2-4": "Merchant", "1-3": "", "2-3": "", "h-5": "Required", "0-5": "Yes" }, "cols": 3, "rows": 1 } [/block] Example Request bodies for this endpoint:
{"_id":"56fd2bf327b4321900186ef3","sync_unique":"","title":"Check for Returns","type":"get","editedParams":true,"category":"56fd2bf327b4321900186ecc","createdAt":"2015-11-02T19:54:08.091Z","excerpt":"","hidden":false,"link_url":"","slug":"check-for-returns","updates":[],"user":"562e25d24376430d006f1769","editedParams2":true,"order":0,"project":"562e25f2e01a430d00c2c91e","version":"56fd2bf327b4321900186ec6","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"URL Parameter: {status}\"\n}\n[/block]\nTo check for returns you will the utilize the Get Returns method. Please replace {status} with one of the following values:\n\n  * created\n  * *acknowledge* - no longer in use\n  * inprogress\n  * completed by merchant\n\nThis will return a list of returns in that status.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body\"\n}\n[/block]\nThe following field is included in the response body\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**return_urls***\\n\\n*string array*\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-1\": \"The URL links associated with returns in the status polled\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\\* denotes that the field will always be returned in the response","api":{"params":[{"ref":"","required":false,"desc":"The status for a return","default":"","type":"string","name":"status","in":"path","_id":"5637bf60c75f5d0d00ec5e2d"}],"results":{"codes":[{"language":"json","status":200,"code":"{\n  \"return_urls\": [\n    \"/return/state/57e542a613fa42d8b6e8362dbd5911f5\",\n    \"/return/state/a10b4b28467c490984e0b387e1cc2d9a\",\n    \"/return/state/32c05c3230fc498e95f82129efd10213\"\n  ]\n}"},{"status":200,"language":"json","code":"{\n  \"return_urls\": []\n}"}]},"settings":"","url":"/returns/{status}","auth":"required","examples":{"codes":[{"code":"","language":"json"}]},"method":"get"},"githubsync":"","isReference":false,"link_external":false,"parentDoc":null,"__v":0,"childrenPages":[]}

getCheck for Returns


Path Params

status:
string
The status for a return
[block:api-header] { "type": "basic", "title": "URL Parameter: {status}" } [/block] To check for returns you will the utilize the Get Returns method. Please replace {status} with one of the following values: * created * *acknowledge* - no longer in use * inprogress * completed by merchant This will return a list of returns in that status. [block:api-header] { "type": "basic", "title": "Response Body" } [/block] The following field is included in the response body [block:parameters] { "data": { "0-0": "**return_urls***\n\n*string array*", "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-1": "The URL links associated with returns in the status polled" }, "cols": 3, "rows": 1 } [/block] \* denotes that the field will always be returned in the response

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "URL Parameter: {status}" } [/block] To check for returns you will the utilize the Get Returns method. Please replace {status} with one of the following values: * created * *acknowledge* - no longer in use * inprogress * completed by merchant This will return a list of returns in that status. [block:api-header] { "type": "basic", "title": "Response Body" } [/block] The following field is included in the response body [block:parameters] { "data": { "0-0": "**return_urls***\n\n*string array*", "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-1": "The URL links associated with returns in the status polled" }, "cols": 3, "rows": 1 } [/block] \* denotes that the field will always be returned in the response
{"_id":"56fd2bf327b4321900186ef4","hidden":false,"isReference":false,"link_external":false,"order":1,"__v":1,"body":"To check for a specific return you will the utilize the Get Returns Info method. Please replace {jet_return_id} with the return id.\n\nThis will return a list of values within that return.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body: Return \\\"Created\\\"\"\n}\n[/block]\nThe following fields are returned when an item is \"created\"\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**agree_to_return_charge** \\n\\n*boolean*\",\n    \"1-0\": \"**alt_order_id** \\n\\n*string*\",\n    \"2-0\": \"**alt_return_authorization_id** \\n\\n*string*\",\n    \"3-0\": \"**merchant_order_id** \\n\\n*string*\",\n    \"4-0\": \"**merchant_return_authorization_id** \\n\\n*string*\",\n    \"5-0\": \"**merchant_return_charge** \\n\\n*float*\",\n    \"6-0\": \"**reference_order_id** \\n\\n*string*\",\n    \"7-0\": \"**reference_return_authorization_id** \\n\\n*string*\",\n    \"8-0\": \"**refund_without_return** \\n\\n*boolean*\",\n    \"9-0\": \"**return_date** \\n\\n*string*\",\n    \"10-0\": \"**return_status** \\n\\n*string*\",\n    \"11-0\": \"**shipping_carrier** \\n\\n*string*\",\n    \"12-0\": \"**tracking_number** \\n\\n*string*\",\n    \"13-0\": \"**return_location** \\n\\n*object array*\",\n    \"14-0\": \"**return_merchant_SKUs** \\n\\n*return_merchant_SKUs object array*\",\n    \"4-2\": \"\",\n    \"7-2\": \"\",\n    \"8-2\": \"\",\n    \"10-1\": \"Current status of the return.\",\n    \"8-1\": \"If this is true, Jet has deemed that this item should not be returned, but the customer still should be refunded.\",\n    \"7-1\": \"Jet's human readable return authorization number that may have a small chance of collision overtime\",\n    \"4-1\": \"Jet generated return authorization ID that is used in URL\",\n    \"3-1\": \"Jet's unique ID for a given merchant order\",\n    \"6-1\": \"Jet's human readable order ID number that may have a small chance of collision overtime\",\n    \"1-1\": \"Optional merchant supplied order ID that should have been established in OrderAcknowledgement in order to use in this message.\",\n    \"1-2\": \"Will be provided if seller provided value on original order\",\n    \"9-1\": \"The date that the customer requested a return authorization.\",\n    \"9-2\": \"The UTC time as follows 'yyyy'-'MM'-'dd'T'HH':'mm':'ss'.'fffffff''Z' for example 5PM eastern daylight time on Jan 1st 2015 would be '2015-01-01T21:00:00.0000000Z'\",\n    \"11-1\": \"Shipping method used for the given return shipment.\",\n    \"11-2\": \"This will be populated with the carrier Jet has chosen if Jet is paying for the return shipping label.If the merchant pays for the return shipping label, the carrier that merchant uses for returns will be populated.\",\n    \"12-1\": \"Tracking number for the given return shipment\",\n    \"12-2\": \"This will be populated with the tracking number of the return shipment\",\n    \"5-1\": \"The charge that the merchant is required to pay Jet for the return.\",\n    \"5-2\": \"This is populated with the charge that a merchant will pay Jet for a customer return\",\n    \"2-1\": \"This field is set by return complete message. Optional merchant supplied return number, allows the merchant to use this number in future messages instead of return_authorization_id. This ID will be included on the Return Documentation that Jet gives to the customer.\",\n    \"0-1\": \"This field set by order refund message. Specifies if the merchant agrees to the return charge for the return notification.\\n\\nPossible Values:\\n* 'false' - The merchant disagrees with the return charge and will enter a disputed charge with Jet.com\\n* 'true' - The merchant agrees to wholly pay the return charge to Jet.com from the return notification\",\n    \"0-2\": \"\"\n  },\n  \"cols\": 3,\n  \"rows\": 15\n}\n[/block]\n**return_merchant_SKUs object** -  The following fields are a part of the return\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**order_item_id** \\n\\n*string*\",\n    \"1-0\": \"**alt_order_item_id** \\n\\n*string*\",\n    \"2-0\": \"**merchant_sku** \\n\\n*string*\",\n    \"3-0\": \"**merchant_sku_title** \\n\\n*string*\",\n    \"4-0\": \"**reason**\\n\\n*string*\",\n    \"0-1\": \"Jet's unique identifier for an item in a merchant order.\",\n    \"1-1\": \"If an alt_order_item_id has been associated with the order_item_id via the order accept message, this may be passed instead of the order_item_id field.\",\n    \"2-1\": \"The merchant SKU that is being returned\",\n    \"3-1\": \"The short description of the merchant SKU being returned\",\n    \"4-1\": \"The reason the customer is returning the item\",\n    \"4-2\": \"Must be one of the following values:\\n  * No longer want this item\\n  * Received the wrong item\\n  * Website description is inaccurate\\n  * Product is defective / does not work\\n  * Item arrived damaged - box intact\\n  * Item arrived damaged - box damaged\\n  * Package never arrived\\n  * Wrong quantity received\\n  * Better price found elsewhere\\n  * Unauthorized purchase\\n  * Item is missing parts / accessories\\n  * Item is refurbished\\n  * Item is expired\\n  * Item does not fit\",\n    \"5-0\": \"**return_quantity** \\n\\n*integer*\",\n    \"5-1\": \"THe quantity of the merchant SKU that is being returned\",\n    \"6-0\": \"**requested_refund_amount** \\n\\n*object*\",\n    \"6-1\": \"The amount the retailer is willing to refund to the customer\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\n**requested_refund_amount object**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**principal** \\n\\n*float*\",\n    \"1-0\": \"**tax** \\n\\n*float*\",\n    \"2-0\": \"**shipping_cost** \\n\\n*float*\",\n    \"3-0\": \"**shipping_tax** \\n\\n*float*\",\n    \"0-1\": \"Amount to be refunded for the given item in USD associated with the item itself. \\n\\nThis should be the *total cost* for this item not the unit cost.\",\n    \"1-1\": \"Amount to be refunded for the given item in USD associated with tax that was charged for the item.\",\n    \"3-1\": \"Amount to be refunded for the given item in USD associated with the tax that was charged on shipping\",\n    \"2-1\": \"Amount to be refunded for the given item in USD associated with the shipping cost that was allocated to this item.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body: Return \\\"Inprogress\\\" or \\\"Completed by Merchant\\\"\"\n}\n[/block]\nThe following fields are added to the message if a return is either \"inprogress\" or \"completed by merchant\"\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**items** \\n\\n*items object array*\",\n    \"0-1\": \"The items that were returned\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n**items object** - The following fields are part of an items object\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**order_item_id** \\n\\n*string*\",\n    \"1-0\": \"**alt_order_item_id** \\n\\n*string*\",\n    \"2-0\": \"**total_quantity_returned** \\n\\n*integer*\",\n    \"3-0\": \"**order_return_refund_qty** \\n\\n*integer*\",\n    \"4-0\": \"**return_refund_feedback**\\n\\n*string*\",\n    \"0-1\": \"Jet's unique identifier for an item in a merchant order.\",\n    \"1-1\": \"If an alt_order_item_id has been associated with the order_item_id via the order accept message, this may be passed instead of the order_item_id field.\",\n    \"2-1\": \"Quantity of the given item that was returned.\",\n    \"3-1\": \"Quantity of the given item that was refunded.\",\n    \"4-1\": \"The reason this refund is less than the full amount.\",\n    \"4-2\": \"Must be one of the following values:\\n* other\\n* item damaged\\n* not shipped in original packaging\\n* customer opened item\\n\\nRequired if total refund_amount < requested_refund_amount\",\n    \"5-0\": \"**notes** \\n\\n*string*\",\n    \"5-1\": \"Provide additional information about why the item was refunded for lower than the full amount.\",\n    \"6-0\": \"**refund_amount** \\n\\n*object*\",\n    \"6-1\": \"The amount the retailer is willing to refund to the customer\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\n**refund_amount object**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**principal** \\n\\n*float*\",\n    \"1-0\": \"**tax** \\n\\n*float*\",\n    \"2-0\": \"**shipping_cost** \\n\\n*float*\",\n    \"3-0\": \"**shipping_tax** \\n\\n*float*\",\n    \"0-1\": \"Amount to be refunded for the given item in USD associated with the item itself. This should be the total cost for this item not the unit cost.\",\n    \"1-1\": \"Amount to be refunded for the given item in USD associated with tax that was charged for the item.\",\n    \"3-1\": \"Amount to be refunded for the given item in USD associated with the tax that was charged on shipping\",\n    \"2-1\": \"Amount to be refunded for the given item in USD associated with the shipping cost that was allocated to this item.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"sidebar\": true,\n  \"title\": \"Use Cases\"\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Here are sample response bodies depending on the status of the return\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"return_status\\\": \\\"created\\\",\\n  \\\"refund_without_return\\\": false,\\n  \\\"merchant_return_authorization_id\\\": \\\"53df71b3015640a9b50f481e8c1ce295\\\",\\n  \\\"reference_return_authorization_id\\\": \\\"95GCL0CMHRN75LKOP16Q38Q3AB\\\",\\n  \\\"merchant_order_id\\\": \\\"a2f8a71e95014bb5be5dd827fc0f4cb0\\\",\\n  \\\"return_date\\\": \\\"2015-11-18T18:06:16.5744353Z\\\",\\n  \\\"return_merchant_SKUs\\\": [\\n    {\\n      \\\"order_item_id\\\": \\\"2627ec0e81d0445ca578359d3f102c11\\\",\\n      \\\"alt_order_item_id\\\": \\\"76-i105\\\",\\n      \\\"return_quantity\\\": 8,\\n      \\\"merchant_sku\\\": \\\"123567890333\\\",\\n      \\\"reason\\\": \\\"item is defective/does not work properly\\\",\\n      \\\"requested_refund_amount\\\": {\\n        \\\"principal\\\": 29.99,\\n        \\\"tax\\\": null,\\n        \\\"shipping_cost\\\": 0,\\n        \\\"shipping_tax\\\": null\\n      }\\n    }\\n  ],\\n  \\\"shipping_carrier\\\": \\\"USPS\\\",\\n  \\\"tracking_number\\\": \\\"1Z23W4561233457824\\\",\\n  \\\"merchant_return_charge\\\": 6.02,\\n  \\\"reference_order_id\\\": \\\"405385037126\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"'Created' Return\"\n    },\n    {\n      \"code\": \"{\\n  \\\"agree_to_return_charge\\\": true,\\n  \\\"alt_order_id\\\": \\\"12345678\\\",\\n  \\\"items\\\": [\\n    {\\n      \\\"order_item_id\\\": \\\"2627ec0e81d0445ca578359d3f102c11\\\",\\n      \\\"alt_order_item_id\\\": \\\"A1223456\\\",\\n      \\\"total_quantity_returned\\\": 1,\\n      \\\"order_return_refund_qty\\\": 1,\\n      \\\"return_refund_feedback\\\": \\\"customer opened item\\\",\\n      \\\"refund_amount\\\": {\\n        \\\"principal\\\": 29.99,\\n        \\\"tax\\\": 0,\\n        \\\"shipping_cost\\\": 0,\\n        \\\"shipping_tax\\\": 0\\n      }\\n    }\\n  ],\\n  \\\"merchant_order_id\\\": \\\"a2f8a71e95014bb5be5dd827fc0f4cb0\\\",\\n  \\\"merchant_return_authorization_id\\\": \\\"53df71b3015640a9b50f481e8c1ce295\\\",\\n  \\\"merchant_return_charge\\\": 6.02,\\n  \\\"reference_order_id\\\": \\\"405385037126\\\",\\n  \\\"reference_return_authorization_id\\\": \\\"95GCL0CMHRN75LKOP16Q38Q3AB\\\",\\n  \\\"refund_without_return\\\": false,\\n  \\\"return_date\\\": \\\"2015-11-18T18:06:16.5744353Z\\\",\\n  \\\"return_merchant_SKUs\\\": [\\n    {\\n      \\\"order_item_id\\\": \\\"2627ec0e81d0445ca578359d3f102c11\\\",\\n      \\\"alt_order_item_id\\\": \\\"76-i105\\\",\\n      \\\"return_quantity\\\": 8,\\n      \\\"merchant_sku\\\": \\\"123567890333\\\",\\n      \\\"reason\\\": \\\"item is defective/does not work properly\\\",\\n      \\\"requested_refund_amount\\\": {\\n        \\\"principal\\\": 29.99,\\n        \\\"tax\\\": null,\\n        \\\"shipping_cost\\\": 0,\\n        \\\"shipping_tax\\\": null\\n      }\\n    }\\n  ],\\n  \\\"return_status\\\": \\\"inprogress\\\",\\n  \\\"shipping_carrier\\\": \\\"USPS\\\",\\n  \\\"tracking_number\\\": \\\"1Z23W4561233457824\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"'Inprogress' Return\"\n    },\n    {\n      \"code\": \"{\\n  \\\"agree_to_return_charge\\\": true,\\n  \\\"alt_order_id\\\": \\\"12345678\\\",\\n  \\\"completed_date\\\": \\\"2016-01-23T19:07:09Z\\\",\\n  \\\"items\\\": [\\n    {\\n      \\\"order_item_id\\\": \\\"2627ec0e81d0445ca578359d3f102c11\\\",\\n      \\\"alt_order_item_id\\\": \\\"A1223456\\\",\\n      \\\"total_quantity_returned\\\": 8,\\n      \\\"order_return_refund_qty\\\": 8,\\n      \\\"return_refund_feedback\\\": \\\"customer opened item\\\",\\n      \\\"refund_amount\\\": {\\n        \\\"principal\\\": 59.98,\\n        \\\"tax\\\": 0,\\n        \\\"shipping_cost\\\": 0,\\n        \\\"shipping_tax\\\": 0\\n      }\\n    }\\n  ],\\n  \\\"merchant_order_id\\\": \\\"a2f8a71e95014bb5be5dd827fc0f4cb0\\\",\\n  \\\"merchant_return_authorization_id\\\": \\\"53df71b3015640a9b50f481e8c1ce295\\\",\\n  \\\"merchant_return_charge\\\": 6.02,\\n  \\\"reference_order_id\\\": \\\"405385037126\\\",\\n  \\\"reference_return_authorization_id\\\": \\\"95GCL0CMHRN75LKOP16Q38Q3AB\\\",\\n  \\\"refund_without_return\\\": false,\\n  \\\"return_date\\\": \\\"2015-11-18T18:06:16.5744353Z\\\",\\n  \\\"return_merchant_SKUs\\\": [\\n    {\\n      \\\"order_item_id\\\": \\\"2627ec0e81d0445ca578359d3f102c11\\\",\\n      \\\"alt_order_item_id\\\": \\\"76-i105\\\",\\n      \\\"return_quantity\\\": 8,\\n      \\\"merchant_sku\\\": \\\"123567890333\\\",\\n      \\\"reason\\\": \\\"item is defective/does not work properly\\\",\\n      \\\"requested_refund_amount\\\": {\\n        \\\"principal\\\": 29.99,\\n        \\\"tax\\\": null,\\n        \\\"shipping_cost\\\": 0,\\n        \\\"shipping_tax\\\": null\\n      }\\n    }\\n  ],\\n  \\\"return_status\\\": \\\"completed by merchant\\\",\\n  \\\"shipping_carrier\\\": \\\"USPS\\\",\\n  \\\"tracking_number\\\": \\\"1Z23W4561233457824\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"'Complete' Return\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","createdAt":"2015-11-02T19:56:03.330Z","parentDoc":null,"type":"get","link_url":"","project":"562e25f2e01a430d00c2c91e","slug":"check-return-info","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","updates":[],"user":"562e25d24376430d006f1769","title":"Check Return Detail","version":"56fd2bf327b4321900186ec6","api":{"examples":{"codes":[]},"method":"get","params":[{"desc":"The Jet defined Return ID","default":"","type":"string","name":"jet_defined_return_id","in":"query","_id":"5637bfd34dbdd919001b2780","ref":"","required":false}],"results":{"codes":[{"name":"","code":"{\n  \"merchant_return_authorization_id\": \"5462a44553734370b7ec90ee320f6eca\",\n  \"reference_return_authorization_id\": \"123456789012-01\",\n  \"return_status\": \"created\",\n  \"refund_without_return\": false,\n  \"merchant_order_id\": \"9b13bdd68c314d1b9c8b93277dea4da1\",\n  \"reference_order_id\": \"123456789012\",\n  \"alt_order_id\": \"12345678\",\n  \"return_date\": \"2014-11-01T21:19:00Z\",\n  \"return_merchant_SKUs\": [\n    {\n      \"order_item_id\": \"ac62a44553734370b7ec90ee320f6eca\",\n      \"alt_order_item_id\": \"A1223456\",\n      \"merchant_sku\": \"AB12345\",\n      \"merchant_sku_title\": \"red bottle\",\n      \"return_quantity\": 1,\n      \"reason\": \"no longer need/want\",\n      \"requested_refund_amount\": {\n        \"principal\": 20.0,\n        \"tax\": 1.4,\n        \"shipping_cost\": 1.0,\n        \"shipping_tax\": 0.07\n      }\n    }\n  ],\n  \"shipping_carrier\": \"UPS\",\n  \"tracking_number\": \"1Z23W456123345890\",\n  \"merchant_return_charge\": 5.0\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","url":"/returns/state/{jet__defined_return_id}","auth":"required"},"category":"56fd2bf327b4321900186ecc","next":{"description":"","pages":[]},"sync_unique":"","childrenPages":[]}

getCheck Return Detail


Query Params

jet_defined_return_id:
string
The Jet defined Return ID
To check for a specific return you will the utilize the Get Returns Info method. Please replace {jet_return_id} with the return id. This will return a list of values within that return. [block:api-header] { "type": "basic", "title": "Response Body: Return \"Created\"" } [/block] The following fields are returned when an item is "created" [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**agree_to_return_charge** \n\n*boolean*", "1-0": "**alt_order_id** \n\n*string*", "2-0": "**alt_return_authorization_id** \n\n*string*", "3-0": "**merchant_order_id** \n\n*string*", "4-0": "**merchant_return_authorization_id** \n\n*string*", "5-0": "**merchant_return_charge** \n\n*float*", "6-0": "**reference_order_id** \n\n*string*", "7-0": "**reference_return_authorization_id** \n\n*string*", "8-0": "**refund_without_return** \n\n*boolean*", "9-0": "**return_date** \n\n*string*", "10-0": "**return_status** \n\n*string*", "11-0": "**shipping_carrier** \n\n*string*", "12-0": "**tracking_number** \n\n*string*", "13-0": "**return_location** \n\n*object array*", "14-0": "**return_merchant_SKUs** \n\n*return_merchant_SKUs object array*", "4-2": "", "7-2": "", "8-2": "", "10-1": "Current status of the return.", "8-1": "If this is true, Jet has deemed that this item should not be returned, but the customer still should be refunded.", "7-1": "Jet's human readable return authorization number that may have a small chance of collision overtime", "4-1": "Jet generated return authorization ID that is used in URL", "3-1": "Jet's unique ID for a given merchant order", "6-1": "Jet's human readable order ID number that may have a small chance of collision overtime", "1-1": "Optional merchant supplied order ID that should have been established in OrderAcknowledgement in order to use in this message.", "1-2": "Will be provided if seller provided value on original order", "9-1": "The date that the customer requested a return authorization.", "9-2": "The UTC time as follows 'yyyy'-'MM'-'dd'T'HH':'mm':'ss'.'fffffff''Z' for example 5PM eastern daylight time on Jan 1st 2015 would be '2015-01-01T21:00:00.0000000Z'", "11-1": "Shipping method used for the given return shipment.", "11-2": "This will be populated with the carrier Jet has chosen if Jet is paying for the return shipping label.If the merchant pays for the return shipping label, the carrier that merchant uses for returns will be populated.", "12-1": "Tracking number for the given return shipment", "12-2": "This will be populated with the tracking number of the return shipment", "5-1": "The charge that the merchant is required to pay Jet for the return.", "5-2": "This is populated with the charge that a merchant will pay Jet for a customer return", "2-1": "This field is set by return complete message. Optional merchant supplied return number, allows the merchant to use this number in future messages instead of return_authorization_id. This ID will be included on the Return Documentation that Jet gives to the customer.", "0-1": "This field set by order refund message. Specifies if the merchant agrees to the return charge for the return notification.\n\nPossible Values:\n* 'false' - The merchant disagrees with the return charge and will enter a disputed charge with Jet.com\n* 'true' - The merchant agrees to wholly pay the return charge to Jet.com from the return notification", "0-2": "" }, "cols": 3, "rows": 15 } [/block] **return_merchant_SKUs object** - The following fields are a part of the return [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**order_item_id** \n\n*string*", "1-0": "**alt_order_item_id** \n\n*string*", "2-0": "**merchant_sku** \n\n*string*", "3-0": "**merchant_sku_title** \n\n*string*", "4-0": "**reason**\n\n*string*", "0-1": "Jet's unique identifier for an item in a merchant order.", "1-1": "If an alt_order_item_id has been associated with the order_item_id via the order accept message, this may be passed instead of the order_item_id field.", "2-1": "The merchant SKU that is being returned", "3-1": "The short description of the merchant SKU being returned", "4-1": "The reason the customer is returning the item", "4-2": "Must be one of the following values:\n * No longer want this item\n * Received the wrong item\n * Website description is inaccurate\n * Product is defective / does not work\n * Item arrived damaged - box intact\n * Item arrived damaged - box damaged\n * Package never arrived\n * Wrong quantity received\n * Better price found elsewhere\n * Unauthorized purchase\n * Item is missing parts / accessories\n * Item is refurbished\n * Item is expired\n * Item does not fit", "5-0": "**return_quantity** \n\n*integer*", "5-1": "THe quantity of the merchant SKU that is being returned", "6-0": "**requested_refund_amount** \n\n*object*", "6-1": "The amount the retailer is willing to refund to the customer" }, "cols": 3, "rows": 7 } [/block] **requested_refund_amount object** [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**principal** \n\n*float*", "1-0": "**tax** \n\n*float*", "2-0": "**shipping_cost** \n\n*float*", "3-0": "**shipping_tax** \n\n*float*", "0-1": "Amount to be refunded for the given item in USD associated with the item itself. \n\nThis should be the *total cost* for this item not the unit cost.", "1-1": "Amount to be refunded for the given item in USD associated with tax that was charged for the item.", "3-1": "Amount to be refunded for the given item in USD associated with the tax that was charged on shipping", "2-1": "Amount to be refunded for the given item in USD associated with the shipping cost that was allocated to this item." }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "Response Body: Return \"Inprogress\" or \"Completed by Merchant\"" } [/block] The following fields are added to the message if a return is either "inprogress" or "completed by merchant" [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**items** \n\n*items object array*", "0-1": "The items that were returned" }, "cols": 3, "rows": 1 } [/block] **items object** - The following fields are part of an items object [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**order_item_id** \n\n*string*", "1-0": "**alt_order_item_id** \n\n*string*", "2-0": "**total_quantity_returned** \n\n*integer*", "3-0": "**order_return_refund_qty** \n\n*integer*", "4-0": "**return_refund_feedback**\n\n*string*", "0-1": "Jet's unique identifier for an item in a merchant order.", "1-1": "If an alt_order_item_id has been associated with the order_item_id via the order accept message, this may be passed instead of the order_item_id field.", "2-1": "Quantity of the given item that was returned.", "3-1": "Quantity of the given item that was refunded.", "4-1": "The reason this refund is less than the full amount.", "4-2": "Must be one of the following values:\n* other\n* item damaged\n* not shipped in original packaging\n* customer opened item\n\nRequired if total refund_amount < requested_refund_amount", "5-0": "**notes** \n\n*string*", "5-1": "Provide additional information about why the item was refunded for lower than the full amount.", "6-0": "**refund_amount** \n\n*object*", "6-1": "The amount the retailer is willing to refund to the customer" }, "cols": 3, "rows": 7 } [/block] **refund_amount object** [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**principal** \n\n*float*", "1-0": "**tax** \n\n*float*", "2-0": "**shipping_cost** \n\n*float*", "3-0": "**shipping_tax** \n\n*float*", "0-1": "Amount to be refunded for the given item in USD associated with the item itself. This should be the total cost for this item not the unit cost.", "1-1": "Amount to be refunded for the given item in USD associated with tax that was charged for the item.", "3-1": "Amount to be refunded for the given item in USD associated with the tax that was charged on shipping", "2-1": "Amount to be refunded for the given item in USD associated with the shipping cost that was allocated to this item." }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "sidebar": true, "title": "Use Cases" } [/block] [block:textarea] { "text": "Here are sample response bodies depending on the status of the return", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"return_status\": \"created\",\n \"refund_without_return\": false,\n \"merchant_return_authorization_id\": \"53df71b3015640a9b50f481e8c1ce295\",\n \"reference_return_authorization_id\": \"95GCL0CMHRN75LKOP16Q38Q3AB\",\n \"merchant_order_id\": \"a2f8a71e95014bb5be5dd827fc0f4cb0\",\n \"return_date\": \"2015-11-18T18:06:16.5744353Z\",\n \"return_merchant_SKUs\": [\n {\n \"order_item_id\": \"2627ec0e81d0445ca578359d3f102c11\",\n \"alt_order_item_id\": \"76-i105\",\n \"return_quantity\": 8,\n \"merchant_sku\": \"123567890333\",\n \"reason\": \"item is defective/does not work properly\",\n \"requested_refund_amount\": {\n \"principal\": 29.99,\n \"tax\": null,\n \"shipping_cost\": 0,\n \"shipping_tax\": null\n }\n }\n ],\n \"shipping_carrier\": \"USPS\",\n \"tracking_number\": \"1Z23W4561233457824\",\n \"merchant_return_charge\": 6.02,\n \"reference_order_id\": \"405385037126\"\n}", "language": "json", "name": "'Created' Return" }, { "code": "{\n \"agree_to_return_charge\": true,\n \"alt_order_id\": \"12345678\",\n \"items\": [\n {\n \"order_item_id\": \"2627ec0e81d0445ca578359d3f102c11\",\n \"alt_order_item_id\": \"A1223456\",\n \"total_quantity_returned\": 1,\n \"order_return_refund_qty\": 1,\n \"return_refund_feedback\": \"customer opened item\",\n \"refund_amount\": {\n \"principal\": 29.99,\n \"tax\": 0,\n \"shipping_cost\": 0,\n \"shipping_tax\": 0\n }\n }\n ],\n \"merchant_order_id\": \"a2f8a71e95014bb5be5dd827fc0f4cb0\",\n \"merchant_return_authorization_id\": \"53df71b3015640a9b50f481e8c1ce295\",\n \"merchant_return_charge\": 6.02,\n \"reference_order_id\": \"405385037126\",\n \"reference_return_authorization_id\": \"95GCL0CMHRN75LKOP16Q38Q3AB\",\n \"refund_without_return\": false,\n \"return_date\": \"2015-11-18T18:06:16.5744353Z\",\n \"return_merchant_SKUs\": [\n {\n \"order_item_id\": \"2627ec0e81d0445ca578359d3f102c11\",\n \"alt_order_item_id\": \"76-i105\",\n \"return_quantity\": 8,\n \"merchant_sku\": \"123567890333\",\n \"reason\": \"item is defective/does not work properly\",\n \"requested_refund_amount\": {\n \"principal\": 29.99,\n \"tax\": null,\n \"shipping_cost\": 0,\n \"shipping_tax\": null\n }\n }\n ],\n \"return_status\": \"inprogress\",\n \"shipping_carrier\": \"USPS\",\n \"tracking_number\": \"1Z23W4561233457824\"\n}", "language": "json", "name": "'Inprogress' Return" }, { "code": "{\n \"agree_to_return_charge\": true,\n \"alt_order_id\": \"12345678\",\n \"completed_date\": \"2016-01-23T19:07:09Z\",\n \"items\": [\n {\n \"order_item_id\": \"2627ec0e81d0445ca578359d3f102c11\",\n \"alt_order_item_id\": \"A1223456\",\n \"total_quantity_returned\": 8,\n \"order_return_refund_qty\": 8,\n \"return_refund_feedback\": \"customer opened item\",\n \"refund_amount\": {\n \"principal\": 59.98,\n \"tax\": 0,\n \"shipping_cost\": 0,\n \"shipping_tax\": 0\n }\n }\n ],\n \"merchant_order_id\": \"a2f8a71e95014bb5be5dd827fc0f4cb0\",\n \"merchant_return_authorization_id\": \"53df71b3015640a9b50f481e8c1ce295\",\n \"merchant_return_charge\": 6.02,\n \"reference_order_id\": \"405385037126\",\n \"reference_return_authorization_id\": \"95GCL0CMHRN75LKOP16Q38Q3AB\",\n \"refund_without_return\": false,\n \"return_date\": \"2015-11-18T18:06:16.5744353Z\",\n \"return_merchant_SKUs\": [\n {\n \"order_item_id\": \"2627ec0e81d0445ca578359d3f102c11\",\n \"alt_order_item_id\": \"76-i105\",\n \"return_quantity\": 8,\n \"merchant_sku\": \"123567890333\",\n \"reason\": \"item is defective/does not work properly\",\n \"requested_refund_amount\": {\n \"principal\": 29.99,\n \"tax\": null,\n \"shipping_cost\": 0,\n \"shipping_tax\": null\n }\n }\n ],\n \"return_status\": \"completed by merchant\",\n \"shipping_carrier\": \"USPS\",\n \"tracking_number\": \"1Z23W4561233457824\"\n}", "language": "json", "name": "'Complete' Return" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



To check for a specific return you will the utilize the Get Returns Info method. Please replace {jet_return_id} with the return id. This will return a list of values within that return. [block:api-header] { "type": "basic", "title": "Response Body: Return \"Created\"" } [/block] The following fields are returned when an item is "created" [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**agree_to_return_charge** \n\n*boolean*", "1-0": "**alt_order_id** \n\n*string*", "2-0": "**alt_return_authorization_id** \n\n*string*", "3-0": "**merchant_order_id** \n\n*string*", "4-0": "**merchant_return_authorization_id** \n\n*string*", "5-0": "**merchant_return_charge** \n\n*float*", "6-0": "**reference_order_id** \n\n*string*", "7-0": "**reference_return_authorization_id** \n\n*string*", "8-0": "**refund_without_return** \n\n*boolean*", "9-0": "**return_date** \n\n*string*", "10-0": "**return_status** \n\n*string*", "11-0": "**shipping_carrier** \n\n*string*", "12-0": "**tracking_number** \n\n*string*", "13-0": "**return_location** \n\n*object array*", "14-0": "**return_merchant_SKUs** \n\n*return_merchant_SKUs object array*", "4-2": "", "7-2": "", "8-2": "", "10-1": "Current status of the return.", "8-1": "If this is true, Jet has deemed that this item should not be returned, but the customer still should be refunded.", "7-1": "Jet's human readable return authorization number that may have a small chance of collision overtime", "4-1": "Jet generated return authorization ID that is used in URL", "3-1": "Jet's unique ID for a given merchant order", "6-1": "Jet's human readable order ID number that may have a small chance of collision overtime", "1-1": "Optional merchant supplied order ID that should have been established in OrderAcknowledgement in order to use in this message.", "1-2": "Will be provided if seller provided value on original order", "9-1": "The date that the customer requested a return authorization.", "9-2": "The UTC time as follows 'yyyy'-'MM'-'dd'T'HH':'mm':'ss'.'fffffff''Z' for example 5PM eastern daylight time on Jan 1st 2015 would be '2015-01-01T21:00:00.0000000Z'", "11-1": "Shipping method used for the given return shipment.", "11-2": "This will be populated with the carrier Jet has chosen if Jet is paying for the return shipping label.If the merchant pays for the return shipping label, the carrier that merchant uses for returns will be populated.", "12-1": "Tracking number for the given return shipment", "12-2": "This will be populated with the tracking number of the return shipment", "5-1": "The charge that the merchant is required to pay Jet for the return.", "5-2": "This is populated with the charge that a merchant will pay Jet for a customer return", "2-1": "This field is set by return complete message. Optional merchant supplied return number, allows the merchant to use this number in future messages instead of return_authorization_id. This ID will be included on the Return Documentation that Jet gives to the customer.", "0-1": "This field set by order refund message. Specifies if the merchant agrees to the return charge for the return notification.\n\nPossible Values:\n* 'false' - The merchant disagrees with the return charge and will enter a disputed charge with Jet.com\n* 'true' - The merchant agrees to wholly pay the return charge to Jet.com from the return notification", "0-2": "" }, "cols": 3, "rows": 15 } [/block] **return_merchant_SKUs object** - The following fields are a part of the return [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**order_item_id** \n\n*string*", "1-0": "**alt_order_item_id** \n\n*string*", "2-0": "**merchant_sku** \n\n*string*", "3-0": "**merchant_sku_title** \n\n*string*", "4-0": "**reason**\n\n*string*", "0-1": "Jet's unique identifier for an item in a merchant order.", "1-1": "If an alt_order_item_id has been associated with the order_item_id via the order accept message, this may be passed instead of the order_item_id field.", "2-1": "The merchant SKU that is being returned", "3-1": "The short description of the merchant SKU being returned", "4-1": "The reason the customer is returning the item", "4-2": "Must be one of the following values:\n * No longer want this item\n * Received the wrong item\n * Website description is inaccurate\n * Product is defective / does not work\n * Item arrived damaged - box intact\n * Item arrived damaged - box damaged\n * Package never arrived\n * Wrong quantity received\n * Better price found elsewhere\n * Unauthorized purchase\n * Item is missing parts / accessories\n * Item is refurbished\n * Item is expired\n * Item does not fit", "5-0": "**return_quantity** \n\n*integer*", "5-1": "THe quantity of the merchant SKU that is being returned", "6-0": "**requested_refund_amount** \n\n*object*", "6-1": "The amount the retailer is willing to refund to the customer" }, "cols": 3, "rows": 7 } [/block] **requested_refund_amount object** [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**principal** \n\n*float*", "1-0": "**tax** \n\n*float*", "2-0": "**shipping_cost** \n\n*float*", "3-0": "**shipping_tax** \n\n*float*", "0-1": "Amount to be refunded for the given item in USD associated with the item itself. \n\nThis should be the *total cost* for this item not the unit cost.", "1-1": "Amount to be refunded for the given item in USD associated with tax that was charged for the item.", "3-1": "Amount to be refunded for the given item in USD associated with the tax that was charged on shipping", "2-1": "Amount to be refunded for the given item in USD associated with the shipping cost that was allocated to this item." }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "Response Body: Return \"Inprogress\" or \"Completed by Merchant\"" } [/block] The following fields are added to the message if a return is either "inprogress" or "completed by merchant" [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**items** \n\n*items object array*", "0-1": "The items that were returned" }, "cols": 3, "rows": 1 } [/block] **items object** - The following fields are part of an items object [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**order_item_id** \n\n*string*", "1-0": "**alt_order_item_id** \n\n*string*", "2-0": "**total_quantity_returned** \n\n*integer*", "3-0": "**order_return_refund_qty** \n\n*integer*", "4-0": "**return_refund_feedback**\n\n*string*", "0-1": "Jet's unique identifier for an item in a merchant order.", "1-1": "If an alt_order_item_id has been associated with the order_item_id via the order accept message, this may be passed instead of the order_item_id field.", "2-1": "Quantity of the given item that was returned.", "3-1": "Quantity of the given item that was refunded.", "4-1": "The reason this refund is less than the full amount.", "4-2": "Must be one of the following values:\n* other\n* item damaged\n* not shipped in original packaging\n* customer opened item\n\nRequired if total refund_amount < requested_refund_amount", "5-0": "**notes** \n\n*string*", "5-1": "Provide additional information about why the item was refunded for lower than the full amount.", "6-0": "**refund_amount** \n\n*object*", "6-1": "The amount the retailer is willing to refund to the customer" }, "cols": 3, "rows": 7 } [/block] **refund_amount object** [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**principal** \n\n*float*", "1-0": "**tax** \n\n*float*", "2-0": "**shipping_cost** \n\n*float*", "3-0": "**shipping_tax** \n\n*float*", "0-1": "Amount to be refunded for the given item in USD associated with the item itself. This should be the total cost for this item not the unit cost.", "1-1": "Amount to be refunded for the given item in USD associated with tax that was charged for the item.", "3-1": "Amount to be refunded for the given item in USD associated with the tax that was charged on shipping", "2-1": "Amount to be refunded for the given item in USD associated with the shipping cost that was allocated to this item." }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "sidebar": true, "title": "Use Cases" } [/block] [block:textarea] { "text": "Here are sample response bodies depending on the status of the return", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"return_status\": \"created\",\n \"refund_without_return\": false,\n \"merchant_return_authorization_id\": \"53df71b3015640a9b50f481e8c1ce295\",\n \"reference_return_authorization_id\": \"95GCL0CMHRN75LKOP16Q38Q3AB\",\n \"merchant_order_id\": \"a2f8a71e95014bb5be5dd827fc0f4cb0\",\n \"return_date\": \"2015-11-18T18:06:16.5744353Z\",\n \"return_merchant_SKUs\": [\n {\n \"order_item_id\": \"2627ec0e81d0445ca578359d3f102c11\",\n \"alt_order_item_id\": \"76-i105\",\n \"return_quantity\": 8,\n \"merchant_sku\": \"123567890333\",\n \"reason\": \"item is defective/does not work properly\",\n \"requested_refund_amount\": {\n \"principal\": 29.99,\n \"tax\": null,\n \"shipping_cost\": 0,\n \"shipping_tax\": null\n }\n }\n ],\n \"shipping_carrier\": \"USPS\",\n \"tracking_number\": \"1Z23W4561233457824\",\n \"merchant_return_charge\": 6.02,\n \"reference_order_id\": \"405385037126\"\n}", "language": "json", "name": "'Created' Return" }, { "code": "{\n \"agree_to_return_charge\": true,\n \"alt_order_id\": \"12345678\",\n \"items\": [\n {\n \"order_item_id\": \"2627ec0e81d0445ca578359d3f102c11\",\n \"alt_order_item_id\": \"A1223456\",\n \"total_quantity_returned\": 1,\n \"order_return_refund_qty\": 1,\n \"return_refund_feedback\": \"customer opened item\",\n \"refund_amount\": {\n \"principal\": 29.99,\n \"tax\": 0,\n \"shipping_cost\": 0,\n \"shipping_tax\": 0\n }\n }\n ],\n \"merchant_order_id\": \"a2f8a71e95014bb5be5dd827fc0f4cb0\",\n \"merchant_return_authorization_id\": \"53df71b3015640a9b50f481e8c1ce295\",\n \"merchant_return_charge\": 6.02,\n \"reference_order_id\": \"405385037126\",\n \"reference_return_authorization_id\": \"95GCL0CMHRN75LKOP16Q38Q3AB\",\n \"refund_without_return\": false,\n \"return_date\": \"2015-11-18T18:06:16.5744353Z\",\n \"return_merchant_SKUs\": [\n {\n \"order_item_id\": \"2627ec0e81d0445ca578359d3f102c11\",\n \"alt_order_item_id\": \"76-i105\",\n \"return_quantity\": 8,\n \"merchant_sku\": \"123567890333\",\n \"reason\": \"item is defective/does not work properly\",\n \"requested_refund_amount\": {\n \"principal\": 29.99,\n \"tax\": null,\n \"shipping_cost\": 0,\n \"shipping_tax\": null\n }\n }\n ],\n \"return_status\": \"inprogress\",\n \"shipping_carrier\": \"USPS\",\n \"tracking_number\": \"1Z23W4561233457824\"\n}", "language": "json", "name": "'Inprogress' Return" }, { "code": "{\n \"agree_to_return_charge\": true,\n \"alt_order_id\": \"12345678\",\n \"completed_date\": \"2016-01-23T19:07:09Z\",\n \"items\": [\n {\n \"order_item_id\": \"2627ec0e81d0445ca578359d3f102c11\",\n \"alt_order_item_id\": \"A1223456\",\n \"total_quantity_returned\": 8,\n \"order_return_refund_qty\": 8,\n \"return_refund_feedback\": \"customer opened item\",\n \"refund_amount\": {\n \"principal\": 59.98,\n \"tax\": 0,\n \"shipping_cost\": 0,\n \"shipping_tax\": 0\n }\n }\n ],\n \"merchant_order_id\": \"a2f8a71e95014bb5be5dd827fc0f4cb0\",\n \"merchant_return_authorization_id\": \"53df71b3015640a9b50f481e8c1ce295\",\n \"merchant_return_charge\": 6.02,\n \"reference_order_id\": \"405385037126\",\n \"reference_return_authorization_id\": \"95GCL0CMHRN75LKOP16Q38Q3AB\",\n \"refund_without_return\": false,\n \"return_date\": \"2015-11-18T18:06:16.5744353Z\",\n \"return_merchant_SKUs\": [\n {\n \"order_item_id\": \"2627ec0e81d0445ca578359d3f102c11\",\n \"alt_order_item_id\": \"76-i105\",\n \"return_quantity\": 8,\n \"merchant_sku\": \"123567890333\",\n \"reason\": \"item is defective/does not work properly\",\n \"requested_refund_amount\": {\n \"principal\": 29.99,\n \"tax\": null,\n \"shipping_cost\": 0,\n \"shipping_tax\": null\n }\n }\n ],\n \"return_status\": \"completed by merchant\",\n \"shipping_carrier\": \"USPS\",\n \"tracking_number\": \"1Z23W4561233457824\"\n}", "language": "json", "name": "'Complete' Return" } ], "sidebar": true } [/block]
{"_id":"56fd2bf327b4321900186ef5","title":"Complete Return","type":"put","user":"562e25d24376430d006f1769","githubsync":"","link_external":false,"project":"562e25f2e01a430d00c2c91e","__v":1,"updates":["574f106f1866ba20001082e2"],"isReference":false,"order":2,"sync_unique":"","version":"56fd2bf327b4321900186ec6","api":{"url":"/returns/{jet_return_id}/complete","auth":"required","examples":{"codes":[]},"method":"put","params":[{"name":"jet_return_id","in":"path","_id":"5637c25b0704070d00f06d23","ref":"","required":false,"desc":"The Jet generated Return ID","default":"","type":"string"}],"results":{"codes":[{"status":204,"code":"","language":"json"},{"status":400,"language":"json","code":""}]},"settings":""},"createdAt":"2015-11-02T20:06:51.925Z","editedParams":true,"editedParams2":true,"link_url":"","parentDoc":null,"slug":"complete-return","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request Body\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**merchant_order_id*** \\n\\n*string*\",\n    \"0-1\": \"Jet's unique ID for a given merchant order.\",\n    \"1-0\": \"**alt_order_id** \\n\\n*string*\",\n    \"1-1\": \"Optional merchant supplied order ID.\",\n    \"2-0\": \"**agree_to_return_charge*** \\n\\n*boolean*\",\n    \"2-2\": \"Must be one of the following values: \\n* true\\n* false\",\n    \"2-1\": \"Does the merchant agree to the return charge for the return notification?\",\n    \"3-0\": \"**return_charge_feedback** \\n\\n*string*\",\n    \"3-2\": \"Must be one of the following values:\\n* other\\n* outsideMerchantPolicy\\n* notMerchantError\\n* wrongItem\\n* fraud\\n* returnedOutsideWindow\",\n    \"3-1\": \"The reason the merchant does not agree to the return charge for the return notification.\",\n    \"4-0\": \"**items** \\n\\n*items object array*\",\n    \"4-1\": \"The items that were returned\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**order_item_id*** \\n\\n*string*\",\n    \"1-0\": \"**alt_order_item_id** \\n\\n*string*\",\n    \"2-0\": \"**total_quantity_returned*** \\n\\n*integer*\",\n    \"3-0\": \"**order_return_refund_qty*** \\n\\n*integer*\",\n    \"4-0\": \"**return_refund_feedback**\\n\\n*string*\",\n    \"0-1\": \"Jet's unique identifier for an item in a merchant order.\",\n    \"1-1\": \"If an alt_order_item_id has been associated with the order_item_id via the order accept message, this may be passed instead of the order_item_id field.\",\n    \"2-1\": \"Quantity of the given item that was returned.\",\n    \"3-1\": \"Quantity of the given item that was refunded.\",\n    \"4-1\": \"The reason this refund is less than the full amount.\",\n    \"4-2\": \"Must be one of the following values:\\n* other\\n* item damaged\\n* not shipped in original packaging\\n* customer opened item\\n* general adjustment - notes required\\n\\nRequired if total refund_amount < requested_refund_amount\",\n    \"5-0\": \"**notes** \\n\\n*string*\",\n    \"5-1\": \"Provide additional information about why the item was refunded for lower than the full amount.\",\n    \"6-0\": \"**refund_amount*** \\n\\n*object*\",\n    \"6-1\": \"The amount the retailer is willing to refund to the customer\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\n**refund_amount object**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**principal*** \\n\\n*float*\",\n    \"1-0\": \"**tax*** \\n\\n*float*\",\n    \"2-0\": \"**shipping_cost*** \\n\\n*float*\",\n    \"3-0\": \"**shipping_tax*** \\n\\n*float*\",\n    \"0-1\": \"Amount to be refunded for the given item in USD associated with the item itself. This should be the total cost for this item not the unit cost.\",\n    \"1-1\": \"Amount to be refunded for the given item in USD associated with tax that was charged for the item.\",\n    \"3-1\": \"Amount to be refunded for the given item in USD associated with the tax that was charged on shipping\",\n    \"2-1\": \"Amount to be refunded for the given item in USD associated with the shipping cost that was allocated to this item.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use Cases\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Examples:\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n\\\"merchant_order_id\\\":\\\"a2f8a71e95014bb5be5dd827fc0f4cb0\\\",\\n\\\"alt_order_id\\\": \\\"12345678\\\",\\n\\\"items\\\": [\\n  {\\n  \\\"order_item_id\\\": \\\"2627ec0e81d0445ca578359d3f102c11\\\",\\n  \\\"alt_order_item_id\\\": \\\"A1223456\\\",\\n  \\\"total_quantity_returned\\\": 1,\\n  \\\"order_return_refund_qty\\\": 1,\\n  \\\"refund_amount\\\": {\\n    \\\"principal\\\":29.99, //price was the full amount\\n    \\\"tax\\\":0,\\n    \\\"shipping_cost\\\":4.99,\\n    \\\"shipping_tax\\\":0\\n  }\\n }\\n],\\n\\\"agree_to_return_charge\\\": true\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Refund Full Price\"\n    },\n    {\n      \"code\": \"{\\n\\\"merchant_order_id\\\":\\\"a2f8a71e95014bb5be5dd827fc0f4cb0\\\",\\n\\\"alt_order_id\\\": \\\"12345678\\\",\\n\\\"items\\\": [\\n  {\\n  \\\"order_item_id\\\": \\\"2627ec0e81d0445ca578359d3f102c11\\\",\\n  \\\"alt_order_item_id\\\": \\\"A1223456\\\",\\n  \\\"total_quantity_returned\\\": 1,\\n  \\\"order_return_refund_qty\\\": 1,\\n  \\\"return_refund_feedback\\\": \\\"customer opened item\\\",\\n  \\\"refund_amount\\\": {\\n    \\\"principal\\\":20, \\n    \\\"tax\\\":0,\\n    \\\"shipping_cost\\\":4.99,\\n    \\\"shipping_tax\\\":0\\n  }\\n }\\n],\\n\\\"agree_to_return_charge\\\": true\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Partial Refund\"\n    },\n    {\n      \"code\": \"{\\n\\\"merchant_order_id\\\":\\\"a2f8a71e95014bb5be5dd827fc0f4cb0\\\",\\n\\\"alt_order_id\\\": \\\"12345678\\\",\\n\\\"items\\\": [\\n  {\\n  \\\"order_item_id\\\": \\\"2627ec0e81d0445ca578359d3f102c11\\\",\\n  \\\"alt_order_item_id\\\": \\\"A1223456\\\",\\n  \\\"total_quantity_returned\\\": 1,\\n  \\\"order_return_refund_qty\\\": 1,\\n  \\\"return_refund_feedback\\\": \\\"customer opened item\\\",\\n  \\\"refund_amount\\\": {\\n    \\\"principal\\\":0, //refund no $ to customer\\n    \\\"tax\\\":0,\\n    \\\"shipping_cost\\\":0,\\n    \\\"shipping_tax\\\":0\\n  }\\n }\\n],\\n\\\"agree_to_return_charge\\\": true\\n}\",\n      \"language\": \"json\",\n      \"name\": \"No Refund\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"56fd2bf327b4321900186ecc","excerpt":"","hidden":false,"childrenPages":[]}

putComplete Return


Path Params

jet_return_id:
string
The Jet generated Return ID
[block:api-header] { "type": "basic", "title": "Request Body" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**merchant_order_id*** \n\n*string*", "0-1": "Jet's unique ID for a given merchant order.", "1-0": "**alt_order_id** \n\n*string*", "1-1": "Optional merchant supplied order ID.", "2-0": "**agree_to_return_charge*** \n\n*boolean*", "2-2": "Must be one of the following values: \n* true\n* false", "2-1": "Does the merchant agree to the return charge for the return notification?", "3-0": "**return_charge_feedback** \n\n*string*", "3-2": "Must be one of the following values:\n* other\n* outsideMerchantPolicy\n* notMerchantError\n* wrongItem\n* fraud\n* returnedOutsideWindow", "3-1": "The reason the merchant does not agree to the return charge for the return notification.", "4-0": "**items** \n\n*items object array*", "4-1": "The items that were returned" }, "cols": 3, "rows": 5 } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**order_item_id*** \n\n*string*", "1-0": "**alt_order_item_id** \n\n*string*", "2-0": "**total_quantity_returned*** \n\n*integer*", "3-0": "**order_return_refund_qty*** \n\n*integer*", "4-0": "**return_refund_feedback**\n\n*string*", "0-1": "Jet's unique identifier for an item in a merchant order.", "1-1": "If an alt_order_item_id has been associated with the order_item_id via the order accept message, this may be passed instead of the order_item_id field.", "2-1": "Quantity of the given item that was returned.", "3-1": "Quantity of the given item that was refunded.", "4-1": "The reason this refund is less than the full amount.", "4-2": "Must be one of the following values:\n* other\n* item damaged\n* not shipped in original packaging\n* customer opened item\n* general adjustment - notes required\n\nRequired if total refund_amount < requested_refund_amount", "5-0": "**notes** \n\n*string*", "5-1": "Provide additional information about why the item was refunded for lower than the full amount.", "6-0": "**refund_amount*** \n\n*object*", "6-1": "The amount the retailer is willing to refund to the customer" }, "cols": 3, "rows": 7 } [/block] **refund_amount object** [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**principal*** \n\n*float*", "1-0": "**tax*** \n\n*float*", "2-0": "**shipping_cost*** \n\n*float*", "3-0": "**shipping_tax*** \n\n*float*", "0-1": "Amount to be refunded for the given item in USD associated with the item itself. This should be the total cost for this item not the unit cost.", "1-1": "Amount to be refunded for the given item in USD associated with tax that was charged for the item.", "3-1": "Amount to be refunded for the given item in USD associated with the tax that was charged on shipping", "2-1": "Amount to be refunded for the given item in USD associated with the shipping cost that was allocated to this item." }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Examples:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n\"merchant_order_id\":\"a2f8a71e95014bb5be5dd827fc0f4cb0\",\n\"alt_order_id\": \"12345678\",\n\"items\": [\n {\n \"order_item_id\": \"2627ec0e81d0445ca578359d3f102c11\",\n \"alt_order_item_id\": \"A1223456\",\n \"total_quantity_returned\": 1,\n \"order_return_refund_qty\": 1,\n \"refund_amount\": {\n \"principal\":29.99, //price was the full amount\n \"tax\":0,\n \"shipping_cost\":4.99,\n \"shipping_tax\":0\n }\n }\n],\n\"agree_to_return_charge\": true\n}", "language": "json", "name": "Refund Full Price" }, { "code": "{\n\"merchant_order_id\":\"a2f8a71e95014bb5be5dd827fc0f4cb0\",\n\"alt_order_id\": \"12345678\",\n\"items\": [\n {\n \"order_item_id\": \"2627ec0e81d0445ca578359d3f102c11\",\n \"alt_order_item_id\": \"A1223456\",\n \"total_quantity_returned\": 1,\n \"order_return_refund_qty\": 1,\n \"return_refund_feedback\": \"customer opened item\",\n \"refund_amount\": {\n \"principal\":20, \n \"tax\":0,\n \"shipping_cost\":4.99,\n \"shipping_tax\":0\n }\n }\n],\n\"agree_to_return_charge\": true\n}", "language": "json", "name": "Partial Refund" }, { "code": "{\n\"merchant_order_id\":\"a2f8a71e95014bb5be5dd827fc0f4cb0\",\n\"alt_order_id\": \"12345678\",\n\"items\": [\n {\n \"order_item_id\": \"2627ec0e81d0445ca578359d3f102c11\",\n \"alt_order_item_id\": \"A1223456\",\n \"total_quantity_returned\": 1,\n \"order_return_refund_qty\": 1,\n \"return_refund_feedback\": \"customer opened item\",\n \"refund_amount\": {\n \"principal\":0, //refund no $ to customer\n \"tax\":0,\n \"shipping_cost\":0,\n \"shipping_tax\":0\n }\n }\n],\n\"agree_to_return_charge\": true\n}", "language": "json", "name": "No Refund" } ], "sidebar": true } [/block]

Definition

{{ api_url }}{{ page_api_url }}


[block:api-header] { "type": "basic", "title": "Request Body" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**merchant_order_id*** \n\n*string*", "0-1": "Jet's unique ID for a given merchant order.", "1-0": "**alt_order_id** \n\n*string*", "1-1": "Optional merchant supplied order ID.", "2-0": "**agree_to_return_charge*** \n\n*boolean*", "2-2": "Must be one of the following values: \n* true\n* false", "2-1": "Does the merchant agree to the return charge for the return notification?", "3-0": "**return_charge_feedback** \n\n*string*", "3-2": "Must be one of the following values:\n* other\n* outsideMerchantPolicy\n* notMerchantError\n* wrongItem\n* fraud\n* returnedOutsideWindow", "3-1": "The reason the merchant does not agree to the return charge for the return notification.", "4-0": "**items** \n\n*items object array*", "4-1": "The items that were returned" }, "cols": 3, "rows": 5 } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**order_item_id*** \n\n*string*", "1-0": "**alt_order_item_id** \n\n*string*", "2-0": "**total_quantity_returned*** \n\n*integer*", "3-0": "**order_return_refund_qty*** \n\n*integer*", "4-0": "**return_refund_feedback**\n\n*string*", "0-1": "Jet's unique identifier for an item in a merchant order.", "1-1": "If an alt_order_item_id has been associated with the order_item_id via the order accept message, this may be passed instead of the order_item_id field.", "2-1": "Quantity of the given item that was returned.", "3-1": "Quantity of the given item that was refunded.", "4-1": "The reason this refund is less than the full amount.", "4-2": "Must be one of the following values:\n* other\n* item damaged\n* not shipped in original packaging\n* customer opened item\n* general adjustment - notes required\n\nRequired if total refund_amount < requested_refund_amount", "5-0": "**notes** \n\n*string*", "5-1": "Provide additional information about why the item was refunded for lower than the full amount.", "6-0": "**refund_amount*** \n\n*object*", "6-1": "The amount the retailer is willing to refund to the customer" }, "cols": 3, "rows": 7 } [/block] **refund_amount object** [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**principal*** \n\n*float*", "1-0": "**tax*** \n\n*float*", "2-0": "**shipping_cost*** \n\n*float*", "3-0": "**shipping_tax*** \n\n*float*", "0-1": "Amount to be refunded for the given item in USD associated with the item itself. This should be the total cost for this item not the unit cost.", "1-1": "Amount to be refunded for the given item in USD associated with tax that was charged for the item.", "3-1": "Amount to be refunded for the given item in USD associated with the tax that was charged on shipping", "2-1": "Amount to be refunded for the given item in USD associated with the shipping cost that was allocated to this item." }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Examples:", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n\"merchant_order_id\":\"a2f8a71e95014bb5be5dd827fc0f4cb0\",\n\"alt_order_id\": \"12345678\",\n\"items\": [\n {\n \"order_item_id\": \"2627ec0e81d0445ca578359d3f102c11\",\n \"alt_order_item_id\": \"A1223456\",\n \"total_quantity_returned\": 1,\n \"order_return_refund_qty\": 1,\n \"refund_amount\": {\n \"principal\":29.99, //price was the full amount\n \"tax\":0,\n \"shipping_cost\":4.99,\n \"shipping_tax\":0\n }\n }\n],\n\"agree_to_return_charge\": true\n}", "language": "json", "name": "Refund Full Price" }, { "code": "{\n\"merchant_order_id\":\"a2f8a71e95014bb5be5dd827fc0f4cb0\",\n\"alt_order_id\": \"12345678\",\n\"items\": [\n {\n \"order_item_id\": \"2627ec0e81d0445ca578359d3f102c11\",\n \"alt_order_item_id\": \"A1223456\",\n \"total_quantity_returned\": 1,\n \"order_return_refund_qty\": 1,\n \"return_refund_feedback\": \"customer opened item\",\n \"refund_amount\": {\n \"principal\":20, \n \"tax\":0,\n \"shipping_cost\":4.99,\n \"shipping_tax\":0\n }\n }\n],\n\"agree_to_return_charge\": true\n}", "language": "json", "name": "Partial Refund" }, { "code": "{\n\"merchant_order_id\":\"a2f8a71e95014bb5be5dd827fc0f4cb0\",\n\"alt_order_id\": \"12345678\",\n\"items\": [\n {\n \"order_item_id\": \"2627ec0e81d0445ca578359d3f102c11\",\n \"alt_order_item_id\": \"A1223456\",\n \"total_quantity_returned\": 1,\n \"order_return_refund_qty\": 1,\n \"return_refund_feedback\": \"customer opened item\",\n \"refund_amount\": {\n \"principal\":0, //refund no $ to customer\n \"tax\":0,\n \"shipping_cost\":0,\n \"shipping_tax\":0\n }\n }\n],\n\"agree_to_return_charge\": true\n}", "language": "json", "name": "No Refund" } ], "sidebar": true } [/block]
{"_id":"56fd2bf327b4321900186ef0","editedParams2":true,"sync_unique":"","title":"Create Merchant Initiated Refund","slug":"merchant-initiated-refund","user":"562e25d24376430d006f1769","__v":0,"api":{"examples":{"codes":[]},"method":"post","params":[{"type":"string","name":"order_id","in":"path","_id":"5637befec75f5d0d00ec5e2b","ref":"","required":false,"desc":"The Order ID you wish to create a refund for.","default":""},{"required":false,"desc":"The Alternative Refund ID that you must create for a refund.","default":"","type":"string","name":"alt_refund_id","in":"path","_id":"5637befec75f5d0d00ec5e2a","ref":""}],"results":{"codes":[{"status":201,"language":"json","code":"{\n    \"refund_authorization_id\": \"123456789\",\n    \"refund_status\":\"created\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/refunds/{order_id}/{alt_refund_id}","auth":"required"},"category":"56fd2bf327b4321900186ecd","hidden":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"createdAt":"2015-11-02T19:52:30.829Z","excerpt":"","githubsync":"","updates":[],"version":"56fd2bf327b4321900186ec6","type":"post","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request Body\"\n}\n[/block]\nMerchant Initiated Refunds can be created using this API method. There are many reasons this method would be utilized including:\n\n* Order has was rejected at post office or member's address\n* Member sends product directly back to merchant without contacting Jet\n* Merchant wishes to refund a member for sending a damaged product before a return is created\n\nThe fields for the merchant initiated refund call are outlined below:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**items***\\n\\n*items array*\",\n    \"0-1\": \"\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n**items array** - The below table outlines the fields that are within the items array:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**order_item_id**\\n\\n*string*\",\n    \"1-0\": \"**alt_order_item_id** \\n\\n*string*\",\n    \"2-0\": \"**total_quantity_returned** \\n\\n*integer*\",\n    \"3-0\": \"**order_return_refund_qty** \\n\\n*integer*\",\n    \"4-0\": \"**refund_reason** \\n\\n*string*\",\n    \"5-0\": \"**refund_feedback** \\n\\n*string*\",\n    \"6-0\": \"**notes** \\n\\n*string*\",\n    \"7-0\": \"**refund_amount** \\n\\n*refund_amount object*\",\n    \"0-1\": \"Jet's unique identifier for an item in a merchant order.\",\n    \"1-1\": \"If an alt_order_item_id that has been associated with the order_item_id via the order accept message. If this was not sent in the original order acknowledgement message or the order shipped message, use order_item_id.\",\n    \"2-1\": \"Quantity of the given item that was returned.This quantity should only include the units that were returned to the merchant.\",\n    \"3-1\": \"Quantity of the given item that the merchant wants to refund to the customer.\",\n    \"4-1\": \"The reason the customer initiated the return.\",\n    \"4-2\": \"Must be one of the following values:\\n  * No longer want this item\\n  * Received the wrong item\\n  * Website description is inaccurate\\n  * Product is defective / does not work\\n  * Item arrived damaged - box intact\\n  * Item arrived damaged - box damaged\\n  * Package never arrived\\n  * Package arrived late\\n  * Wrong quantity received\\n  * Better price found elsewhere\\n  * Unwanted gift\\n  * Accidental order\\n  * Unauthorized purchase\\n  * Item is missing parts / accessories\\n  * Return to Sender - damaged, undeliverable, refused\\n  * Return to Sender - lost in transit only\\n  * Item is refurbished\\n  * Item is expired\\n  * Package arrived after estimated delivery date\",\n    \"5-1\": \"The reason this refund is less than the full amount.\",\n    \"5-2\": \"* other - (notes must be used if selected)\\n* 'item damaged' \\n* not shipped in original packaging\\n* customer opened item\",\n    \"6-1\": \"Provide additional information about why the item was refunded for lower than the full amount.\",\n    \"2-2\": \"\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]\n**refund_amount array** - The below table outlines the fields that are within the refund_amount array:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**principal**\\n\\n*float*\",\n    \"1-0\": \"**tax** \\n\\n*float*\",\n    \"2-0\": \"**shipping_cost** \\n\\n*float*\",\n    \"3-0\": \"**shipping_tax** \\n\\n*float*\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-1\": \"Amount to be refunded for the given item in USD associated with the item itself. This should be the total cost for this item not the unit cost.\",\n    \"1-1\": \"Amount to be refunded for the given item in USD associated with tax that was charged for the item.\",\n    \"2-1\": \"Amount to be refunded for the given item in USD associated with the shipping cost that was allocated to this item.\",\n    \"3-1\": \"Amount to be refunded for the given item in USD associated with the tax that was charged on shipping.\",\n    \"0-2\": \"Must be greater than or equal to 0\",\n    \"1-2\": \"Must be greater than or equal to 0\",\n    \"2-2\": \"Must be greater than or equal to 0\",\n    \"3-2\": \"Must be greater than or equal to 0\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use Cases\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"Sample request bodies\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"items\\\": [\\n    {\\n      \\\"order_item_id\\\": \\\"b789123fec744a1d994612acc9ebe563\\\",\\n      \\\"alt_order_item_id\\\": \\\"A1223456\\\",\\n      \\\"total_quantity_returned\\\": 1,\\n      \\\"order_return_refund_qty\\\": 1,\\n      \\\"refund_reason\\\": \\\"better price available\\\",\\n      \\\"refund_feedback\\\": \\\"item damaged\\\",\\n      \\\"notes\\\": \\\"This is where the notes go\\\",\\n      \\\"refund_amount\\\": {\\n        \\\"principal\\\": 12.75,\\n        \\\"tax\\\": 0,\\n        \\\"shipping_cost\\\": 1.0,\\n        \\\"shipping_tax\\\": 0\\n      }\\n    }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"refund_authorization_id\",\n    \"1-0\": \"refund_status\",\n    \"0-1\": \"The Jet-defined ID associated with this refund\",\n    \"1-1\": \"The current status of the refund.\",\n    \"1-2\": \"For response, will be 'created'\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","editedParams":true,"isReference":false,"project":"562e25f2e01a430d00c2c91e","childrenPages":[]}

postCreate Merchant Initiated Refund


Path Params

order_id:
string
The Order ID you wish to create a refund for.
alt_refund_id:
string
The Alternative Refund ID that you must create for a refund.
[block:api-header] { "type": "basic", "title": "Request Body" } [/block] Merchant Initiated Refunds can be created using this API method. There are many reasons this method would be utilized including: * Order has was rejected at post office or member's address * Member sends product directly back to merchant without contacting Jet * Merchant wishes to refund a member for sending a damaged product before a return is created The fields for the merchant initiated refund call are outlined below: [block:parameters] { "data": { "0-0": "**items***\n\n*items array*", "0-1": "", "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description" }, "cols": 3, "rows": 1 } [/block] **items array** - The below table outlines the fields that are within the items array: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**order_item_id**\n\n*string*", "1-0": "**alt_order_item_id** \n\n*string*", "2-0": "**total_quantity_returned** \n\n*integer*", "3-0": "**order_return_refund_qty** \n\n*integer*", "4-0": "**refund_reason** \n\n*string*", "5-0": "**refund_feedback** \n\n*string*", "6-0": "**notes** \n\n*string*", "7-0": "**refund_amount** \n\n*refund_amount object*", "0-1": "Jet's unique identifier for an item in a merchant order.", "1-1": "If an alt_order_item_id that has been associated with the order_item_id via the order accept message. If this was not sent in the original order acknowledgement message or the order shipped message, use order_item_id.", "2-1": "Quantity of the given item that was returned.This quantity should only include the units that were returned to the merchant.", "3-1": "Quantity of the given item that the merchant wants to refund to the customer.", "4-1": "The reason the customer initiated the return.", "4-2": "Must be one of the following values:\n * No longer want this item\n * Received the wrong item\n * Website description is inaccurate\n * Product is defective / does not work\n * Item arrived damaged - box intact\n * Item arrived damaged - box damaged\n * Package never arrived\n * Package arrived late\n * Wrong quantity received\n * Better price found elsewhere\n * Unwanted gift\n * Accidental order\n * Unauthorized purchase\n * Item is missing parts / accessories\n * Return to Sender - damaged, undeliverable, refused\n * Return to Sender - lost in transit only\n * Item is refurbished\n * Item is expired\n * Package arrived after estimated delivery date", "5-1": "The reason this refund is less than the full amount.", "5-2": "* other - (notes must be used if selected)\n* 'item damaged' \n* not shipped in original packaging\n* customer opened item", "6-1": "Provide additional information about why the item was refunded for lower than the full amount.", "2-2": "" }, "cols": 3, "rows": 8 } [/block] **refund_amount array** - The below table outlines the fields that are within the refund_amount array: [block:parameters] { "data": { "0-0": "**principal**\n\n*float*", "1-0": "**tax** \n\n*float*", "2-0": "**shipping_cost** \n\n*float*", "3-0": "**shipping_tax** \n\n*float*", "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-1": "Amount to be refunded for the given item in USD associated with the item itself. This should be the total cost for this item not the unit cost.", "1-1": "Amount to be refunded for the given item in USD associated with tax that was charged for the item.", "2-1": "Amount to be refunded for the given item in USD associated with the shipping cost that was allocated to this item.", "3-1": "Amount to be refunded for the given item in USD associated with the tax that was charged on shipping.", "0-2": "Must be greater than or equal to 0", "1-2": "Must be greater than or equal to 0", "2-2": "Must be greater than or equal to 0", "3-2": "Must be greater than or equal to 0" }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Sample request bodies", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"items\": [\n {\n \"order_item_id\": \"b789123fec744a1d994612acc9ebe563\",\n \"alt_order_item_id\": \"A1223456\",\n \"total_quantity_returned\": 1,\n \"order_return_refund_qty\": 1,\n \"refund_reason\": \"better price available\",\n \"refund_feedback\": \"item damaged\",\n \"notes\": \"This is where the notes go\",\n \"refund_amount\": {\n \"principal\": 12.75,\n \"tax\": 0,\n \"shipping_cost\": 1.0,\n \"shipping_tax\": 0\n }\n }\n ]\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Response Body" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "refund_authorization_id", "1-0": "refund_status", "0-1": "The Jet-defined ID associated with this refund", "1-1": "The current status of the refund.", "1-2": "For response, will be 'created'" }, "cols": 3, "rows": 2 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Request Body" } [/block] Merchant Initiated Refunds can be created using this API method. There are many reasons this method would be utilized including: * Order has was rejected at post office or member's address * Member sends product directly back to merchant without contacting Jet * Merchant wishes to refund a member for sending a damaged product before a return is created The fields for the merchant initiated refund call are outlined below: [block:parameters] { "data": { "0-0": "**items***\n\n*items array*", "0-1": "", "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description" }, "cols": 3, "rows": 1 } [/block] **items array** - The below table outlines the fields that are within the items array: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**order_item_id**\n\n*string*", "1-0": "**alt_order_item_id** \n\n*string*", "2-0": "**total_quantity_returned** \n\n*integer*", "3-0": "**order_return_refund_qty** \n\n*integer*", "4-0": "**refund_reason** \n\n*string*", "5-0": "**refund_feedback** \n\n*string*", "6-0": "**notes** \n\n*string*", "7-0": "**refund_amount** \n\n*refund_amount object*", "0-1": "Jet's unique identifier for an item in a merchant order.", "1-1": "If an alt_order_item_id that has been associated with the order_item_id via the order accept message. If this was not sent in the original order acknowledgement message or the order shipped message, use order_item_id.", "2-1": "Quantity of the given item that was returned.This quantity should only include the units that were returned to the merchant.", "3-1": "Quantity of the given item that the merchant wants to refund to the customer.", "4-1": "The reason the customer initiated the return.", "4-2": "Must be one of the following values:\n * No longer want this item\n * Received the wrong item\n * Website description is inaccurate\n * Product is defective / does not work\n * Item arrived damaged - box intact\n * Item arrived damaged - box damaged\n * Package never arrived\n * Package arrived late\n * Wrong quantity received\n * Better price found elsewhere\n * Unwanted gift\n * Accidental order\n * Unauthorized purchase\n * Item is missing parts / accessories\n * Return to Sender - damaged, undeliverable, refused\n * Return to Sender - lost in transit only\n * Item is refurbished\n * Item is expired\n * Package arrived after estimated delivery date", "5-1": "The reason this refund is less than the full amount.", "5-2": "* other - (notes must be used if selected)\n* 'item damaged' \n* not shipped in original packaging\n* customer opened item", "6-1": "Provide additional information about why the item was refunded for lower than the full amount.", "2-2": "" }, "cols": 3, "rows": 8 } [/block] **refund_amount array** - The below table outlines the fields that are within the refund_amount array: [block:parameters] { "data": { "0-0": "**principal**\n\n*float*", "1-0": "**tax** \n\n*float*", "2-0": "**shipping_cost** \n\n*float*", "3-0": "**shipping_tax** \n\n*float*", "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-1": "Amount to be refunded for the given item in USD associated with the item itself. This should be the total cost for this item not the unit cost.", "1-1": "Amount to be refunded for the given item in USD associated with tax that was charged for the item.", "2-1": "Amount to be refunded for the given item in USD associated with the shipping cost that was allocated to this item.", "3-1": "Amount to be refunded for the given item in USD associated with the tax that was charged on shipping.", "0-2": "Must be greater than or equal to 0", "1-2": "Must be greater than or equal to 0", "2-2": "Must be greater than or equal to 0", "3-2": "Must be greater than or equal to 0" }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "Use Cases", "sidebar": true } [/block] [block:textarea] { "text": "Sample request bodies", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"items\": [\n {\n \"order_item_id\": \"b789123fec744a1d994612acc9ebe563\",\n \"alt_order_item_id\": \"A1223456\",\n \"total_quantity_returned\": 1,\n \"order_return_refund_qty\": 1,\n \"refund_reason\": \"better price available\",\n \"refund_feedback\": \"item damaged\",\n \"notes\": \"This is where the notes go\",\n \"refund_amount\": {\n \"principal\": 12.75,\n \"tax\": 0,\n \"shipping_cost\": 1.0,\n \"shipping_tax\": 0\n }\n }\n ]\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Response Body" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "refund_authorization_id", "1-0": "refund_status", "0-1": "The Jet-defined ID associated with this refund", "1-1": "The current status of the refund.", "1-2": "For response, will be 'created'" }, "cols": 3, "rows": 2 } [/block]
{"_id":"56fd2bf327b4321900186ef1","__v":0,"category":"56fd2bf327b4321900186ecd","githubsync":"","link_external":false,"editedParams2":true,"hidden":false,"isReference":false,"project":"562e25f2e01a430d00c2c91e","slug":"check-refund-state","updates":[],"version":"56fd2bf327b4321900186ec6","type":"get","createdAt":"2015-11-02T19:48:50.057Z","editedParams":true,"excerpt":"","link_url":"","order":1,"parentDoc":null,"title":"Check Refund State","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"refund_authorization_id","in":"path","_id":"56a69c28683cfb0d00dc58a9","ref":"","required":false,"desc":"The refund_authorization_id received from the previous step","default":"","type":"string"}],"results":{"codes":[{"name":"","code":"{\n  \"alt_refund_id\": \"1292142451\",\n  \"refund_authorization_id\": \"1234567890987654321\",\n  \"reference_order_id\": \"982307409183459145\",\n  \"refund_status\": \"accepted\",\n  \"merchant_order_id\": \"9b13bdd68c314d1b9c8b93277dea4da1\",\n  \"reference_merchant_order_id\": \"1234567890\",\n  \"alt_order_id\": \"12345678\",\n  \"items\": [\n    {\n      \"order_item_id\": \"1123456789\",\n      \"alt_order_item_id\": \"A1223456\",\n      \"total_quantity_returned\": 1,\n      \"order_return_refund_qty\": 1,\n      \"refund_reason\": \"better price available\",\n      \"refund_feedback\": \"item damaged\",\n      \"notes\": \"This is where the notes go\",\n      \"refund_amount\": {\n        \"principal\": 12.75,\n        \"tax\": 0.9,\n        \"shipping_cost\": 1.0,\n        \"shipping_tax\": 0.07\n      }\n    }\n  ]\n}","language":"json","status":200},{"code":"{}","language":"json","status":400,"name":""}]},"settings":"","url":"/refunds/state/{refund_authorization_id}"},"body":"The below shows the response for a GET when checking refund status. The valid values for the {refund_id} are the 16-digit {refund_ids} returned by checking for a created return.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body: Refunds \\\"Created\\\"\"\n}\n[/block]\nThe following fields will come back in the response if provided in the refund creation step\n\nPOST /refunds/{order_id}/{alt_refund_id}\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**items**\\n\\n*items array*\",\n    \"0-1\": \"\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"h-3\": \"Description\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n**items array** - The below table outlines the fields that are within the items array:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**order_item_id** \\n\\n*string*\",\n    \"1-0\": \"**alt_order_item_id** \\n\\n*string*\",\n    \"2-0\": \"**total_quantity_returned** \\n\\n*integer*\",\n    \"3-0\": \"**order_return_refund_qty** \\n\\n*integer*\",\n    \"4-0\": \"**refund_reason** \\n\\n*string*\",\n    \"5-0\": \"**refund_feedback** \\n\\n*string*\",\n    \"6-0\": \"**notes** \\n\\n*string*\",\n    \"7-0\": \"**refund_amount** \\n\\n*refund_amount object*\",\n    \"0-1\": \"Jet's unique identifier for an item in a merchant order.\",\n    \"1-1\": \"If an alt_order_item_id that has been associated with the order_item_id via the order accept message. If this was not sent in the original order acknowledgement message or the order shipped message, use order_item_id.\",\n    \"2-1\": \"Quantity of the given item that was returned.This quantity should only include the units that were returned to the merchant.\",\n    \"3-1\": \"Quantity of the given item that the merchant wants to refund to the customer.\",\n    \"4-1\": \"The reason the customer initiated the return.\",\n    \"4-2\": \"Must be one of the following values:\\n* wrong quantity received\\n* received wrong item than what was ordered\\n* accidental order\\n* item is damaged/broken\\n* item is defective/does not work properly\\n* shipping box and item are both damaged\\n* item was different than website description\\n* package arrived later than promised delivery date\\n* package never arrived\\n* unwanted gift\\n* unauthorized purchase\\n* better price available\\n* no longer need/want\",\n    \"5-1\": \"The reason this refund is less than the full amount.\",\n    \"5-2\": \"* other - (notes must be used if selected)\\n* 'item damaged' \\n* not shipped in original packaging\\n* customer opened item\",\n    \"6-1\": \"Provide additional information about why the item was refunded for lower than the full amount.\",\n    \"2-2\": \"\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]\n**refund_amount array** - The below table outlines the fields that are within the refund_amount array:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**principal**\\n\\n*float*\",\n    \"1-0\": \"**tax** \\n\\n*float*\",\n    \"2-0\": \"**shipping_cost** \\n\\n*float*\",\n    \"3-0\": \"**shipping_tax** \\n\\n*float*\",\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-1\": \"Amount to be refunded for the given item in USD associated with the item itself. This should be the total cost for this item not the unit cost.\",\n    \"1-1\": \"Amount to be refunded for the given item in USD associated with tax that was charged for the item.\",\n    \"2-1\": \"Amount to be refunded for the given item in USD associated with the shipping cost that was allocated to this item.\",\n    \"3-1\": \"Amount to be refunded for the given item in USD associated with the tax that was charged on shipping.\",\n    \"0-2\": \"Must be greater than or equal to 0\",\n    \"1-2\": \"Must be greater than or equal to 0\",\n    \"2-2\": \"Must be greater than or equal to 0\",\n    \"3-2\": \"Must be greater than or equal to 0\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body: Refunds \\\"Accepted/Rejected\\\"\"\n}\n[/block]\nThe following fields will be added by Jet after the refund is initiated\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**refund_authorization_id**\\n\\n*string*\",\n    \"1-0\": \"**alt_refund_id**\\n\\n*string*\",\n    \"2-0\": \"**refund_status**\\n\\n*string*\",\n    \"3-0\": \"**merchant_order_id**\\n\\n*string*\",\n    \"4-0\": \"**reference_order_id**\\n\\n*string*\",\n    \"5-0\": \"**alt_order_id**\\n\\n*string*\",\n    \"0-1\": \"Jet's human readable return authorization number that may have a small chance of collision overtime.\",\n    \"1-1\": \"The refund ID in the merchant's system associated with this refund.\",\n    \"2-1\": \"Jet's return message for whether the refund was accepted\\n\\nValid Values:\\n* 'rejected - customer card not valid'\\n* 'rejected - refund conflicts with returns policy'\\n* 'accepted' - Refund has been completed\\n* 'processing' - Refund is processing in our system\\n* 'created' - Refund is created in our system\",\n    \"3-1\": \"Jet's unique ID for a given merchant order.\",\n    \"4-1\": \"Jet's human readable merchant order ID that may have a small chance of collision overtime.\",\n    \"5-1\": \"Optional merchant supplied order ID.\",\n    \"2-2\": \"Must be one of the following values:\\n\\n* rejected - customer card not valid'\\n* rejected - refund conflicts with returns policy\\n* accepted\\n* processing\\n* created\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]","sync_unique":"","user":"562e25d24376430d006f1769","childrenPages":[]}

getCheck Refund State


Path Params

refund_authorization_id:
string
The refund_authorization_id received from the previous step
The below shows the response for a GET when checking refund status. The valid values for the {refund_id} are the 16-digit {refund_ids} returned by checking for a created return. [block:api-header] { "type": "basic", "title": "Response Body: Refunds \"Created\"" } [/block] The following fields will come back in the response if provided in the refund creation step POST /refunds/{order_id}/{alt_refund_id} [block:parameters] { "data": { "0-0": "**items**\n\n*items array*", "0-1": "", "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description" }, "cols": 3, "rows": 1 } [/block] **items array** - The below table outlines the fields that are within the items array: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**order_item_id** \n\n*string*", "1-0": "**alt_order_item_id** \n\n*string*", "2-0": "**total_quantity_returned** \n\n*integer*", "3-0": "**order_return_refund_qty** \n\n*integer*", "4-0": "**refund_reason** \n\n*string*", "5-0": "**refund_feedback** \n\n*string*", "6-0": "**notes** \n\n*string*", "7-0": "**refund_amount** \n\n*refund_amount object*", "0-1": "Jet's unique identifier for an item in a merchant order.", "1-1": "If an alt_order_item_id that has been associated with the order_item_id via the order accept message. If this was not sent in the original order acknowledgement message or the order shipped message, use order_item_id.", "2-1": "Quantity of the given item that was returned.This quantity should only include the units that were returned to the merchant.", "3-1": "Quantity of the given item that the merchant wants to refund to the customer.", "4-1": "The reason the customer initiated the return.", "4-2": "Must be one of the following values:\n* wrong quantity received\n* received wrong item than what was ordered\n* accidental order\n* item is damaged/broken\n* item is defective/does not work properly\n* shipping box and item are both damaged\n* item was different than website description\n* package arrived later than promised delivery date\n* package never arrived\n* unwanted gift\n* unauthorized purchase\n* better price available\n* no longer need/want", "5-1": "The reason this refund is less than the full amount.", "5-2": "* other - (notes must be used if selected)\n* 'item damaged' \n* not shipped in original packaging\n* customer opened item", "6-1": "Provide additional information about why the item was refunded for lower than the full amount.", "2-2": "" }, "cols": 3, "rows": 8 } [/block] **refund_amount array** - The below table outlines the fields that are within the refund_amount array: [block:parameters] { "data": { "0-0": "**principal**\n\n*float*", "1-0": "**tax** \n\n*float*", "2-0": "**shipping_cost** \n\n*float*", "3-0": "**shipping_tax** \n\n*float*", "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-1": "Amount to be refunded for the given item in USD associated with the item itself. This should be the total cost for this item not the unit cost.", "1-1": "Amount to be refunded for the given item in USD associated with tax that was charged for the item.", "2-1": "Amount to be refunded for the given item in USD associated with the shipping cost that was allocated to this item.", "3-1": "Amount to be refunded for the given item in USD associated with the tax that was charged on shipping.", "0-2": "Must be greater than or equal to 0", "1-2": "Must be greater than or equal to 0", "2-2": "Must be greater than or equal to 0", "3-2": "Must be greater than or equal to 0" }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "Response Body: Refunds \"Accepted/Rejected\"" } [/block] The following fields will be added by Jet after the refund is initiated [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**refund_authorization_id**\n\n*string*", "1-0": "**alt_refund_id**\n\n*string*", "2-0": "**refund_status**\n\n*string*", "3-0": "**merchant_order_id**\n\n*string*", "4-0": "**reference_order_id**\n\n*string*", "5-0": "**alt_order_id**\n\n*string*", "0-1": "Jet's human readable return authorization number that may have a small chance of collision overtime.", "1-1": "The refund ID in the merchant's system associated with this refund.", "2-1": "Jet's return message for whether the refund was accepted\n\nValid Values:\n* 'rejected - customer card not valid'\n* 'rejected - refund conflicts with returns policy'\n* 'accepted' - Refund has been completed\n* 'processing' - Refund is processing in our system\n* 'created' - Refund is created in our system", "3-1": "Jet's unique ID for a given merchant order.", "4-1": "Jet's human readable merchant order ID that may have a small chance of collision overtime.", "5-1": "Optional merchant supplied order ID.", "2-2": "Must be one of the following values:\n\n* rejected - customer card not valid'\n* rejected - refund conflicts with returns policy\n* accepted\n* processing\n* created" }, "cols": 3, "rows": 6 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



The below shows the response for a GET when checking refund status. The valid values for the {refund_id} are the 16-digit {refund_ids} returned by checking for a created return. [block:api-header] { "type": "basic", "title": "Response Body: Refunds \"Created\"" } [/block] The following fields will come back in the response if provided in the refund creation step POST /refunds/{order_id}/{alt_refund_id} [block:parameters] { "data": { "0-0": "**items**\n\n*items array*", "0-1": "", "h-0": "Field", "h-1": "Description", "h-2": "Validation", "h-3": "Description" }, "cols": 3, "rows": 1 } [/block] **items array** - The below table outlines the fields that are within the items array: [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**order_item_id** \n\n*string*", "1-0": "**alt_order_item_id** \n\n*string*", "2-0": "**total_quantity_returned** \n\n*integer*", "3-0": "**order_return_refund_qty** \n\n*integer*", "4-0": "**refund_reason** \n\n*string*", "5-0": "**refund_feedback** \n\n*string*", "6-0": "**notes** \n\n*string*", "7-0": "**refund_amount** \n\n*refund_amount object*", "0-1": "Jet's unique identifier for an item in a merchant order.", "1-1": "If an alt_order_item_id that has been associated with the order_item_id via the order accept message. If this was not sent in the original order acknowledgement message or the order shipped message, use order_item_id.", "2-1": "Quantity of the given item that was returned.This quantity should only include the units that were returned to the merchant.", "3-1": "Quantity of the given item that the merchant wants to refund to the customer.", "4-1": "The reason the customer initiated the return.", "4-2": "Must be one of the following values:\n* wrong quantity received\n* received wrong item than what was ordered\n* accidental order\n* item is damaged/broken\n* item is defective/does not work properly\n* shipping box and item are both damaged\n* item was different than website description\n* package arrived later than promised delivery date\n* package never arrived\n* unwanted gift\n* unauthorized purchase\n* better price available\n* no longer need/want", "5-1": "The reason this refund is less than the full amount.", "5-2": "* other - (notes must be used if selected)\n* 'item damaged' \n* not shipped in original packaging\n* customer opened item", "6-1": "Provide additional information about why the item was refunded for lower than the full amount.", "2-2": "" }, "cols": 3, "rows": 8 } [/block] **refund_amount array** - The below table outlines the fields that are within the refund_amount array: [block:parameters] { "data": { "0-0": "**principal**\n\n*float*", "1-0": "**tax** \n\n*float*", "2-0": "**shipping_cost** \n\n*float*", "3-0": "**shipping_tax** \n\n*float*", "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-1": "Amount to be refunded for the given item in USD associated with the item itself. This should be the total cost for this item not the unit cost.", "1-1": "Amount to be refunded for the given item in USD associated with tax that was charged for the item.", "2-1": "Amount to be refunded for the given item in USD associated with the shipping cost that was allocated to this item.", "3-1": "Amount to be refunded for the given item in USD associated with the tax that was charged on shipping.", "0-2": "Must be greater than or equal to 0", "1-2": "Must be greater than or equal to 0", "2-2": "Must be greater than or equal to 0", "3-2": "Must be greater than or equal to 0" }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "Response Body: Refunds \"Accepted/Rejected\"" } [/block] The following fields will be added by Jet after the refund is initiated [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**refund_authorization_id**\n\n*string*", "1-0": "**alt_refund_id**\n\n*string*", "2-0": "**refund_status**\n\n*string*", "3-0": "**merchant_order_id**\n\n*string*", "4-0": "**reference_order_id**\n\n*string*", "5-0": "**alt_order_id**\n\n*string*", "0-1": "Jet's human readable return authorization number that may have a small chance of collision overtime.", "1-1": "The refund ID in the merchant's system associated with this refund.", "2-1": "Jet's return message for whether the refund was accepted\n\nValid Values:\n* 'rejected - customer card not valid'\n* 'rejected - refund conflicts with returns policy'\n* 'accepted' - Refund has been completed\n* 'processing' - Refund is processing in our system\n* 'created' - Refund is created in our system", "3-1": "Jet's unique ID for a given merchant order.", "4-1": "Jet's human readable merchant order ID that may have a small chance of collision overtime.", "5-1": "Optional merchant supplied order ID.", "2-2": "Must be one of the following values:\n\n* rejected - customer card not valid'\n* rejected - refund conflicts with returns policy\n* accepted\n* processing\n* created" }, "cols": 3, "rows": 6 } [/block]
{"_id":"56fd2bf327b4321900186ef2","type":"get","updates":[],"__v":0,"createdAt":"2015-11-02T19:22:32.760Z","order":2,"version":"56fd2bf327b4321900186ec6","category":"56fd2bf327b4321900186ecd","parentDoc":null,"sync_unique":"","hidden":false,"slug":"check-refund-status","title":"Check for Created Refunds","user":"562e25d24376430d006f1769","api":{"method":"get","params":[],"results":{"codes":[{"code":"{\n  \"refund_urls\": [\n    \"refunds/1289076123041324\",\n    \"refunds/9087132460512356\"\n  ]\n}","language":"json","status":200}]},"settings":"","url":"/refunds/{status}","auth":"required","examples":{"codes":[]}},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"URL Parameter: Status\"\n}\n[/block]\nThe below shows the response for a GET when requesting refunds. The valid values for the {status} are:\n\n* Created\n* Processing\n* Accepted\n* Rejected\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body\"\n}\n[/block]\nThe following fields are a part of the response body\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**Refund_urls***\\n\\n*string array*\",\n    \"0-1\": \"The list of returns links for the status polled\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]","excerpt":"","link_external":false,"link_url":"","project":"562e25f2e01a430d00c2c91e","githubsync":"","isReference":false,"childrenPages":[]}

getCheck for Created Refunds


[block:api-header] { "type": "basic", "title": "URL Parameter: Status" } [/block] The below shows the response for a GET when requesting refunds. The valid values for the {status} are: * Created * Processing * Accepted * Rejected [block:api-header] { "type": "basic", "title": "Response Body" } [/block] The following fields are a part of the response body [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**Refund_urls***\n\n*string array*", "0-1": "The list of returns links for the status polled" }, "cols": 3, "rows": 1 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "URL Parameter: Status" } [/block] The below shows the response for a GET when requesting refunds. The valid values for the {status} are: * Created * Processing * Accepted * Rejected [block:api-header] { "type": "basic", "title": "Response Body" } [/block] The following fields are a part of the response body [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**Refund_urls***\n\n*string array*", "0-1": "The list of returns links for the status polled" }, "cols": 3, "rows": 1 } [/block]
{"_id":"56fd2bf327b4321900186ee8","order":0,"parentDoc":null,"project":"562e25f2e01a430d00c2c91e","slug":"taxonomy-nodes","sync_unique":"","title":"Call Taxonomy Nodes","updates":[],"excerpt":"","user":"562e25d24376430d006f1769","createdAt":"2015-11-02T19:21:16.404Z","editedParams":true,"version":"56fd2bf327b4321900186ec6","api":{"results":{"codes":[{"name":"","code":"{\n  \"node_urls\": [\n    \"/taxonomy/nodes/2000034\",\n    \"/taxonomy/nodes/2000158\",\n    \"/taxonomy/nodes/2000061\"\n  ]\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","url":"/taxonomy/links/{version}?offset={offset}&limit={limit}","auth":"required","examples":{"codes":[]},"method":"get","params":[{"ref":"","required":false,"desc":"The latest taxonomy update","default":"","type":"string","name":"version","in":"path","_id":"5637b7ac7ca5de0d00286acd"},{"type":"string","name":"offset","in":"path","_id":"5637b7ac7ca5de0d00286acc","ref":"","required":false,"desc":"The first node # you wish to appear in the return","default":""},{"type":"string","name":"limit","in":"path","_id":"5637b7ac7ca5de0d00286acb","ref":"","required":false,"desc":"The number of nodes you wish to be returned. Limit is 1000","default":""}]},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body\"\n}\n[/block]\nThe following fields \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**node_urls**\\n\\n*string array*\",\n    \"0-2\": \"\",\n    \"0-1\": \"List of URLs for all Jet Nodes and the description for those nodes\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]","editedParams2":true,"githubsync":"","isReference":false,"link_external":false,"type":"get","__v":1,"hidden":false,"link_url":"","category":"56fd2bf327b4321900186ece","next":{"description":"","pages":[]},"childrenPages":[]}

getCall Taxonomy Nodes


Path Params

version:
string
The latest taxonomy update
offset:
string
The first node # you wish to appear in the return
limit:
string
The number of nodes you wish to be returned. Limit is 1000
[block:api-header] { "type": "basic", "title": "Response Body" } [/block] The following fields [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**node_urls**\n\n*string array*", "0-2": "", "0-1": "List of URLs for all Jet Nodes and the description for those nodes" }, "cols": 3, "rows": 1 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:api-header] { "type": "basic", "title": "Response Body" } [/block] The following fields [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**node_urls**\n\n*string array*", "0-2": "", "0-1": "List of URLs for all Jet Nodes and the description for those nodes" }, "cols": 3, "rows": 1 } [/block]
{"_id":"56fd2bf327b4321900186ee9","excerpt":"","isReference":false,"slug":"taxonomy-node-ids","sync_unique":"","user":"562e25d24376430d006f1769","editedParams":true,"api":{"method":"get","params":[{"desc":"","default":"","type":"string","name":"node_id","in":"path","_id":"5637b803aa96490d00a64f51","ref":"","required":false}],"results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n  \"jet_node_id\": 9000218,\n  \"jet_node_name\": \"Dresses\",\n  \"jet_node_path\": \"Clothing, Shoes & Accessories/Women's Clothing/Dresses\",\n  \"amazon_node_ids\": [\n    9000990\n  ],\n  \"parent_id\": 9000213,\n  \"jet_level\": 2,\n  \"suggested_tax_code\": \"General Taxable Product\"\n}"},{"status":400,"name":"","code":"{}","language":"json"}]},"settings":"","url":"/taxonomy/nodes/{node_id}","auth":"required","examples":{"codes":[]}},"order":1,"type":"get","updates":["58d193722be0050f0007097c"],"__v":2,"editedParams2":true,"githubsync":"","hidden":false,"parentDoc":null,"title":"Taxonomy Node IDs","body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"5-2\": \"Must be one of the following values:\\n* 2\\n* 1\\n* 0\",\n    \"0-0\": \"**jet_node_id** \\n\\n*integer*\",\n    \"1-0\": \"**jet_node_name** \\n\\n*string*\",\n    \"2-0\": \"**jet_node_path** \\n\\n*string*\",\n    \"3-0\": \"**amazon_node_ids** \\n\\n*integer*\",\n    \"4-0\": \"**parent_id** \\n\\n*integer*\",\n    \"5-0\": \"**jet_level** \\n\\n*integer*\",\n    \"6-0\": \"**suggested_tax_code** \\n\\n*string*\",\n    \"0-1\": \"The Jet node ID representing the category node in Jet's taxonomy\",\n    \"1-1\": \"The name of the\",\n    \"2-1\": \"The Jet node path for the requested node ID\",\n    \"3-1\": \"For reference: the Amazon browse node ID from their browse tree\",\n    \"4-1\": \"The ID of the previous level node that this node is in the browse tree\",\n    \"5-1\": \"How specific the Jet category is.  The higher the level, the more specific the category\\n\\n* 0 = This is the root node (i.e. Video Games)\\n* 1 = This is the first branch off the root node (i.e. Video Games | Consoles) \\n* 2 = This is the second branch off the first node (i.e. Video Games | Consoles | Xbox One)\",\n    \"6-1\": \"The suggested tax related to the Jet node\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]","category":"56fd2bf327b4321900186ece","createdAt":"2015-11-02T19:22:43.145Z","link_external":false,"link_url":"","project":"562e25f2e01a430d00c2c91e","version":"56fd2bf327b4321900186ec6","next":{"pages":[]},"childrenPages":[]}

getTaxonomy Node IDs


Path Params

node_id:
string
[block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "5-2": "Must be one of the following values:\n* 2\n* 1\n* 0", "0-0": "**jet_node_id** \n\n*integer*", "1-0": "**jet_node_name** \n\n*string*", "2-0": "**jet_node_path** \n\n*string*", "3-0": "**amazon_node_ids** \n\n*integer*", "4-0": "**parent_id** \n\n*integer*", "5-0": "**jet_level** \n\n*integer*", "6-0": "**suggested_tax_code** \n\n*string*", "0-1": "The Jet node ID representing the category node in Jet's taxonomy", "1-1": "The name of the", "2-1": "The Jet node path for the requested node ID", "3-1": "For reference: the Amazon browse node ID from their browse tree", "4-1": "The ID of the previous level node that this node is in the browse tree", "5-1": "How specific the Jet category is. The higher the level, the more specific the category\n\n* 0 = This is the root node (i.e. Video Games)\n* 1 = This is the first branch off the root node (i.e. Video Games | Consoles) \n* 2 = This is the second branch off the first node (i.e. Video Games | Consoles | Xbox One)", "6-1": "The suggested tax related to the Jet node" }, "cols": 3, "rows": 7 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "5-2": "Must be one of the following values:\n* 2\n* 1\n* 0", "0-0": "**jet_node_id** \n\n*integer*", "1-0": "**jet_node_name** \n\n*string*", "2-0": "**jet_node_path** \n\n*string*", "3-0": "**amazon_node_ids** \n\n*integer*", "4-0": "**parent_id** \n\n*integer*", "5-0": "**jet_level** \n\n*integer*", "6-0": "**suggested_tax_code** \n\n*string*", "0-1": "The Jet node ID representing the category node in Jet's taxonomy", "1-1": "The name of the", "2-1": "The Jet node path for the requested node ID", "3-1": "For reference: the Amazon browse node ID from their browse tree", "4-1": "The ID of the previous level node that this node is in the browse tree", "5-1": "How specific the Jet category is. The higher the level, the more specific the category\n\n* 0 = This is the root node (i.e. Video Games)\n* 1 = This is the first branch off the root node (i.e. Video Games | Consoles) \n* 2 = This is the second branch off the first node (i.e. Video Games | Consoles | Xbox One)", "6-1": "The suggested tax related to the Jet node" }, "cols": 3, "rows": 7 } [/block]
{"_id":"56fd2bf327b4321900186eea","slug":"taxonomy-node-id-attributes","api":{"settings":"","url":"/taxonomy/nodes/{jet_node_id}/attributes","auth":"required","examples":{"codes":[{"name":"","code":"{\n  \"attributes\": [\n    {\n      \"attribute_id\": 2,\n      \"attribute_description\": \"Color Map\",\n      \"free_text\": false,\n      \"variant\": false,\n      \"values\": [\n        \"Beige\",\n        \"Black\",\n        \"Blue\",\n        \"Brown\",\n        \"Clear\",\n        \"Gold\",\n        \"Green\",\n        \"Grey\",\n        \"Multi-Colored\",\n        \"Orange\",\n        \"Pink\",\n        \"Purple\",\n        \"Red\",\n        \"Silver\",\n        \"White\",\n        \"Yellow\"\n      ]\n    },\n    {\n      \"attribute_id\": 95,\n      \"attribute_description\": \"Count Size\",\n      \"free_text\": true,\n      \"variant\": true,\n      \"validation\": {\n        \"data_type\": \"integer\",\n        \"max_value\": 1000000,\n        \"min_value\": 1\n      }\n    }\n  ]\n}","language":"json"}]},"method":"get","params":[{"in":"path","_id":"5637b8867ca5de0d00286ad0","ref":"","required":false,"desc":"The Jet Node ID from the catalog","default":"","type":"string","name":"jet_node_id"}],"results":{"codes":[{"language":"json","status":200,"name":"","code":"{}"},{"name":"","code":"{}","language":"json","status":400}]}},"category":"56fd2bf327b4321900186ece","editedParams":true,"excerpt":"","link_external":false,"parentDoc":null,"project":"562e25f2e01a430d00c2c91e","__v":2,"createdAt":"2015-11-02T19:24:54.196Z","editedParams2":true,"order":2,"type":"get","version":"56fd2bf327b4321900186ec6","updates":["583cb1160efb0f0f00a085eb","58d1942d175dc22500e32a02"],"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**attributes**\\n\\n*attributes object array*\",\n    \"0-1\": \"The attribute id for a particular Jet node id\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n**attributes object** The following fields are part of the attributes object\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"4-2\": \"\",\n    \"5-2\": \"\",\n    \"6-2\": \"\",\n    \"3-2\": \"\",\n    \"0-2\": \"\",\n    \"1-2\": \"\",\n    \"2-2\": \"\",\n    \"0-0\": \"**attribute_id** \\n\\n*integer*\",\n    \"1-0\": \"**attribute_description** \\n\\n*string*\",\n    \"2-0\": \"**free_text** \\n\\n*boolean*\",\n    \"3-0\": \"**variant** \\n\\n*boolean*\",\n    \"4-0\": \"**values** \\n\\n*string array*\",\n    \"5-0\": \"**units** \\n\\n*string array*\",\n    \"6-0\": \"**validation** \\n\\n*validation object*\",\n    \"0-1\": \"The ID number for an attribute\",\n    \"1-1\": \"The description of an attribute\",\n    \"6-1\": \"Additional validation rules if the attribute is free text\",\n    \"5-1\": \"A list of possible units associated with the attribute\",\n    \"4-1\": \"A list of possible attribute values if the free text is not accepted\",\n    \"3-1\": \"Indicates whether the attribute is a variant\",\n    \"2-1\": \"Indicates whether the field accepts free text. If the attribute does not accept free text, it will be validated against a list of values\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]","githubsync":"","isReference":false,"link_url":"","sync_unique":"","title":"Category's Attribute Mapping","hidden":false,"user":"562e25d24376430d006f1769","childrenPages":[]}

getCategory's Attribute Mapping


Path Params

jet_node_id:
string
The Jet Node ID from the catalog
[block:api-header] { "type": "basic", "title": "Response Body" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**attributes**\n\n*attributes object array*", "0-1": "The attribute id for a particular Jet node id" }, "cols": 3, "rows": 1 } [/block] **attributes object** The following fields are part of the attributes object [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "4-2": "", "5-2": "", "6-2": "", "3-2": "", "0-2": "", "1-2": "", "2-2": "", "0-0": "**attribute_id** \n\n*integer*", "1-0": "**attribute_description** \n\n*string*", "2-0": "**free_text** \n\n*boolean*", "3-0": "**variant** \n\n*boolean*", "4-0": "**values** \n\n*string array*", "5-0": "**units** \n\n*string array*", "6-0": "**validation** \n\n*validation object*", "0-1": "The ID number for an attribute", "1-1": "The description of an attribute", "6-1": "Additional validation rules if the attribute is free text", "5-1": "A list of possible units associated with the attribute", "4-1": "A list of possible attribute values if the free text is not accepted", "3-1": "Indicates whether the attribute is a variant", "2-1": "Indicates whether the field accepts free text. If the attribute does not accept free text, it will be validated against a list of values" }, "cols": 3, "rows": 7 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "basic", "title": "Response Body" } [/block] [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**attributes**\n\n*attributes object array*", "0-1": "The attribute id for a particular Jet node id" }, "cols": 3, "rows": 1 } [/block] **attributes object** The following fields are part of the attributes object [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "4-2": "", "5-2": "", "6-2": "", "3-2": "", "0-2": "", "1-2": "", "2-2": "", "0-0": "**attribute_id** \n\n*integer*", "1-0": "**attribute_description** \n\n*string*", "2-0": "**free_text** \n\n*boolean*", "3-0": "**variant** \n\n*boolean*", "4-0": "**values** \n\n*string array*", "5-0": "**units** \n\n*string array*", "6-0": "**validation** \n\n*validation object*", "0-1": "The ID number for an attribute", "1-1": "The description of an attribute", "6-1": "Additional validation rules if the attribute is free text", "5-1": "A list of possible units associated with the attribute", "4-1": "A list of possible attribute values if the free text is not accepted", "3-1": "Indicates whether the attribute is a variant", "2-1": "Indicates whether the field accepts free text. If the attribute does not accept free text, it will be validated against a list of values" }, "cols": 3, "rows": 7 } [/block]
{"_id":"56fd2bf327b4321900186efd","next":{"description":"","pages":[]},"sync_unique":"","__v":1,"body":"The bulk reporting feature allows the merchant to request a report which will return to the merchant a JSON file with the requested information.  Jet.com will use this to pass data to the retailer\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"URL Parameter: Report Types\"\n}\n[/block]\nThe following report types can be requested. Additional report types will be added to this framework in the future.\n\n* **ProductStatus**: This report type returns the merchant's catalog with product statuses and substatuses\n* **SalesData**: This report type returns sales data for all SKUs in the merchant's catalog that have the status \"Available for Purchase\" regardless of inventory and when the last price update was. Please see the [SKU Sales Data](https://developer.jet.com/docs/sku-sales-data) schema for more details.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Report Type: ProductStatus\"\n}\n[/block]\nThere is no request body required for this report type.  It will generate a report with the product statuses for the entire catalog.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Report Type: SalesData\"\n}\n[/block]\nThere is no request body required for this report type.  It will generate a report with sales data for the entire catalog.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Report Type: SettlementDetails\"\n}\n[/block]\nThe settlement details report pulls a csv report for all sales and refunds in a settlement period.  The request body is a settlement ID, which can be retrieved after polling for a list of links.  \n\nFor more information about how to retrieve a [settlement ID](doc:settlement-days)\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**settlement_id**\",\n    \"0-1\": \"The settlement report ID associated with a payment period\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\nExample Request Body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n\\t\\\"settlement_id\\\":\\\"43123\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"SettlementDetails\"\n    }\n  ]\n}\n[/block]","editedParams2":true,"link_url":"","isReference":false,"link_external":false,"slug":"create-new-report","user":"562e25d24376430d006f1769","createdAt":"2016-02-01T16:05:03.856Z","editedParams":true,"hidden":false,"updates":[],"order":0,"project":"562e25f2e01a430d00c2c91e","title":"Create New Report","type":"post","parentDoc":null,"version":"56fd2bf327b4321900186ec6","api":{"settings":"","url":"/reports/{report_type}","auth":"required","examples":{"codes":[]},"method":"post","params":[{"type":"string","name":"report_type","in":"path","_id":"56b4a9c97bccae0d00e9a11f","ref":"","required":false,"desc":"The type of report / information requested","default":""}],"results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"report_id\":\"51912c7c5e6c468c945e3f10005fdaff\"\n}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]}},"category":"56fd2bf327b4321900186ed0","excerpt":"","githubsync":"","childrenPages":[]}

postCreate New Report


Path Params

report_type:
string
The type of report / information requested
The bulk reporting feature allows the merchant to request a report which will return to the merchant a JSON file with the requested information. Jet.com will use this to pass data to the retailer [block:api-header] { "type": "basic", "title": "URL Parameter: Report Types" } [/block] The following report types can be requested. Additional report types will be added to this framework in the future. * **ProductStatus**: This report type returns the merchant's catalog with product statuses and substatuses * **SalesData**: This report type returns sales data for all SKUs in the merchant's catalog that have the status "Available for Purchase" regardless of inventory and when the last price update was. Please see the [SKU Sales Data](https://developer.jet.com/docs/sku-sales-data) schema for more details. [block:api-header] { "type": "basic", "title": "Report Type: ProductStatus" } [/block] There is no request body required for this report type. It will generate a report with the product statuses for the entire catalog. [block:api-header] { "type": "basic", "title": "Report Type: SalesData" } [/block] There is no request body required for this report type. It will generate a report with sales data for the entire catalog. [block:api-header] { "type": "basic", "title": "Report Type: SettlementDetails" } [/block] The settlement details report pulls a csv report for all sales and refunds in a settlement period. The request body is a settlement ID, which can be retrieved after polling for a list of links. For more information about how to retrieve a [settlement ID](doc:settlement-days) [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**settlement_id**", "0-1": "The settlement report ID associated with a payment period" }, "cols": 3, "rows": 1 } [/block] Example Request Body [block:code] { "codes": [ { "code": "{\n\t\"settlement_id\":\"43123\"\n}", "language": "json", "name": "SettlementDetails" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



The bulk reporting feature allows the merchant to request a report which will return to the merchant a JSON file with the requested information. Jet.com will use this to pass data to the retailer [block:api-header] { "type": "basic", "title": "URL Parameter: Report Types" } [/block] The following report types can be requested. Additional report types will be added to this framework in the future. * **ProductStatus**: This report type returns the merchant's catalog with product statuses and substatuses * **SalesData**: This report type returns sales data for all SKUs in the merchant's catalog that have the status "Available for Purchase" regardless of inventory and when the last price update was. Please see the [SKU Sales Data](https://developer.jet.com/docs/sku-sales-data) schema for more details. [block:api-header] { "type": "basic", "title": "Report Type: ProductStatus" } [/block] There is no request body required for this report type. It will generate a report with the product statuses for the entire catalog. [block:api-header] { "type": "basic", "title": "Report Type: SalesData" } [/block] There is no request body required for this report type. It will generate a report with sales data for the entire catalog. [block:api-header] { "type": "basic", "title": "Report Type: SettlementDetails" } [/block] The settlement details report pulls a csv report for all sales and refunds in a settlement period. The request body is a settlement ID, which can be retrieved after polling for a list of links. For more information about how to retrieve a [settlement ID](doc:settlement-days) [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**settlement_id**", "0-1": "The settlement report ID associated with a payment period" }, "cols": 3, "rows": 1 } [/block] Example Request Body [block:code] { "codes": [ { "code": "{\n\t\"settlement_id\":\"43123\"\n}", "language": "json", "name": "SettlementDetails" } ] } [/block]
{"_id":"56fd2bf327b4321900186efe","slug":"get-report-status","title":"Report Status","body":"The bulk reporting feature allows the merchant to request a report which will return to the merchant a JSON file with the requested information.  Jet.com will use this to pass data to the retailer\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body: Report \\\"Requested\\\"\"\n}\n[/block]\nThe following fields are part of the response when the report_status is \"requested\"\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-1\": \"The Jet defined merchant ID associated with the merchant account\",\n    \"0-0\": \"**merchant_id***\\n\\n*string*\",\n    \"1-0\": \"**report_id***\\n\\n*string*\",\n    \"2-0\": \"**report_requested_date***\\n\\n*string*\",\n    \"3-0\": \"**report_status***\\n\\n*string*\",\n    \"4-0\": \"**report_type***\\n\\n*string*\",\n    \"1-1\": \"The Jet defined report ID associated with the report requested\",\n    \"2-1\": \"The date the report was requested\",\n    \"3-1\": \"The current status of the report:\\n\\nStatus descriptions:\\n* Requested: the report has been requested by the merchant and is in queue\\n* Ready: the report is ready to be downloaded\\n* Failed: the report could not be generated. Please try again.\\n* Expired: This report is no longer available\",\n    \"3-2\": \"Must be one of the following values:\\n* Requested\\n* Ready\\n* Failed\\n* Expired\",\n    \"4-1\": \"The type of report requested.\\n\\nReport Types:\\n* ProductStatus: Will return the status and substatuses of all SKUs in merchant catalog\",\n    \"4-2\": \"Must be one of the following values:\\n* ProductStatus\\n* SalesData\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n\\* denotes the field always comes back with a response\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Body: Report \\\"Ready\\\"\"\n}\n[/block]\nIf the report moves from \"Requested\" to \"Ready\" the following fields will be added to the response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Validation\",\n    \"0-0\": \"**processing_start***\\n\\n*string*\",\n    \"1-0\": \"**processing_end***\\n\\n*string*\",\n    \"2-0\": \"**report_expiration_date***\\n\\n*string*\",\n    \"3-0\": \"**report_url***\\n\\n*string*\",\n    \"0-1\": \"The date-time the report started processing\",\n    \"1-1\": \"The date-time the report ended processing\",\n    \"2-1\": \"The date the report will no longer be accessible for download.  A new report will need to be requested\",\n    \"3-1\": \"The URL where the report can be downloaded\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\\* denotes the field always comes back with the response","category":"56fd2bf327b4321900186ed0","editedParams":true,"editedParams2":true,"githubsync":"","parentDoc":null,"user":"562e25d24376430d006f1769","version":"56fd2bf327b4321900186ec6","link_url":"","order":1,"api":{"examples":{"codes":[]},"method":"get","params":[{"required":false,"desc":"The Jet defined report ID associated with the requested report","default":"","type":"string","name":"report_id","in":"path","_id":"56b4b8c27761871700654a3d","ref":""}],"results":{"codes":[{"name":"","code":"{\n  \"merchant_id\": \"4a0593d3901d41699d4ae88ba245704a\",\n  \"report_id\": \"a75e0ff812094104880bf7489efd56f2\",\n  \"report_requested_date\": \"2016-02-05T14:52:21.7611387+00:00\",\n  \"report_status\": \"requested\",\n  \"report_type\": \"ProductStatus\"\n}","language":"json","status":200},{"code":"{\n  \"merchant_id\": \"4a0593d3901d41699d4ae88ba245704a\",\n  \"processing_end\": \"2016-02-05T14:52:48.2417939+00:00\",\n  \"processing_start\": \"2016-02-05T14:52:27.9345520+00:00\",\n  \"report_expiration_date\": \"2016-02-06T14:52:48.2417939+00:00\",\n  \"report_id\": \"a75e0ff812094104880bf7489efd56f2\",\n  \"report_requested_date\": \"2016-02-05T14:52:21.7611387+00:00\",\n  \"report_status\": \"ready\",\n  \"report_type\": \"ProductStatus\",\n  \"report_url\": \"https://prodimupload.blob.core.windows.net/merchant-reports/a75e0ff812094104880bf7489efd56f2.gz?sv=2015-04-05&sr=b&sig=AWElm7xTCUBHrrCguGyIgHCU93z4A3ZgkY3DhX3E2Ss%3D&se=2016-02-06T14%3A52%3A48Z&sp=r\"\n}","language":"text","status":200},{"status":400,"language":"json","code":""}]},"settings":"","url":"/reports/state/{report_id}","auth":"required"},"createdAt":"2016-02-03T19:56:29.395Z","excerpt":"","hidden":false,"isReference":false,"link_external":false,"sync_unique":"","__v":0,"project":"562e25f2e01a430d00c2c91e","updates":[],"type":"get","childrenPages":[]}

getReport Status


Path Params

report_id:
string
The Jet defined report ID associated with the requested report
The bulk reporting feature allows the merchant to request a report which will return to the merchant a JSON file with the requested information. Jet.com will use this to pass data to the retailer [block:api-header] { "type": "basic", "title": "Response Body: Report \"Requested\"" } [/block] The following fields are part of the response when the report_status is "requested" [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-1": "The Jet defined merchant ID associated with the merchant account", "0-0": "**merchant_id***\n\n*string*", "1-0": "**report_id***\n\n*string*", "2-0": "**report_requested_date***\n\n*string*", "3-0": "**report_status***\n\n*string*", "4-0": "**report_type***\n\n*string*", "1-1": "The Jet defined report ID associated with the report requested", "2-1": "The date the report was requested", "3-1": "The current status of the report:\n\nStatus descriptions:\n* Requested: the report has been requested by the merchant and is in queue\n* Ready: the report is ready to be downloaded\n* Failed: the report could not be generated. Please try again.\n* Expired: This report is no longer available", "3-2": "Must be one of the following values:\n* Requested\n* Ready\n* Failed\n* Expired", "4-1": "The type of report requested.\n\nReport Types:\n* ProductStatus: Will return the status and substatuses of all SKUs in merchant catalog", "4-2": "Must be one of the following values:\n* ProductStatus\n* SalesData" }, "cols": 3, "rows": 5 } [/block] \* denotes the field always comes back with a response [block:api-header] { "type": "basic", "title": "Response Body: Report \"Ready\"" } [/block] If the report moves from "Requested" to "Ready" the following fields will be added to the response [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**processing_start***\n\n*string*", "1-0": "**processing_end***\n\n*string*", "2-0": "**report_expiration_date***\n\n*string*", "3-0": "**report_url***\n\n*string*", "0-1": "The date-time the report started processing", "1-1": "The date-time the report ended processing", "2-1": "The date the report will no longer be accessible for download. A new report will need to be requested", "3-1": "The URL where the report can be downloaded" }, "cols": 3, "rows": 4 } [/block] \* denotes the field always comes back with the response

Definition

{{ api_url }}{{ page_api_url }}

Result Format



The bulk reporting feature allows the merchant to request a report which will return to the merchant a JSON file with the requested information. Jet.com will use this to pass data to the retailer [block:api-header] { "type": "basic", "title": "Response Body: Report \"Requested\"" } [/block] The following fields are part of the response when the report_status is "requested" [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-1": "The Jet defined merchant ID associated with the merchant account", "0-0": "**merchant_id***\n\n*string*", "1-0": "**report_id***\n\n*string*", "2-0": "**report_requested_date***\n\n*string*", "3-0": "**report_status***\n\n*string*", "4-0": "**report_type***\n\n*string*", "1-1": "The Jet defined report ID associated with the report requested", "2-1": "The date the report was requested", "3-1": "The current status of the report:\n\nStatus descriptions:\n* Requested: the report has been requested by the merchant and is in queue\n* Ready: the report is ready to be downloaded\n* Failed: the report could not be generated. Please try again.\n* Expired: This report is no longer available", "3-2": "Must be one of the following values:\n* Requested\n* Ready\n* Failed\n* Expired", "4-1": "The type of report requested.\n\nReport Types:\n* ProductStatus: Will return the status and substatuses of all SKUs in merchant catalog", "4-2": "Must be one of the following values:\n* ProductStatus\n* SalesData" }, "cols": 3, "rows": 5 } [/block] \* denotes the field always comes back with a response [block:api-header] { "type": "basic", "title": "Response Body: Report \"Ready\"" } [/block] If the report moves from "Requested" to "Ready" the following fields will be added to the response [block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Validation", "0-0": "**processing_start***\n\n*string*", "1-0": "**processing_end***\n\n*string*", "2-0": "**report_expiration_date***\n\n*string*", "3-0": "**report_url***\n\n*string*", "0-1": "The date-time the report started processing", "1-1": "The date-time the report ended processing", "2-1": "The date the report will no longer be accessible for download. A new report will need to be requested", "3-1": "The URL where the report can be downloaded" }, "cols": 3, "rows": 4 } [/block] \* denotes the field always comes back with the response
{"_id":"56fd2bf327b4321900186eff","type":"basic","version":"56fd2bf327b4321900186ec6","__v":3,"link_external":false,"link_url":"","title":"Report Examples","order":2,"parentDoc":null,"sync_unique":"","updates":["576b25aa481fa82b00c06f4c"],"category":"56fd2bf327b4321900186ed0","excerpt":"","githubsync":"","hidden":false,"project":"562e25f2e01a430d00c2c91e","user":"562e25d24376430d006f1769","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example Reports\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"The following are example reports\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n\\t\\\"{user_defined_sku_id}\\\":{\\n    \\\"status\\\":\\\"Under Jet Review\\\",\\n    \\\"substatus\\\":[]\\n  },\\n  \\\"{user_defined_sku_id}\\\":{\\n    \\\"status\\\":\\\"Missing Listing Data\\\",\\n    \\\"substatus\\\":[\\\"Missing brand\\\"]\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"ProductStatus\"\n    },\n    {\n      \"code\": \"{\\n  \\\"{user_defined_sku_id}\\\":{\\n    \\\"jet_browse_node_id_mapped_level_0\\\": 1000000,\\n    \\\"jet_browse_node_id_mapped_level_1\\\": 1000001,\\n    \\\"jet_browse_node_id_mapped_level_2\\\": 1000013,\\n    \\\"sales_rank\\\": {\\n      \\\"level_0\\\": 2000,\\n      \\\"last_update\\\": \\\"2016-02-03T11:48:30.6063244+00:00\\\"\\n    },\\n    \\\"units_sold\\\": {\\n      \\\"last_30_days\\\": 300,\\n      \\\"last_update\\\": \\\"2016-02-03T11:48:30.6063244+00:00\\\"\\n    },\\n    \\\"my_best_offer\\\": [{\\n      \\\"shipping_method\\\": null,\\n      \\\"item_price\\\": 20.99,\\n      \\\"shipping_price\\\": 4.00,\\n      \\\"last_update\\\": \\\"2016-02-03T11:48:30.6063244+00:00\\\"\\n    }],\\n    \\\"best_marketplace_offer\\\": [{\\n      \\\"shipping_method\\\": null,\\n      \\\"item_price\\\": 15.00,\\n      \\\"shipping_price\\\": 0.00,\\n      \\\"last_update\\\": \\\"2016-02-03T11:48:30.6063244+00:00\\\"\\n    }]\\n  },\\n  \\\"{user_defined_sku_id}\\\":{\\n    \\\"jet_browse_node_id_mapped_level_0\\\": 1000000,\\n    \\\"jet_browse_node_id_mapped_level_1\\\": 1000001,\\n    \\\"jet_browse_node_id_mapped_level_2\\\": 1000013,\\n    \\\"sales_rank\\\": {\\n      \\\"level_0\\\": 1435,\\n      \\\"last_update\\\": \\\"2016-02-03T11:48:30.6063244+00:00\\\"\\n    },\\n    \\\"units_sold\\\": {\\n      \\\"last_30_days\\\": 235,\\n      \\\"last_update\\\": \\\"2016-02-03T11:48:30.6063244+00:00\\\"\\n    },\\n    \\\"my_best_offer\\\": [{\\n      \\\"shipping_method\\\": null,\\n      \\\"item_price\\\": 9.99,\\n      \\\"shipping_price\\\": 1.00,\\n      \\\"last_update\\\": \\\"2016-02-03T11:48:30.6063244+00:00\\\"\\n    }],\\n    \\\"best_marketplace_offer\\\": [{\\n      \\\"shipping_method\\\": null,\\n      \\\"item_price\\\": 9.00,\\n      \\\"shipping_price\\\": 0.00,\\n      \\\"last_update\\\": \\\"2016-02-03T11:48:30.6063244+00:00\\\"\\n    }]\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"SalesData\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","createdAt":"2016-02-05T14:01:03.467Z","isReference":false,"slug":"report-examples","childrenPages":[]}

Report Examples


[block:api-header] { "type": "basic", "title": "Example Reports", "sidebar": true } [/block] [block:textarea] { "text": "The following are example reports", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n\t\"{user_defined_sku_id}\":{\n \"status\":\"Under Jet Review\",\n \"substatus\":[]\n },\n \"{user_defined_sku_id}\":{\n \"status\":\"Missing Listing Data\",\n \"substatus\":[\"Missing brand\"]\n }\n}", "language": "json", "name": "ProductStatus" }, { "code": "{\n \"{user_defined_sku_id}\":{\n \"jet_browse_node_id_mapped_level_0\": 1000000,\n \"jet_browse_node_id_mapped_level_1\": 1000001,\n \"jet_browse_node_id_mapped_level_2\": 1000013,\n \"sales_rank\": {\n \"level_0\": 2000,\n \"last_update\": \"2016-02-03T11:48:30.6063244+00:00\"\n },\n \"units_sold\": {\n \"last_30_days\": 300,\n \"last_update\": \"2016-02-03T11:48:30.6063244+00:00\"\n },\n \"my_best_offer\": [{\n \"shipping_method\": null,\n \"item_price\": 20.99,\n \"shipping_price\": 4.00,\n \"last_update\": \"2016-02-03T11:48:30.6063244+00:00\"\n }],\n \"best_marketplace_offer\": [{\n \"shipping_method\": null,\n \"item_price\": 15.00,\n \"shipping_price\": 0.00,\n \"last_update\": \"2016-02-03T11:48:30.6063244+00:00\"\n }]\n },\n \"{user_defined_sku_id}\":{\n \"jet_browse_node_id_mapped_level_0\": 1000000,\n \"jet_browse_node_id_mapped_level_1\": 1000001,\n \"jet_browse_node_id_mapped_level_2\": 1000013,\n \"sales_rank\": {\n \"level_0\": 1435,\n \"last_update\": \"2016-02-03T11:48:30.6063244+00:00\"\n },\n \"units_sold\": {\n \"last_30_days\": 235,\n \"last_update\": \"2016-02-03T11:48:30.6063244+00:00\"\n },\n \"my_best_offer\": [{\n \"shipping_method\": null,\n \"item_price\": 9.99,\n \"shipping_price\": 1.00,\n \"last_update\": \"2016-02-03T11:48:30.6063244+00:00\"\n }],\n \"best_marketplace_offer\": [{\n \"shipping_method\": null,\n \"item_price\": 9.00,\n \"shipping_price\": 0.00,\n \"last_update\": \"2016-02-03T11:48:30.6063244+00:00\"\n }]\n }\n}", "language": "json", "name": "SalesData" } ], "sidebar": true } [/block]
[block:api-header] { "type": "basic", "title": "Example Reports", "sidebar": true } [/block] [block:textarea] { "text": "The following are example reports", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n\t\"{user_defined_sku_id}\":{\n \"status\":\"Under Jet Review\",\n \"substatus\":[]\n },\n \"{user_defined_sku_id}\":{\n \"status\":\"Missing Listing Data\",\n \"substatus\":[\"Missing brand\"]\n }\n}", "language": "json", "name": "ProductStatus" }, { "code": "{\n \"{user_defined_sku_id}\":{\n \"jet_browse_node_id_mapped_level_0\": 1000000,\n \"jet_browse_node_id_mapped_level_1\": 1000001,\n \"jet_browse_node_id_mapped_level_2\": 1000013,\n \"sales_rank\": {\n \"level_0\": 2000,\n \"last_update\": \"2016-02-03T11:48:30.6063244+00:00\"\n },\n \"units_sold\": {\n \"last_30_days\": 300,\n \"last_update\": \"2016-02-03T11:48:30.6063244+00:00\"\n },\n \"my_best_offer\": [{\n \"shipping_method\": null,\n \"item_price\": 20.99,\n \"shipping_price\": 4.00,\n \"last_update\": \"2016-02-03T11:48:30.6063244+00:00\"\n }],\n \"best_marketplace_offer\": [{\n \"shipping_method\": null,\n \"item_price\": 15.00,\n \"shipping_price\": 0.00,\n \"last_update\": \"2016-02-03T11:48:30.6063244+00:00\"\n }]\n },\n \"{user_defined_sku_id}\":{\n \"jet_browse_node_id_mapped_level_0\": 1000000,\n \"jet_browse_node_id_mapped_level_1\": 1000001,\n \"jet_browse_node_id_mapped_level_2\": 1000013,\n \"sales_rank\": {\n \"level_0\": 1435,\n \"last_update\": \"2016-02-03T11:48:30.6063244+00:00\"\n },\n \"units_sold\": {\n \"last_30_days\": 235,\n \"last_update\": \"2016-02-03T11:48:30.6063244+00:00\"\n },\n \"my_best_offer\": [{\n \"shipping_method\": null,\n \"item_price\": 9.99,\n \"shipping_price\": 1.00,\n \"last_update\": \"2016-02-03T11:48:30.6063244+00:00\"\n }],\n \"best_marketplace_offer\": [{\n \"shipping_method\": null,\n \"item_price\": 9.00,\n \"shipping_price\": 0.00,\n \"last_update\": \"2016-02-03T11:48:30.6063244+00:00\"\n }]\n }\n}", "language": "json", "name": "SalesData" } ], "sidebar": true } [/block]