{ "info": { "_postman_id": "35e1f931-a95b-4a1c-9652-9e6cf49214c2", "name": "Public API Tiendanube", "description": "This collection represents all examples of tiendanube's / nuvemshop's public API.\n\n \n**📘 API Versioning Notes**\n\nThe default value for `{{api_version}}` is set to `2025-03`, the latest stable release. \n \nMost endpoints in this collection use this version automatically via the `{{api_version}}` variable.\n\nHowever, some endpoints are only available in previous versions (e.g., `v1`). \n \nIn those specific cases, the version is hardcoded directly in the request URL.\n\nPartners should keep using the default version unless a specific endpoint requires otherwise. \n \nWe recommend updating `{{api_version}}` as new API versions are released. \nFull reference: [https://tiendanube.github.io/api-documentation/versioning](https://tiendanube.github.io/api-documentation/versioning)", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Authorization", "item": [ { "name": "Get Store ID and Access Token from a store", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"client_id\": \"0000\",\n \"client_secret\": \"xxxxxxxx\",\n \"grant_type\": \"authorization_code\",\n \"code\": \"xxxxxxxx\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://www.tiendanube.com/apps/authorize/token", "protocol": "https", "host": [ "www", "tiendanube", "com" ], "path": [ "apps", "authorize", "token" ] } }, "response": [] } ] }, { "name": "Abandoned Checkout", "item": [ { "name": "Receive all abandoned carts", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {} } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Awesome App (awesome@app.com)", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/checkouts/", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "checkouts", "" ] } }, "response": [] }, { "name": "Receive a specific abandoned cart", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Awesome App (awesome@app.com)", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/checkouts/{{cart_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "checkouts", "{{cart_id}}" ] } }, "response": [] }, { "name": "Create a discount coupon to the abandoned cart", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {} } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Awesome App (awesome@app.com)", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"coupon_id\": 1924499\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/checkouts/{{cart_id}}/coupon", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "checkouts", "{{cart_id}}", "coupon" ] } }, "response": [] } ], "description": "Resource available starting from API version **`v1`**.\n\nThe abandoned checkout is created when the customer reaches checkout's seconds step, but for some reason it does not finish the process." }, { "name": "Billing", "item": [ { "name": "Create a new plan", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{client_secret}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\", //Currency code of the subscription\n \"external_reference\": \"\", // Optional, field left open for you to set up your own id\n \"description\": \"\" // Optional, short description of the plan\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/apps/{{app_id}}/plans", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "apps", "{{app_id}}", "plans" ] } }, "response": [] }, { "name": "Updates an existing plan", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{client_secret}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\", //Currency code of the subscription\n \"external_reference\": \"\", // Field left open for you to set up your own id\n \"description\": \"\" // Short description of the plan\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/apps/{{app_id}}/plans/{{plan_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "apps", "{{app_id}}", "plans", "{{plan_id}}" ] } }, "response": [] }, { "name": "Deletes a plan", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{client_secret}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/apps/{{app_id}}/plans/{{plan_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "apps", "{{app_id}}", "plans", "{{plan_id}}" ] } }, "response": [] }, { "name": "Retrieves the subscription for a specific user.", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/concepts/{{concept_code}}/services/{{service_id}}/subscriptions", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "concepts", "{{concept_code}}", "services", "{{service_id}}", "subscriptions" ] } }, "response": [] }, { "name": "Updates subscription details", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"concept_code\": \"\", // Concept code of the subscription to patch\n \"service_id\": \"\" // ID of the service; If the service is an app, the app_id\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/concepts/{{concept_code}}/services/{{service_id}}/subscriptions", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "concepts", "{{concept_code}}", "services", "{{service_id}}", "subscriptions" ] } }, "response": [] }, { "name": "Creates an additional charge", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"teste\", // Short description for the charge\n \"external_reference\": \"extra-external\", // This field is open if you want to use it as an id for the charge\n \"from_date\": \"2025-06-15\", // Date of the start of the period\n \"to_date\": \"2025-07-15\", // Date of the end of the period\n \"amount_value\": 10000, // Price of the charge (number)\n \"amount_currency\": \"ARS\", // Currency code of the subscription\n \"concept_code\": \"extra\" // Concept code for the charge\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/services/{{service_id}}/charges", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "services", "{{service_id}}", "charges" ] } }, "response": [] } ], "description": "Resource available starting from API version **`2025-03`**.\n\nThis section of the API enables you to:\n\n- Manage the **plans** you offer to your service’s users.\n \n- Handle **subscriptions** for your customers. This will be used to create the charges for your fixed fee periodically.\n \n- Create **extra charges** to bill for any additional expenses related to your service.\n \n\n## Entities[​](https://tiendanube.github.io/api-documentation/resources/billing#entities)\n\n1. **Plan**[​](https://tiendanube.github.io/api-documentation/resources/billing#plan)\n \n A plan defines the level of service a customer can subscribe to and is part of the pricing model. Each plan may include different features, limits, and prices.\n \n2. **Subscriptions**[​](https://tiendanube.github.io/api-documentation/resources/billing#subscriptions)\n \n A subscription is the link between the customer (or “merchant”) and the service. It automatically generates periodic charges to cover the service’s cost. The field `next_execution` on the subscription informs the date when the new charge will be created.\n \n3. **Business Unit**[​](https://tiendanube.github.io/api-documentation/resources/billing#business-unit)\n \n Represents the partner. Each Business Unit can define its own plans with its own pricing model for a given service.\n \n4. **Service (also known as Business Unit Service)**[​](https://tiendanube.github.io/api-documentation/resources/billing#service-also-known-as-business-unit-service)\n \n The service provided by a Business Unit. An application created by a partner would be the “Service”." }, { "name": "Business Rules", "item": [ { "name": "Receive all shipping carriers options", "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})" } ], "body": { "mode": "raw", "raw": "{\n \"command\": \"filter_shipping_options\",\n \"detail\": {\n \"filtered_options\": [\n {\n \"id\": \"a748b98962625b232bcb6469cf3c6a56\",\n \"option_id\": \"10985354\",\n \"code\": \"shipnow_pap_estandar\"\n },\n {\n \"id\": \"74b2063777f690dfa4f4e377836aeb42\",\n \"option_id\": \"6810831\",\n \"code\": \"table-6810831\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/shipping_carriers/options", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "shipping_carriers", "options" ] } }, "response": [] }, { "name": "Receive all payment options", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/payment_providers/options", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "payment_providers", "options" ] } }, "response": [] }, { "name": "Create a shipping callback for a given store.", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://my_shipping_callback.com\",\n \"event\": \"shipping/before-filter\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/business_rules/integrations/shipping", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "business_rules", "integrations", "shipping" ] } }, "response": [] }, { "name": "Create a payment callback for a given store.", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://my_payment_callback.com\",\n \"event\": \"payments/before-filter\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/business_rules/integrations/payments", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "business_rules", "integrations", "payments" ] } }, "response": [] }, { "name": "Create a location callback for a given store.", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://my_location_callback.com\",\n \"event\": \"location/prioritization\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/business_rules/integrations/location", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "business_rules", "integrations", "location" ] } }, "response": [] } ], "description": "Resource available starting from API version **`v1`**.\n\nThe Business Rules API offers the ability to define different business behaviours for the `shipping` and `payments` domains through a set of conditions.\n\nWhen the merchant installs the app, the app must authenticate with `Nuvemshop` and create and individual `Callback` for the domain it supports and for the store that triggered the installation. These Callbacks represent the URL that we are going to consult when applying the rules to know what shipping options, payment options, etc. are applied at checkout." }, { "name": "Cart", "item": [ { "name": "Remove a line item from a cart by its line item id", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {} } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/carts/{{cart_id}}/line-items/{{line-item_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "carts", "{{cart_id}}", "line-items", "{{line-item_id}}" ] } }, "response": [] }, { "name": "Unset a coupon from a cart by its coupon id", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {} } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/carts/{{cart_id}}/coupons/{{coupon_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "carts", "{{cart_id}}", "coupons", "{{coupon_id}}" ] } }, "response": [] }, { "name": "Receive a single cart by its id", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript", "packages": {} } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true }, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/carts/{{cart_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "carts", "{{cart_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version **`v1`**.\n\nThe Cart resource allows the manipulation of shopping carts generated in a storefront.\n\nYou need the `write_orders` scope in order to call these endpoints." }, { "name": "Category", "item": [ { "name": "Receive a list of all categories", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/categories", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "categories" ] } }, "response": [] }, { "name": "Receive a list of all categories filtering the fields", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/categories?fields=id,name,subcategories", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "categories" ], "query": [ { "key": "fields", "value": "id,name,subcategories" } ] } }, "response": [] }, { "name": "Receive a single category", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/categories/{{category_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "categories", "{{category_id}}" ] } }, "response": [] }, { "name": "Create a new category", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": {\n \"en\": \"Gen I\",\n \"es\": \"Gen I\",\n \"pt\": \"Gen I\"\n },\n \"parent\": 4567 \n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/categories", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "categories" ] } }, "response": [] }, { "name": "Modify an existing category", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 5678,\n \"parent\": null\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/categories/{{category_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "categories", "{{category_id}}" ] } }, "response": [] }, { "name": "Remove a category", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/categories/{{category_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "categories", "{{category_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version **`v1`**.\n\nA Category lets the store owner group his/her products to make the store easier to browse.\n\nA Category lets the store owner group his/her products to make the store easier to browse.\n\n## Properties\n\n| Property | Explanation |\n| --- | --- |\n| id | The unique numeric identifier for the Category |\n| name | List of the names of the Category, in every language supported by the store |\n| descripton | List of the descriptions of the Category, as HTML, in every language supported by the store |\n| handle | List of the url-friendly strings generated from the Category's names, in every language supported by the store |\n| parent | Id of the Category's parent. _null_ if it has no parent |\n| subcategories | The ids of the Category's first level subcategories |\n| created_at | Date when the Category was created in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601) |\n| updated_at | Date when the Category was last updated in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601) |" }, { "name": "Category Custom Fields", "item": [ { "name": "Create a new custom field", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Material type\",\n \"description\": \"Material type of this category products\",\n \"value_type\": \"text_list\",\n \"read_only\": false,\n \"values\": [\n \"Cotton\",\n \"Linen\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/categories/custom-fields", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "categories", "custom-fields" ] } }, "response": [] }, { "name": "Receive a list of all categories custom fields", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true }, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/categories/custom-fields", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "categories", "custom-fields" ] } }, "response": [] }, { "name": "Modify the custom field values", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"values\": [\n \"Silk\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/categories/custom-fields/{{custom-field_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "categories", "custom-fields", "{{custom-field_id}}" ] } }, "response": [] }, { "name": "Modify a value associated with a category.", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"e0a56bef-91d0-45f7-a70d-6b9264c85e8c\",\n \"value\": \"Cotton\"\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/categories/{{category_id}}/custom-fields/values", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "categories", "{{category_id}}", "custom-fields", "values" ] } }, "response": [] }, { "name": "Receive the custom fields associated with a specific category", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true }, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/categories/{{category_id}}/custom-fields", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "categories", "{{category_id}}", "custom-fields" ] } }, "response": [] }, { "name": "Receive the categories associated with a specific custom field", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true }, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/categories/custom-fields/{{custom-field_id}}/owners", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "categories", "custom-fields", "{{custom-field_id}}", "owners" ] } }, "response": [] }, { "name": "Receive the data of a given category custom field", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true }, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/categories/custom-fields/{{custom-field_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "categories", "custom-fields", "{{custom-field_id}}" ] } }, "response": [] }, { "name": "Remove a custom field", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/categories/custom-fields/{{custom-field_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "categories", "custom-fields", "{{custom-field_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version **`v1`**.\n\nA custom field allows the store owner/merchant to expand their experience and control their own business through personalized and unique custom fields for categories.\n\n## Properties\n\n| Property | Explanation |\n| --- | --- |\n| id | The unique universal identifier for the custom field |\n| name | Name of the custom field |\n| description | Description of the custom field |\n| value_type | Custom field type (text_list, text, numeric, date) |\n| owner_resource | Custom field owner (`category`) |\n| read_only | If set to true, it restricts the association of the custom field by merchants via the administrator panel, the merchant can only read the value associated with the custom field. (default value is false) |\n| values | A list of all values for a custom field (for value_type text_list only, for other types can be an empty array) |" }, { "name": "Coupon", "item": [ { "name": "Receive a list of all coupon", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/coupons", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "coupons" ] } }, "response": [] }, { "name": "Receive a list of all valid coupon", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/coupons?valid=true", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "coupons" ], "query": [ { "key": "valid", "value": "true" } ] } }, "response": [] }, { "name": "Receive a single coupon", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/coupons/{{coupon_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "coupons", "{{coupon_id}}" ] } }, "response": [] }, { "name": "Create a new coupon", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"PRUEBA\",\n \"type\": \"percentage\",\n \"value\": \"30.00\",\n \"max_uses\": 100,\n \"min_price\": 10,\n \"categories\": null,\n \"start_date\": \"2014-05-08\",\n \"end_date\": \"2014-06-08\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/coupons", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "coupons" ] } }, "response": [] }, { "name": "Modify an existing coupon", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"OTRAPRUEBA\", \n \"type\": \"absolute\", \n \"value\": 50\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/coupons/{{coupon_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "coupons", "{{coupon_id}}" ] } }, "response": [] }, { "name": "Remove an existing coupon", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/coupons/{{coupon_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "coupons", "{{coupon_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version **`v1`**.\n\nA discount coupon is a way for a store to provide discounts for its customers. There are three type of coupons. Percentage, absolute and shipping. The percentage type indicates that the value is a percentage discount. The type absolute indicates that the value is an absolute amount of discount. And finally the type shipping indicates that the discount value is on the shipping.\n\n## Properties\n\n| Property | Explanation |\n| --- | --- |\n| id | The unique numeric identifier for the coupon. |\n| code | String that identifies the coupon. |\n| type | Type of the coupon. Can take the following values: percentage, absolute or shipping. |\n| valid | Flag (true or false) that indicates if the coupon is valid or not. |\n| start_date | Date from which the coupon is valid. |\n| end_date | Date of overdue of the coupon. |\n| deleted_at | Date when the coupon was deleted. The value is NULL if the coupon is still valid. |\n| max_uses | Max number of times the coupon can be used. |\n| value | Value of the discount |\n| min_price | Indicates the minimun value of the bill for applying the discount |\n| categories | List of [Category](https://github.com/tiendanube/api-docs/blob/master/resources/category.md) objects representing the categories of the store where the discount applies. |" }, { "name": "Customer", "item": [ { "name": "Receive a list of all customers", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/customers", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "customers" ] } }, "response": [] }, { "name": "Receive a list of all customers with since ID", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/customers?since_id=105", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "customers" ], "query": [ { "key": "since_id", "value": "105" } ] } }, "response": [] }, { "name": "Receive a single customer", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/customers/{{customer_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "customers", "{{customer_id}}" ] } }, "response": [] }, { "name": "Create a new customer", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"First Last\",\n \"email\": \"first.last@example.com\",\n \"addresses\": [\n {\n \"address\": \"My Street\",\n \"city\": \"My City\",\n \"country\": \"BR\",\n \"locality\": \"Morumbi\",\n \"number\": \"123\",\n \"phone\": \"11 1234-5678\",\n \"province\": \"São Paulo\",\n \"zipcode\": \"05653-071\"\n }\n ],\n \"send_email_invite\": true,\n \"password\": \"mysupersecretpassword\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/customers", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "customers" ] } }, "response": [] }, { "name": "Modify an existing customer", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"created_at\": \"2013-01-03T09:11:51-03:00\",\n \"email\": \"john.doe+modified@example.com\",\n \"id\": 101,\n \"identification\": \"28776255670\",\n \"last_order_id\": 9001,\n \"name\": \"John Doe\",\n \"note\": null,\n \"phone\": \"911\",\n \"total_spent\": \"89.00\",\n \"total_spent_currency\": \"USD\",\n \"billing_address\": \"Evergreen Terrace\",\n \"billing_city\": \"Springfield\",\n \"billing_country\": \"US\",\n \"billing_floor\": null,\n \"billing_locality\": null,\n \"billing_number\": \"742\",\n \"billing_phone\": \"555-123-0413\",\n \"billing_province\": \"Oregon\",\n \"billing_zipcode\": \"97475\",\n \"extra\": {\n \"number_of_children\": \"2\",\n \"gender\": \"male\"\n },\n \"updated_at\": \"2013-03-11T09:14:11-03:00\",\n \"default_address\": {\n \"address\": \"Evergreen Terrace\",\n \"city\": \"Springfield\",\n \"country\": \"US\",\n \"created_at\": \"2013-01-03T09:11:51-03:00\",\n \"default\": true,\n \"floor\": null,\n \"id\": 1234,\n \"locality\": null,\n \"number\": \"742\",\n \"phone\": \"555-123-0413\",\n \"province\": \"Oregon\",\n \"updated_at\": \"2013-03-10T11:13:01-03:00\",\n \"zipcode\": \"97475\"\n },\n \"addresses\": [\n {\n \"address\": \"Evergreen Terrace\",\n \"city\": \"Springfield\",\n \"country\": \"US\",\n \"created_at\": \"2013-01-03T09:11:51-03:00\",\n \"floor\": null,\n \"id\": 1234,\n \"locality\": null,\n \"number\": \"742\",\n \"phone\": \"555-123-0413\",\n \"province\": \"Oregon\",\n \"updated_at\": \"2013-03-10T11:13:01-03:00\",\n \"zipcode\": \"97475\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/customers/{{customer_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "customers", "{{customer_id}}" ] } }, "response": [] }, { "name": "Delete a single customer", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/customers/{{customer_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "customers", "{{customer_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version **`v1`**.\n\nA Customer of the store. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout.\n\n## Properties\n\n| Property | Explanation |\n| --- | --- |\n| id | The unique numeric identifier for the Customer |\n| name | Name of the Customer |\n| email | E-mail of the Customer |\n| phone | Phone number of the customer (not necessarily the same as the address's phone) |\n| identification | Customer's identification (in Brazil for example, it would be the CPF/CNPJ) |\n| note | Store owner's notes about the customer |\n| default_address | Default shipping address of the Customer |\n| addresses | List of shipping addresses for the Customer |\n| billing_address | Billing address of the Customer |\n| billing_number | Billing number of the Customer |\n| billing_floor | Billing floor of the Customer |\n| billing_locality | Billing locality of the Customer |\n| billing_zipcode | Billing zipcode of the Customer |\n| billing_city | Billing city of the Customer |\n| billing_province | Billing province of the Customer |\n| billing_country | Billing country code of the Customer |\n| extra | A JSON object containing custom information. Can be set via the API or through custom form fields of name \"extra\\[key\\]\" on the Customer's register form in the storefront. |\n| total_spent | The total amount of money that the Customer has spent at the store |\n| total_spent_currency | The total spent's currency in [ISO 4217 format](http://en.wikipedia.org/wiki/ISO_4217) |\n| last_order_id | The id of the Customer's last Order |\n| active | \"true\" if the Customer activated his account. \"false\" if he/she hasn't |\n| created_at | Date when the Customer was created in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601) |\n| updated_at | Date when the Customer was last updated in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601) |" }, { "name": "Customer Custom Fields", "item": [ { "name": "Create a new custom field", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Client type\",\n \"description\": \"Indicates the type of customer\",\n \"value_type\": \"text_list\",\n \"read_only\": false,\n \"values\": [\"Wholesale\", \"Retail\"]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/customers/custom-fields", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "customers", "custom-fields" ] } }, "response": [] }, { "name": "Receive a list of all custom fields from a specific owner resource", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true }, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/customers/custom-fields", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "customers", "custom-fields" ] } }, "response": [] }, { "name": "Modify the custom field values", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"values\": [\n \"Wholesale + Retail\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/customers/custom-fields/{{custom-field_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "customers", "custom-fields", "{{custom-field_id}}" ] } }, "response": [] }, { "name": "Receive the custom fields associated with a specific customer", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true }, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/customers/{{customer_id}}/custom-fields", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "customers", "{{customer_id}}", "custom-fields" ] } }, "response": [] }, { "name": "Receive the customers associated with a specific custom field", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true }, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/customers/custom-fields/{{custom-field_id}}/owners", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "customers", "custom-fields", "{{custom-field_id}}", "owners" ] } }, "response": [] }, { "name": "Modify a value associated with a customer.", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"79d76ab8-fdee-4e03-96c8-7ae666496f69\",\n \"value\": \"Retail\"\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/customers/{{customer_id}}/custom-fields/values", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "customers", "{{customer_id}}", "custom-fields", "values" ] } }, "response": [] }, { "name": "Remove a custom field", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/customers/custom-fields/{{custom-field_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "customers", "custom-fields", "{{custom-field_id}}" ] } }, "response": [] }, { "name": "Receive the data of a given customer custom field", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true }, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/customers/custom-fields/{{custom-field_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "customers", "custom-fields", "{{custom-field_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version **`v1`**.\n\nA custom field allows the store owner/merchant to expand their experience and control their own business through personalized and unique custom fields for customers.\n\n## Properties\n\n| Property | Explanation |\n| --- | --- |\n| id | The unique universal identifier for the custom field |\n| name | Name of the custom field |\n| description | Description of the custom field |\n| value_type | Custom field type (text_list, text, numeric, date) |\n| owner_resource | Custom field owner (`customer`) |\n| read_only | If set to true, it restricts the association of the custom field by merchants via the administrator panel, the merchant can only read the value associated with the custom field. (default value is false) |\n| values | A list of all values for a custom field (for value_type text_list only, for other types can be an empty array) |" }, { "name": "Discounts", "item": [ { "name": "Promotion", "item": [ { "name": "Create a new promotion", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"50% off in the second unit\",\n \"allocation_type\": \"line_item\",\n \"description\": \"Taking two pay 50 percent on the second unit\",\n \"disclaimer\": \"Deal only valid for Buenos Aires city\",\n \"active\": true,\n \"translations\": [\n {\n \"lang\": \"en-us\",\n \"name\": \"50% off in the second unit\",\n \"description\": \"Taking two pay 50 percent on the second unit\",\n \"disclaimer\": \"Deal only valid for Buenos Aires city\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{store_id}}/promotions", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{store_id}}", "promotions" ] }, "description": "Create a promotion for the current store" }, "response": [ { "name": "The promotion has been created", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"50% off in the second unit\",\n \"allocation_type\": \"line_item\",\n \"description\": \"Taking two pay 50 percent on the second unit\",\n \"disclaimer\": \"Deal only valid for Buenos Aires city\",\n \"active\": true,\n \"translations\": [\n {\n \"lang\": \"es-ar\",\n \"name\": \"50% off in the second unit\",\n \"description\": \"Taking two pay 50 percent on the second unit\",\n \"disclaimer\": \"Deal only valid for Buenos Aires city\"\n },\n {\n \"lang\": \"es-ar\",\n \"name\": \"50% off in the second unit\",\n \"description\": \"Taking two pay 50 percent on the second unit\",\n \"disclaimer\": \"Deal only valid for Buenos Aires city\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{store_id}}/promotions", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{store_id}}", "promotions" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"id\": \"e855b201-be35-496c-8aed-28c6f1de840d\"\n }\n}" }, { "name": "Unable to process the request sent", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"50% off in the second unit\",\n \"allocation_type\": \"line_item\",\n \"description\": \"Taking two pay 50 percent on the second unit\",\n \"disclaimer\": \"Deal only valid for Buenos Aires city\",\n \"active\": true,\n \"translations\": [\n {\n \"lang\": \"es-ar\",\n \"name\": \"50% off in the second unit\",\n \"description\": \"Taking two pay 50 percent on the second unit\",\n \"disclaimer\": \"Deal only valid for Buenos Aires city\"\n },\n {\n \"lang\": \"es-ar\",\n \"name\": \"50% off in the second unit\",\n \"description\": \"Taking two pay 50 percent on the second unit\",\n \"disclaimer\": \"Deal only valid for Buenos Aires city\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{store_id}}/promotions", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{store_id}}", "promotions" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"status\": 400,\n \"code\": \"BadRequestException\",\n \"detail\": [\n \"name must be a string\",\n \"name must be a string\"\n ]\n }\n}" } ] }, { "name": "Delete a promotion", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{store_id}}/promotions/{{promotion_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{store_id}}", "promotions", "{{promotion_id}}" ] }, "description": "Delete a promotion created by the current app for the current store" }, "response": [ { "name": "The promotion has been deleted", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "https://{{api_url}}/{{store_id}}/promotions/{{promotion_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{store_id}}", "promotions", "{{promotion_id}}" ], "variable": [ { "key": "promotion_id", "value": "ullamco pariatur irure" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The __store__/__app__ provided does not belong to promotion", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "https://{{api_url}}/{{store_id}}/promotions/{{promotion_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{store_id}}", "promotions", "{{promotion_id}}" ], "variable": [ { "key": "promotion_id", "value": "ullamco pariatur irure" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"status\": 403,\n \"code\": \"ForbiddenException\",\n \"detail\": \"Forbidden resource\"\n }\n}" } ] }, { "name": "Modify a promotion", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"active\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{store_id}}/promotions/{{promotion_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{store_id}}", "promotions", "{{promotion_id}}" ] }, "description": "Modify a promotion created by the current app for the current store" }, "response": [ { "name": "The promotion has been modified", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"active\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{store_id}}/promotions/{{promotion_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{store_id}}", "promotions", "{{promotion_id}}" ], "variable": [ { "key": "promotion_id", "value": "ullamco pariatur irure" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "The __store__/__app__ provided does not belong to promotion", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"active\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{store_id}}/promotions/{{promotion_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{store_id}}", "promotions", "{{promotion_id}}" ], "variable": [ { "key": "promotion_id", "value": "ullamco pariatur irure" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"status\": 403,\n \"code\": \"ForbiddenException\",\n \"detail\": \"Forbidden resource\"\n }\n}" }, { "name": "The promotion does not exist", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"active\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{store_id}}/promotions/{{promotion_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{store_id}}", "promotions", "{{promotion_id}}" ], "variable": [ { "key": "promotion_id", "value": "ullamco pariatur irure" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"status\": 404,\n \"code\": \"NotFoundException\",\n \"detail\": \"The promotion id does not exist\"\n }\n}" } ] } ] }, { "name": "Callbacks", "item": [ { "name": "Register a callback", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"{{callback_url}}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{store_id}}/discounts/callbacks", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{store_id}}", "discounts", "callbacks" ] }, "description": "Create or Update a callback" }, "response": [ { "name": "The callback has been created or updated", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://www.callback.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/discounts/callbacks", "host": [ "{{baseUrl}}" ], "path": [ "discounts", "callbacks" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unable to process the request sent", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://www.callback.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/discounts/callbacks", "host": [ "{{baseUrl}}" ], "path": [ "discounts", "callbacks" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"status\": 400,\n \"code\": \"BadRequestException\",\n \"detail\": [\n \"laborum ea nisi velit officia\",\n \"enim\"\n ]\n }\n}" } ] } ] }, { "name": "Shopping Cart", "item": [ { "name": "Evaluate cart", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cart_id\": \"397256730\",\n \"store_id\": \"92760\",\n \"execution_tier\": \"cross_items\",\n \"customer\": {\n \"id\": \"velit dolore reprehenderit\"\n },\n \"currency\": \"ARS\",\n \"language\": \"es\",\n \"shipping\": {\n \"country\": \"esse ipsum nulla\",\n \"city\": \"do\",\n \"postalcode\": \"Ut et ea esse ut\",\n \"cost\": \"0.00\"\n },\n \"package\": {\n \"weight\": \"0.600\"\n },\n \"payment\": {\n \"credit_card_company\": \"exercitation cupidatat ea\",\n \"method\": \"irure dolore sunt cupidatat enim\",\n \"installments\": \"nostrud consectetur Ut su\"\n },\n \"products\": [\n {\n \"id\": 467422732,\n \"price\": \"12.00\",\n \"compare_at_price\": \"20.00\",\n \"product_id\": 17310718,\n \"quantity\": 4,\n \"free_shipping\": false,\n \"variant_id\": 33739098,\n \"variant_values\": [\n \"S\",\n \"S\"\n ],\n \"categories\": [\n {\n \"id\": 11353744,\n \"parent\": -2349673.045864448,\n \"subcategories\": [\n \"tempor\",\n \"est ut\"\n ]\n },\n {\n \"id\": 11353744,\n \"parent\": -56752377.9158877,\n \"subcategories\": [\n \"minim eiusmod consequat ut ut\",\n \"sunt consectetur occaecat\"\n ]\n }\n ]\n },\n {\n \"id\": 467422732,\n \"price\": \"12.00\",\n \"compare_at_price\": \"20.00\",\n \"product_id\": 17310718,\n \"quantity\": 4,\n \"free_shipping\": false,\n \"variant_id\": 33739098,\n \"variant_values\": [\n \"S\",\n \"S\"\n ],\n \"categories\": [\n {\n \"id\": 11353744,\n \"parent\": -57576331.17694758,\n \"subcategories\": [\n \"est\",\n \"cillum labore amet\"\n ]\n },\n {\n \"id\": 11353744,\n \"parent\": 68049658.71524912,\n \"subcategories\": [\n \"quis labore\",\n \"est\"\n ]\n }\n ]\n }\n ],\n \"totals\": {\n \"subtotal\": \"30000.00\",\n \"total_discount\": \"10300.00\",\n \"total\": \"19700.00\"\n },\n \"promotions\": {\n \"id\": \"231bbfe4-31bc-11ec-8d3d-0242ac130003\",\n \"line_items\": [\n \"467422732\",\n \"467422732\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{callback_url}}", "host": [ "{{callback_url}}" ] }, "description": "The owner of this endpoint is the discount application. It could be any URL of your choice." }, "response": [ { "name": "The callback has detected one or more commands to execute", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"cart_id\": \"397256730\",\n \"store_id\": \"92760\",\n \"execution_tier\": \"cross_items\",\n \"customer\": {\n \"id\": \"ea proident in\"\n },\n \"currency\": \"ARS\",\n \"language\": \"es\",\n \"shipping\": {\n \"country\": \"u\",\n \"city\": \"Excepteur reprehenderit esse\",\n \"postalcode\": \"anim nulla proident\",\n \"cost\": \"0.00\"\n },\n \"package\": {\n \"weight\": \"0.600\"\n },\n \"payment\": {\n \"credit_card_company\": \"esse dolor\",\n \"method\": \"cupidatat qui Ut\",\n \"installments\": \"Duis sunt ullamco mollit\"\n },\n \"products\": [\n {\n \"id\": 467422732,\n \"price\": \"12.00\",\n \"compare_at_price\": \"20.00\",\n \"product_id\": 17310718,\n \"quantity\": 4,\n \"free_shipping\": false,\n \"variant_id\": 33739098,\n \"variant_values\": [\n \"S\",\n \"S\"\n ],\n \"categories\": [\n {\n \"id\": 11353744,\n \"parent\": 5373951.936786041,\n \"subcategories\": [\n \"incidi\",\n \"nulla dolor\"\n ]\n },\n {\n \"id\": 11353744,\n \"parent\": 95408180.2899696,\n \"subcategories\": [\n \"non nostrud mollit sint dolore\",\n \"occaecat\"\n ]\n }\n ]\n },\n {\n \"id\": 467422732,\n \"price\": \"12.00\",\n \"compare_at_price\": \"20.00\",\n \"product_id\": 17310718,\n \"quantity\": 4,\n \"free_shipping\": false,\n \"variant_id\": 33739098,\n \"variant_values\": [\n \"S\",\n \"S\"\n ],\n \"categories\": [\n {\n \"id\": 11353744,\n \"parent\": -6184289.7967721075,\n \"subcategories\": [\n \"aliqua velit\",\n \"cupidatat deserun\"\n ]\n },\n {\n \"id\": 11353744,\n \"parent\": -40022743.837492846,\n \"subcategories\": [\n \"sit\",\n \"anim culpa veniam\"\n ]\n }\n ]\n }\n ],\n \"totals\": {\n \"subtotal\": \"30000.00\",\n \"total_discount\": \"10300.00\",\n \"total\": \"19700.00\"\n },\n \"promotions\": {\n \"id\": \"231bbfe4-31bc-11ec-8d3d-0242ac130003\",\n \"line_items\": [\n \"467422732\",\n \"467422732\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{callback_url}}", "host": [ "{{callback_url}}" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"commands\": [\n {\n \"command\": \"create_or_update_discount\",\n \"specs\": {\n \"promotion_id\": \"449039b3-3c35-4860-8fde-668428ced5f3\",\n \"currency\": \"ARS\",\n \"display_text\": {\n \"es-ar\": \"50% off in the second unit\"\n },\n \"discount_specs\": {\n \"type\": \"fixed\",\n \"amount\": \"20.00\"\n }\n }\n },\n {\n \"command\": \"create_or_update_discount\",\n \"specs\": {\n \"promotion_id\": \"449039b3-3c35-4860-8fde-668428ced5f3\",\n \"currency\": \"ARS\",\n \"display_text\": {\n \"es-ar\": \"50% off in the second unit\"\n },\n \"discount_specs\": {\n \"type\": \"fixed\",\n \"amount\": \"20.00\"\n }\n }\n }\n ]\n}" }, { "name": "The callback has not detected any commands to execute", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"cart_id\": \"397256730\",\n \"store_id\": \"92760\",\n \"execution_tier\": \"cross_items\",\n \"customer\": {\n \"id\": \"ea proident in\"\n },\n \"currency\": \"ARS\",\n \"language\": \"es\",\n \"shipping\": {\n \"country\": \"u\",\n \"city\": \"Excepteur reprehenderit esse\",\n \"postalcode\": \"anim nulla proident\",\n \"cost\": \"0.00\"\n },\n \"package\": {\n \"weight\": \"0.600\"\n },\n \"payment\": {\n \"credit_card_company\": \"esse dolor\",\n \"method\": \"cupidatat qui Ut\",\n \"installments\": \"Duis sunt ullamco mollit\"\n },\n \"products\": [\n {\n \"id\": 467422732,\n \"price\": \"12.00\",\n \"compare_at_price\": \"20.00\",\n \"product_id\": 17310718,\n \"quantity\": 4,\n \"free_shipping\": false,\n \"variant_id\": 33739098,\n \"variant_values\": [\n \"S\",\n \"S\"\n ],\n \"categories\": [\n {\n \"id\": 11353744,\n \"parent\": 5373951.936786041,\n \"subcategories\": [\n \"incidi\",\n \"nulla dolor\"\n ]\n },\n {\n \"id\": 11353744,\n \"parent\": 95408180.2899696,\n \"subcategories\": [\n \"non nostrud mollit sint dolore\",\n \"occaecat\"\n ]\n }\n ]\n },\n {\n \"id\": 467422732,\n \"price\": \"12.00\",\n \"compare_at_price\": \"20.00\",\n \"product_id\": 17310718,\n \"quantity\": 4,\n \"free_shipping\": false,\n \"variant_id\": 33739098,\n \"variant_values\": [\n \"S\",\n \"S\"\n ],\n \"categories\": [\n {\n \"id\": 11353744,\n \"parent\": -6184289.7967721075,\n \"subcategories\": [\n \"aliqua velit\",\n \"cupidatat deserun\"\n ]\n },\n {\n \"id\": 11353744,\n \"parent\": -40022743.837492846,\n \"subcategories\": [\n \"sit\",\n \"anim culpa veniam\"\n ]\n }\n ]\n }\n ],\n \"totals\": {\n \"subtotal\": \"30000.00\",\n \"total_discount\": \"10300.00\",\n \"total\": \"19700.00\"\n },\n \"promotions\": {\n \"id\": \"231bbfe4-31bc-11ec-8d3d-0242ac130003\",\n \"line_items\": [\n \"467422732\",\n \"467422732\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{callback_url}}", "host": [ "{{callback_url}}" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] } ], "description": "Resource available starting from API version **`v1`**.\n\nThe Discount API is a set of tools that allows the development of a wide range of promotional rules." }, { "name": "Disputes", "item": [ { "name": "Received a single dispute", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/transactions/{{transaction_id}}/disputes/{{dispute_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "transactions", "{{transaction_id}}", "disputes", "{{dispute_id}}" ] } }, "response": [] }, { "name": "Create a new dispute", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"reason_code\": \"\", // Code that identifies the reason why the dispute was created\n \"external_reason_code\": \"\", // Code that identifies the reason for the dispute according to the card operator.\n \"amount\": \"\", // Amount of the dispute.\n \"evidence_url\": \"\", // HTTPS URL to access dispute details on the payment provider.\n \"evidence_sent_at\": \"\", // Date when the evidence for the dispute was sent.\n \"initiated_at\": \"\", // Date when the dispute was registered.\n \"evidence_due_at\": \"\" // Deadline to submit evidence for the dispute.\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/transactions/{{transaction_id}}/disputes", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "transactions", "{{transaction_id}}", "disputes" ] } }, "response": [] }, { "name": "Update an existing dispute", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"\", // Status of the dispute.\n \"evidence_url\": \"\", // HTTPS URL to access dispute details on the payment provider.\n \"evidence_sent_at\": \"\", // Date when the evidence for the dispute was sent.\n \"closed_at\": \"\" // Date when the dispute was closed.\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/transactions/{{transaction_id}}/disputes/{{dispute_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "transactions", "{{transaction_id}}", "disputes", "{{dispute_id}}" ] } }, "response": [] } ], "description": "Resource only available in unstable version.\n\nThe Dispute API is designed to collect chargeback data from our Payments partners whenever a financial dispute is initiated. With this API, partners can create up to three disputes for a specific store, order, and transaction, including details such as the reason, evidence, and dispute amount. Additionally, the API supports updating the status and evidence of a dispute and retrieving details for a single dispute." }, { "name": "Draft Order", "item": [ { "name": "List all draft orders", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/draft_orders", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "draft_orders" ] } }, "response": [] }, { "name": "Get a draft order", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/draft_orders/{{draft_order_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "draft_orders", "{{draft_order_id}}" ] } }, "response": [] }, { "name": "Create a draft order", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{ \n \"products\": [\n { \n \"quantity\": 3,\n \"variant_id\": 278090150 \n }\n ],\n \"contact_email\": \"john.doe@example.com\",\n \"contact_name\": \"John\",\n \"contact_lastname\": \"Doe\",\n \"contact_phone\": \"+55 11 99999-9999\", \n \"payment_status\" : \"unpaid\" \n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/draft_orders", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "draft_orders" ] } }, "response": [] }, { "name": "Confirm a draft order and converts it to an order", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/draft_orders/{{draft_order_id}}/confirm", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "draft_orders", "{{draft_order_id}}", "confirm" ] } }, "response": [] }, { "name": "Remove a draft order", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/draft_orders/{{draft_order_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "draft_orders", "{{draft_order_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version `v1`.\n\nA draft order enables create orders through outside channels. \nProperties\n\n---\n\n| Property | Explanation |\n| --- | --- |\n| id | The unique numeric identifier for the draft order. |\n| token | Specifies the location of the draft order. |\n| store_id | The unique numeric identifier for the Store. |\n| abandoned_checkout_url | Checkout url for the abandoned cart. Only when creating a draft order. |\n| shipping_min_days | The minimum number of weekdays needed for the order to be delivered. |\n| shipping_max_days | The maximum number of weekdays needed for the order to be delivered. |\n| billing_name | Billing customer name for the draft order. |\n| billing_phone | Billing phone for the draft order. |\n| billing_address | Billing address for the draft order. |\n| billing_number | Billing number for the draft order. |\n| billing_floor | Billing floor for the draft order. |\n| billing_locality | Billing locality for the draft order. |\n| billing_city | Billing city for the draft order. |\n| billing_province | Billing province for the draft order. |\n| billing_country | Billing country code for the draft order. |\n| shipping_cost_owner | The shipping cost the store owner has to pay to the shipping company. |\n| shipping_cost_customer | The shipping cost the customer has to pay to the store owner. |\n| coupon | List of coupons applied to the draft order. |\n| promotional_discount | [Promotional Discount](#Promotional-Discount) applied to the draft order. |\n| subtotal | Price of the order before shipping. |\n| discount | Total value of the discount applied to the price of the draft order. |\n| discount_coupon | Total value of the coupon discount applied to the price of the draft order. |\n| discount_gateway | Total value of the gateway discount applied to the price of the draft order. |\n| total | Total price of the draft order including shipping and discounts. |\n| total_usd | Total price of the order in US dollars. |\n| checkout_enabled | Indicates if checkout is enabled for draft order. |\n| weight | Draft order's total weight, in kilograms. |\n| currency | The total spent's currency in [ISO 4217 format](http://en.wikipedia.org/wiki/ISO_4217). |\n| language | Draft Order's language used by the customer. |\n| gateway | Payment gateway code. It is set as not provided. |\n| gateway_id | The unique numeric identifier for the gateway. |\n| shipping | The shipping method used. |\n| shipping_option | The shipping option chosen by the customer. |\n| shipping_option_code | The shipping option code selected by the consumers. |\n| shipping_option_reference | The shipping option reference provided by a custom shipping carrier during the checkout process. |\n| shipping_pickup_details | The shipping pickup details (address and/or business hours) of the selected pickup point. |\n| shipping_tracking_number | Shipment's tracking number provided by the shipping company. |\n| shipping_tracking_url | Shipment's tracking URL provided by the shipping company. |\n| shipping_store_branch_name | If order is going to be picked up, shows the store branch name. |\n| shipping_pickup_type | \"ship\" if the order is going to be shipped; \"pickup\" if it's going to be picked up from a store branch. |\n| shipping_suboption | List of suboptions chosen for the shipping method. |\n| extra | A JSON object containing custom information. Can be set via the API or through custom form fields of name \"extra\\[key\\]\" on the cart's checkout form in the storefront. |\n| storefront | Origin of the order. Possible values are \"store\", \"meli\", \"api\" or \"form\". A draft order is always \"form\". |\n| note | Customer's note about the draft order. |\n| created_at | Date when the draft order was created in [ISO 8601 format](http://es.wikipedia.org/wiki/ISO_8601). |\n| updated_at | Date when the draft order was last updated in [ISO 8601 format](http://es.wikipedia.org/wiki/ISO_8601). |\n| completed_at | A JSON object containing the date when the draft order was confirm. |\n| next_action | Next available operation in the draft orders flow. A draft order is always \"noop\". |\n| payment_details | A JSON object containing payment details. |\n| attributes | Line item properties. |\n| customer | [Customer](https://github.com/tiendanube/api-docs/blob/master/resources/customer.md) that purchased this draft order. Only given if the 'read_customers' scope is set for the app. |\n| products | List of the [Products](#Products) purchased by the `customer`. Contents are explained below and values hold are the ones corresponding to the time the products were purchased. |\n| clearsale | Information on risk management. Only applies to stores in Brazil. |\n| number | Unique number identifier for an order used by the shop owner and customers. |\n| cancel_reason | Reason why the store owner cancelled an Order. Possible values are \"customer\", \"fraud\", \"inventory\" or \"other\". |\n| owner_note | Merchant owner's note about the draft order. |\n| cancelled_at | Date when the draft order was cancelled in [ISO 8601 format](http://es.wikipedia.org/wiki/ISO_8601). |\n| closed_at | Date when the draft order was closed in [ISO 8601 format](http://es.wikipedia.org/wiki/ISO_8601). |\n| read_at | Date when the merchant view the draft order for first time in [ISO 8601 format](http://es.wikipedia.org/wiki/ISO_8601). |\n| status | Draft order's status. Possible values are \"open\", \"closed\" or \"cancelled\". |\n| payment_status | Draft order's payment status. Possible values are \"pending\", \"pending_confirmation\" or \"paid\". |\n| shipping_address | Shipping address for the draft order. |\n| shipping_status | Draft order's shipping status. A draft order is always \"unpackaged\". |\n| shipped_at | Date when the draft order was shipped in [ISO 8601 format](http://es.wikipedia.org/wiki/ISO_8601). |\n| paid_at | Date when the draft order was paid in [ISO 8601 format](http://es.wikipedia.org/wiki/ISO_8601). |\n| landing_url | Store url. |\n| client_details | Customer details for analytics. |\n| app_id | The unique numeric identifier for the app. |\n| checkout_url | Url of the checkout corresponding to the draft order. |" }, { "name": "Email Templates", "item": [ { "name": "Retrieves all email templates from the store. This endpoint does not support pagination.", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/email-templates", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "email-templates" ] } }, "response": [] }, { "name": "Retrieves a specific email template by its ID.", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/email-templates/{{email_template_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "email-templates", "{{email_template_id}}" ] } }, "response": [] }, { "name": "Updates an existing email template by its ID.", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"html_enabled\": true,\n \"subject\": {\n \"es\": \"Asunto en Español\",\n \"pt\": \"Assunto em Português\"\n },\n \"template_html\": {\n \"es\": \"

Plantilla HTML en Español

\",\n \"pt\": \"

Modelo HTML em Português

\"\n },\n \"template_text\": {\n \"es\": \"Plantilla de texto en Español\",\n \"pt\": \"Modelo de texto em Português\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/email-templates/{{email_template_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "email-templates", "{{email_template_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version `2025-03`.\n\nThe **Email Templates resource** allows merchants to customize the email notifications sent to their customers. These templates control the content and appearance of various automated emails, including order confirmations, shipping notifications, password resets, and more. Each template can be configured with both plain text and HTML versions, and supports multiple languages through localization.\n\n---\n\n| Property | Explanation |\n| --- | --- |\n| id | Unique identifier of the email template. |\n| type | Type of the email template. Possible values are:
\\- abandonedcheckoutrecover: Template for recovering abandoned checkouts
\\- customer_activate_account: Template for customer account activation
\\- customer_reset_password: Template for password reset requests
\\- customer_welcome_account: Template for welcoming new customers
\\- ordercancelled: Template for cancelled orders
\\- ordercaptured: Template for captured orders
\\- orderconfirmation: Template for order confirmation
\\- ordershipped: Template for shipped orders |\n| html_enabled | Whether the template supports HTML content. |\n| subject | Checkout url for the abandoned cart. Only when creating a draft order. |\n| template_text | The minimum number of weekdays needed for the order to be delivered. |\n| template_html | The maximum number of weekdays needed for the order to be delivered. |" }, { "name": "Fulfillment Order", "item": [ { "name": "Receive all Order Fulfillments from a specific Order", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/fulfillment-orders", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "fulfillment-orders" ] } }, "response": [] }, { "name": "Receive a single Fulfillment Order By ID", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/fulfillment-orders/{{fulfillment_order_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "fulfillment-orders", "{{fulfillment_order_id}}" ] } }, "response": [] }, { "name": "Modify the information of the Fulfillment Order", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"PACKED\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/fulfillment-orders/{{fulfillment_order_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "fulfillment-orders", "{{fulfillment_order_id}}" ] } }, "response": [] }, { "name": "Remove a Fulfillment Order by ID", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/fulfillment-orders/{{fulfillment_order_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "fulfillment-orders", "{{fulfillment_order_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version `v1`.\n\nAn order can now have multiple shipments. Each shipment is described in a new entity called Fulfillment Order.\n\n## Scopes\n\n| Property | Explanation |\n| --- | --- |\n| read_fulfillment_orders | Allows you to read actions of one or more fulfillment orders for a merchant. |\n| write_fulfillment_orders | Allows you to write actions of one or more fulfillment orders for a merchant. |\n\n---\n\n## Properties\n\nLink with details: [https://tiendanube.github.io/api-documentation/resources/fulfillment-order#properties](https://tiendanube.github.io/api-documentation/resources/fulfillment-order#properties)." }, { "name": "Fulfillment Order Event", "item": [ { "name": "Receive the all Fulfillment Orders Tracking Events", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/fulfillment-orders/{{fulfillment_order_id}}/tracking-events", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "fulfillment-orders", "{{fulfillment_order_id}}", "tracking-events" ] } }, "response": [] }, { "name": "Receive a single Fulfillment Order Tracking Event with ID", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/fulfillment-orders/{{fulfillment_order_id}}/tracking-events/{{fulfillment_event_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "fulfillment-orders", "{{fulfillment_order_id}}", "tracking-events", "{{fulfillment_event_id}}" ] } }, "response": [] }, { "name": "Create Fulfillment Order Tracking Event", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"delivered\",\n \"description\": \"El paquete está en camino\",\n \"address\": \"Esmeralda 3807, Buenos Aires - Argentina\",\n \"geolocation\": {\n \"longitude\": 73.856077,\n \"latitude\": 40.848447\n },\n \"happened_at\": \"2024-01-05T10:20:19+00:00\",\n \"estimated_delivery_at\": \"2024-01-05T18:20:19+00:00\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/fulfillment-orders/{{fulfillment_order_id}}/tracking-events", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "fulfillment-orders", "{{fulfillment_order_id}}", "tracking-events" ] } }, "response": [] }, { "name": "Modify the Fulfillment Order Tracking Event", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"in_transit\",\n \"description\": \"The package was sent to cd address.\",\n \"address\": \"St. Paul 123, São Paulo - Brazil 02910802\",\n \"geolocation\": {\n \"longitude\": 73.856077,\n \"latitude\": 40.848447\n },\n \"happened_at\": \"2022-11-24T10:20:19+00:00\",\n \"estimated_delivery_at\": \"2022-11-24T10:20:19+00:00\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/fulfillment-orders/{{fulfillment_order_id}}/tracking-events/{{fulfillment_event_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "fulfillment-orders", "{{fulfillment_order_id}}", "tracking-events", "{{fulfillment_event_id}}" ] } }, "response": [] }, { "name": "Remove a single Fulfillment Order Tracking Event", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/fulfillment-orders/{{fulfillment_order_id}}/tracking-events/{{fulfillment_event_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "fulfillment-orders", "{{fulfillment_order_id}}", "tracking-events", "{{fulfillment_event_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version `v1`. \nScopes\n\n| Property | Explanation |\n| --- | --- |\n| read_fulfillment_orders | Allows you to read actions of one or more fulfillment orders for a merchant. |\n| write_fulfillment_orders | Allows you to write actions of one or more fulfillment orders for a merchant. |" }, { "name": "Location", "item": [ { "name": "Receive a list of all Locations", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/locations", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "locations" ] } }, "response": [] }, { "name": "Receive a single Location with ID", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/locations/{{location_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "locations", "{{location_id}}" ] } }, "response": [] }, { "name": "Create a new Location", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": {\n \"es_AR\": \"Nombre en espanol\",\n \"pt_BR\": \"Nome em português\",\n \"en_US\": \"Name in english\"\n },\n \"address\": {\n \"zipcode\": \"1605\",\n \"street\": \"Calle\",\n \"number\": \"123\",\n \"floor\": null,\n \"locality\": \"Munro\",\n \"reference\": \"REF12\",\n \"between_streets\": \"Calle 2 y Calle 3\",\n \"city\": \"Buenos Aires\",\n \"province\": {\n \"code\": \"B\",\n \"name\": \"Buenos Aires\"\n },\n \"region\": {\n \"code\": \"ALL\",\n \"name\": \"Todos\"\n },\n \"country\": {\n \"code\": \"AR\",\n \"name\": \"Argentina\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/locations", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "locations" ] } }, "response": [] }, { "name": "Change priorities of all existing locations from store. On change priority the Location with priority 0 will be updated as default.", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"01HSY0PDQCTWCEKH6Y23W0P2VR\",\n \"priority\": 0\n },\n {\n \"id\": \"01HSY0MVKDRAXEZ45B91EGVEJX\",\n \"priority\": 2\n },\n {\n \"id\": \"01HSY0PNSV30VZ9F35VCDE0C52\",\n \"priority\": 1\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/locations/priorities", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "locations", "priorities" ] } }, "response": [] }, { "name": "Modify an existing Location", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": {\n \"es_AR\": \"Florida\",\n \"pt_BR\": \"Florida\",\n \"en_US\": \"Florida\"\n },\n \"address\": {\n \"zipcode\": \"1604\",\n \"street\": \"Calle\",\n \"number\": \"123\",\n \"floor\": null,\n \"locality\": \"Florida Oeste\",\n \"reference\": \"REF12\",\n \"between_streets\": \"Entre calle 2 y calle 3\",\n \"city\": \"Buenos Aires\",\n \"province\": {\n \"code\": \"B\",\n \"name\": \"Buenos Aires\"\n },\n \"region\": {\n \"code\": \"ALL\",\n \"name\": \"Todos\"\n },\n \"country\": {\n \"code\": \"AR\",\n \"name\": \"Argentina\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/locations/{{location_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "locations", "{{location_id}}" ] } }, "response": [] }, { "name": "Delete an existing Location", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/locations/{{location_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "locations", "{{location_id}}" ] } }, "response": [] }, { "name": "Change an existing Location to default and priority 0, and repreorize other locations. For the change to be successfull the Location should have priority greatter than 0.", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/locations/{{location_id}}/chosen-as-default", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "locations", "{{location_id}}", "chosen-as-default" ] } }, "response": [] }, { "name": "Receive the inventory levels assigned to a particular Location.", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true }, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/locations/{{location_id}}/inventory_levels", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "locations", "{{location_id}}", "inventory_levels" ] } }, "response": [] } ], "description": "Resource available starting from API version `v1`.\n\nA Location of the store where physical goods reside.\n\n---\n\n## Scopes\n\n| Property | Explanation |\n| --- | --- |\n| read_locations | Required for all GET resources. |\n| write_locations | Required for all POST/PUT/DELETE resources. |\n| read_locations+read_products | Required for all GET resources with inventory levels. eg.: GET /locations/{id}/inventory-levels. |\n\n---\n\n## Properties\n\n| Property | Explanation |\n| --- | --- |\n| id | The unique numeric identifier for the Location. |\n| name | Localized Location Name. |\n| address | The Address of the Location. |\n| is_default | \"true\" if it is the default Location, \"false\" otherwise. |\n| priority | Priority of the location to assign stock during checkout. The lower the value the higher the priority. |\n| created_at | Date when the Location was created in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601). |\n| updated_at | Date when the Location was last updated in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601). |" }, { "name": "Metafield", "item": [ { "name": "Receive a list of all metafield", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/metafields", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "metafields" ], "query": [ { "key": "updated_at_max", "value": "2024-06-23T23:59:59-03:00", "disabled": true } ] } }, "response": [] }, { "name": "Receive a list of all metafield filtering results", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/metafields/{{owner_resource}}?per_page=3&owner_id=2856934&created_at_min=2013-01-01T00:00:00-03:00&fields=owner_id,key,value", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "metafields", "{{owner_resource}}" ], "query": [ { "key": "per_page", "value": "3" }, { "key": "owner_id", "value": "2856934" }, { "key": "created_at_min", "value": "2013-01-01T00:00:00-03:00" }, { "key": "fields", "value": "owner_id,key,value" } ] } }, "response": [] }, { "name": "Receive a single metafield", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/metafields/{{metafield_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "metafields", "{{metafield_id}}" ] } }, "response": [] }, { "name": "Create a new metafield", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"key\": \"key\",\n \"value\": \"value\",\n \"namespace\": \"namespace\",\n \"description\": \"description\",\n \"owner_id\": \"2857023\",\n \"owner_resource\": \"Product\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/metafields", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "metafields" ] } }, "response": [] }, { "name": "Modify an existing metafield", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"modified\",\n \"description\": \"description modified\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/metafields/{{metafield_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "metafields", "{{metafield_id}}" ] } }, "response": [] }, { "name": "Remove an existing metafield", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/metafields/{{metafield_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "metafields", "{{metafield_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version `v1`.\n\nThe metafields are Namespaced Key - Value store for Apps.\n\nThe metafields can only be associated with the following entities:\n\n- Product\n \n- Product_Variant\n \n- Category\n \n- Page\n \n- Order\n \n- Customer\n \n\nTo do that you need to set the owner_resource to one of the above, an example would be owner_resource='Product'.\n\nAn use example would be use it in an app for Bookstores that require associate a book (product) with it's author and genre to provide an advanced search of books by this fields.\n\n## Properties\n\n| Property | Explanation |\n| --- | --- |\n| id | The unique numeric identifier for the metafield. |\n| namespace | The namespace where the metafield makes sense. It can be any string that starts with a letter followed only by: a-z A-Z 0-9 or _. |\n| key | String that identifies the metafield in some namespace. It can be any string that starts with a letter followed only by: a-z A-Z 0-9 or _. |\n| description | String explaining the metafield's meaning (optional). |\n| value | Metafield's value (string). |\n| owner_resource | Type of entity to which is associated the metafield. |\n| owner_id | Entity id to which is associated the metaField. |\n| created_at | Date when the Metafield was created in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601) |\n| updated_at | Date when the Metafield was last updated in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601) |" }, { "name": "Order", "item": [ { "name": "Receive a list of all orders", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders" ] } }, "response": [] }, { "name": "Receive a list of all orders filtering fields", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders?fields=id,number", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders" ], "query": [ { "key": "fields", "value": "id,number" } ] } }, "response": [] }, { "name": "Receive a single order", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}" ] } }, "response": [] }, { "name": "Receive a list of all order's total value alterations.", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/history/values", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "history", "values" ] } }, "response": [] }, { "name": "Receive a list of all order's editions.", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/history/editions", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "history", "editions" ] } }, "response": [] }, { "name": "Create an order", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"currency\": \"ARS\",\n \"language\": \"es\",\n \"status\": \"open\",\n \"gateway\": \"mercadopago\",\n \"payment_status\": \"pending\",\n \"products\": [\n {\n \"variant_id\": 101,\n \"quantity\": 2\n }\n ],\n \"inventory_behaviour\" : \"bypass\",\n \"customer\": {\n \"email\": \"john.doe@example.com\",\n \"name\": \"John Doe\",\n \"phone\": \"+55 11 99999-9999\",\n \"document\": \"12345678901\"\n },\n \"note\": null,\n \"billing_address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"address\": \"Evergreen Terrace\",\n \"number\": \"742\",\n \"floor\": null,\n \"locality\": null,\n \"city\": \"Springfield\",\n \"province\": \"Oregon\",\n \"zipcode\": \"97475\",\n \"country\": \"US\",\n \"phone\": \"5551230413\"\n },\n \"shipping_address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"address\": \"Evergreen Terrace\",\n \"number\": \"742\",\n \"floor\": null,\n \"locality\": null,\n \"city\": \"Springfield\",\n \"province\": \"Oregon\",\n \"zipcode\": \"97475\",\n \"country\": \"US\",\n \"phone\": \"5551230413\"\n },\n \"shipping_pickup_type\": \"ship\",\n \"shipping\": \"correios\",\n \"shipping_option\": \"Correios - PAC\",\n \"shipping_tracking_number\": null,\n \"shipping_cost_customer\": 20.00,\n \"shipping_cost_owner\": 20.00,\n \"send_confirmation_email\" : false,\n \"send_fulfillment_email\" : false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders" ] } }, "response": [] }, { "name": "Change an order's attributes", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"owner_note\": \"Need to gift wrap this order\",\n \"status\": \"paid\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}" ] } }, "response": [] }, { "name": "Close an order", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/close", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "close" ] } }, "response": [] }, { "name": "Re-open a closed order", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/open", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "open" ] } }, "response": [] }, { "name": "Cancel an order", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"reason\": \"Requested by custoemr\",\n \"email\": false,\n \"restock\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/cancel", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "cancel" ] } }, "response": [] }, { "name": "Edit an order. Only available in unstable.", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"products\": [\n {\n \"product_id\": 17310719,\n \"variant_id\": 33739100,\n \"quantity\": 2,\n \"modify_stock\": true,\n \"fulfillment_order_id\": \"01JRK598Q8C83X2QHCRXK0J7BJ\"\n },\n {\n \"line_item_id\": 32720436,\n \"quantity\": 1,\n \"modify_stock\": true,\n \"fulfillment_order_id\": \"01JRK598Q8C83X2QHCRXK0J7BJ\"\n }\n ],\n \"discounts\": [\n {\n \"type\": \"coupon_discount\",\n \"action\": \"replace\",\n \"value\": 1000\n }\n ],\n \"notify_customer\": false,\n \"reason\": \"Customer wanted a different product\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/unstable/{{store_id}}/orders/{{order_id}}/edit", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "unstable", "{{store_id}}", "orders", "{{order_id}}", "edit" ] } }, "response": [] }, { "name": "Pack an order. Only available in v1.", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{api_url}}/v1/{{store_id}}/orders/{{order_id}}/pack", "host": [ "{{api_url}}" ], "path": [ "v1", "{{store_id}}", "orders", "{{order_id}}", "pack" ] } }, "response": [] }, { "name": "Fulfill an order. Only available in v1.", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"shipping_tracking_number\": \"ABC1234\",\n \"shipping_tracking_url\": \"https://shipping.com/tracking/ABC1234\",\n \"notify_customer\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{api_url}}/v1/{{store_id}}/orders/{{order_id}}/fulfill", "host": [ "{{api_url}}" ], "path": [ "v1", "{{store_id}}", "orders", "{{order_id}}", "fulfill" ] } }, "response": [ { "name": "Fulfill an order. Only available in v1.", "originalRequest": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"shipping_tracking_number\": \"ABC1234\",\n \"shipping_tracking_url\": \"https://shipping.com/tracking/ABC1234\",\n \"notify_customer\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{api_url}}/v1/{{store_id}}/orders/{{order_id}}/fulfill", "host": [ "{{api_url}}" ], "path": [ "v1", "{{store_id}}", "orders", "{{order_id}}", "fulfill" ] } }, "_postman_previewlanguage": null, "header": null, "cookie": [], "body": null } ] } ], "description": "Resource available starting from API version `v1`.\n\nAn order is created when a customer completes the checkout process. Orders also can be created through the API. \nProperties\n\n---\n\n| Property | Explanation |\n| --- | --- |\n| id | The unique numeric identifier for the Order. It's different from `number` |\n| token | Specifies the location of the Order |\n| number | Unique numberc identifier for an Order used by the shop owner and customers. It's sequential and starts at 100 |\n| customer | [Customer](https://github.com/tiendanube/api-docs/blob/master/resources/customer.md) that purchased this Order. Only given if the 'read_customers' scope is set for the app |\n| products | List of the products purchased by the `customer`. Contents are explained below and values hold are the ones corresponding to the time the products were purchased |\n| note | Customer's note about the order |\n| owner_note | Store owner's note about the order |\n| coupon | List of coupons applied to the order |\n| discount | Total value of the discount applied to the price of the order |\n| subtotal | Price of the order before shipping |\n| total | Total price of the order including shipping and discounts |\n| total_usd | Total price of the order in US dollars |\n| currency | The total spent's currency in [ISO 4217 format](http://en.wikipedia.org/wiki/ISO_4217) |\n| language | Order's language used by the customer during the checkout process |\n| gateway | The payment gateway used |\n| shipping | The shipping method used |\n| shipping_pickup_type | \"ship\" if the order is going to be shipped; \"pickup\" if it's going to be picked up from a store branch |\n| shipping_store_branch_name | If order is going to be picked up, shows the store branch name |\n| shipping_address | The customer's shipping address where the order will be shipped |\n| shipping_tracking_number | The shipping tracking number for the order. This may be null if not available |\n| shipping_min_days | The minimum number of weekdays needed for the order to be delivered |\n| shipping_max_days | The maximum number of weekdays needed for the order to be delivered |\n| shipping_cost_owner | The shipping cost the store owner has to pay to the shipping company. |\n| shipping_cost_customer | The shipping cost the customer has to pay to the store owner. |\n| shipping_option | The shipping option chosen by the customer during the checkout process. |\n| shipping_option_code | The shipping option code selected by the consumers. |\n| shipping_option_reference | The shipping option reference provided by a custom shipping carrier during the checkout process. |\n| shipping_pickup_details | The shipping pickup details (address and/or business hours) of the selected pickup point. |\n| shipping_tracking_url | The shipping tracking URL where the customer can check for the shipment status. |\n| billing_address | Billing address for the order |\n| billing_number | Billing number for the order |\n| billing_floor | Billing floor for the order |\n| billing_locality | Billing locality for the order |\n| billing_zipcode | Billing zipcode for the order |\n| billing_city | Billing city for the order |\n| billing_province | Billing province for the order |\n| billing_country | Billing country code for the order |\n| extra | A JSON object containing custom information. Can be set via the API or through custom form fields of name \"extra\\[key\\]\" on the cart's checkout form in the storefront |\n| storefront | Origin of the order. Possible values are \"store\" (order created in the storefront), \"meli\" (order imported from Mercado Libre), \"api\" (order created via API) or \"form\" (order created in the admin panel with the draft orders feature) |\n| weight | Order's total weight, in kilograms |\n| status | Order's status. Possible values are \"open\", \"closed\" or \"cancelled\" |\n| payment_status | Order's payment status. Possible values are \"authorized\", \"pending\", \"paid\", \"abandoned\", \"refunded\" or \"voided\" |\n| shipping_status | Order's shipping status. Possible values are \"unpacked\", \"fulfilled\" (means \"shipped\") or \"unfulfilled\" (means \"unshipped\") |\n| next_action | Next available operation in the orders flow |\n| shipped_at | Date when the Order was shipped in [ISO 8601 format](http://es.wikipedia.org/wiki/ISO_8601) |\n| cancel_reason | Reason why the store owner cancelled an Order. Possible values are \"customer\", \"fraud\", \"inventory\" or \"other\" |\n| created_at | Date when the Order was created in [ISO 8601 format](http://es.wikipedia.org/wiki/ISO_8601) |\n| updated_at | Date when the Order was last updated in [ISO 8601 format](http://es.wikipedia.org/wiki/ISO_8601) |" }, { "name": "Order Custom Fields", "item": [ { "name": "Create a new custom field", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Delivery status\",\n \"description\": \"Possible delivery status\",\n \"value_type\": \"text_list\",\n \"read_only\": false,\n \"values\": [\n \"Started\",\n \"In transit\",\n \"Finished\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/custom-fields", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "custom-fields" ] } }, "response": [] }, { "name": "Receive a list of all custom fields from a specific owner resource", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true }, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/custom-fields", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "custom-fields" ] } }, "response": [] }, { "name": "Modify the custom field values", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"values\": [\n \"Canceled\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/custom-fields/{{custom-field_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "custom-fields", "{{custom-field_id}}" ] } }, "response": [] }, { "name": "Receive the custom fields associated with a specific order", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true }, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/custom-fields", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "custom-fields" ] } }, "response": [] }, { "name": "Receive orders associated with a specific custom field", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true }, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/custom-fields/{{custom-field_id}}/owners", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "custom-fields", "{{custom-field_id}}", "owners" ] } }, "response": [] }, { "name": "Modify a value associated with an order.", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"a1a6d069-7245-47d7-8c8d-3cb97bb95b9b\",\n \"value\": \"Canceled\"\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/custom-fields/values", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "custom-fields", "values" ] } }, "response": [] }, { "name": "Remove a custom field", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/custom-fields/{{custom-field_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "custom-fields", "{{custom-field_id}}" ] } }, "response": [] }, { "name": "Receive the data of a given order custom field", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true }, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/custom-fields/{{custom-field_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "custom-fields", "{{custom-field_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version `v1`.\n\nA custom field allows the store owner/merchant to expand their experience and control their own business through personalized and unique custom fields for orders.\n\n## Properties\n\n| Property | Explanation |\n| --- | --- |\n| id | The unique universal identifier for the custom field. |\n| name | Name of the custom field. |\n| descripton | Description of the custom field. |\n| value_type | Custom field type (text_list, text, numeric, date). |\n| owner_resource | Custom field owner (`order`). |\n| read_only | If set to true, it restricts the association of the custom field by merchants via the administrator panel, the merchant can only read the value associated with the custom field. (default value is false). |\n| values | A list of all values for a custom field (for value_type text_list only, for other types can be an empty array). |" }, { "name": "Pages", "item": [ { "name": "Retrieves all custom pages from the store.", "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/payment-options", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "payment-options" ] } }, "response": [] }, { "name": "Retrieve a specific page", "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/pages/{{page_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "pages", "{{page_id}}" ] } }, "response": [] }, { "name": "Create a new page", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"page\": {\n \"publish\": true,\n \"i18n\": {\n \"es_AR\": {\n \"title\": \"About Us\",\n \"content\": \"

Our company was founded in 2020...

\",\n \"seo_handle\": \"about-us\",\n \"seo_title\": \"About Our Company\",\n \"seo_description\": \"Learn more about our company\"\n },\n \"en_US\": {\n \"title\": \"About Us\",\n \"content\": \"

Our company was founded in 2020...

\",\n \"seo_handle\": \"about-us\",\n \"seo_title\": \"About Our Company\",\n \"seo_description\": \"Learn more about our company\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/pages", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "pages" ] } }, "response": [] }, { "name": "Update an existing page", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"About Us (Updated)\",\n \"content\": \"Updated content for About Us page.\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/pages/{{page_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "pages", "{{page_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version `2025-03`.\n\nThe **Pages resource** allows developers to manage custom pages within the store. The resource also handles stores with multiple languages. Currently, a Page is always in a published state, meaning that it will always be visible on the store.\n\nSince: `2025-03`\n\n## Properties\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | Integer | Unique identifier of the page. |\n| `store_id` | Integer | ID of the store this page belongs to. |\n| `published` | Boolean | Whether the page is currently published. |\n| `created_at` | String | Timestamp when the page was created (ISO 8601 format). |\n| `updated_at` | String | Timestamp when the page was last updated (ISO 8601 format). |\n| `name` | Object | Localized name of the page. Keys are language codes (e.g., \"es\"). |\n| `handle` | Object | Localized URL-friendly handle/slug for the page. Keys are language codes (e.g., \"es\"). |\n| `content` | Object | Localized HTML content of the page. Keys are language codes (e.g., \"es\"). |\n| `seo_title` | Object | Localized SEO title for the page. Keys are language codes (e.g., \"es\"). |\n| `seo_description` | Object | Localized SEO description for the page. Keys are language codes (e.g., \"es\"). |" }, { "name": "Payment Option", "item": [ { "name": "Receive the payment options available for the checkout", "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/payment-options", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "payment-options" ] } }, "response": [] } ], "description": "Resource available starting from API version `v1`.\n\nA [Payment Provider](https://tiendanube.github.io/api-documentation/v1/resources/payment-provider) can implement multiple payment options to be available at the checkout of a store. Payment options are the different alternatives through which a consumer can pay for their order in the store. These options can be integrated in the store checkout in two ways:\n\n- **transparent integration:** the payment through this option is processed within the checkout of the store;\n \n- **redirect integration:** by using this option, the consumer is redirected to an external checkout provided by the payment provider.\n \n\n## Properties\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | String | Unique identifier of the payment provider. |\n| `name` | String | Name of the payment provider. |\n| `checkout_payment_options`\\` | Array(Object) | List of checkout payment options supported by the payment provider. See Checkout Payment Options. |\n| `logo_url` | String | \\[Optional\\] HTTPS URL of the payment provider logo. |" }, { "name": "Payment Provider", "item": [ { "name": "Receive all payment providers for a given store", "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/payment_providers", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "payment_providers" ] } }, "response": [] }, { "name": "Receive a specific payment provider for a given store", "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/payment_providers/{{payment_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "payment_providers", "{{payment_id}}" ] } }, "response": [] }, { "name": "Create a payment provider for a given store", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"My Payments\",\n \"public_name\": \"Pay with My Payments\",\n \"description\": \"Some short description for merchants.\",\n \"logo_urls\": {\n \"400x120\": \"https://mypayments.com/logo1.png\",\n \"160x100\": \"https://mypayments.com/logo2.png\"\n },\n \"configuration_url\": \"https://mypayments.com/configuration\",\n \"support_url\": \"https://mypayments.com/support\",\n \"rates_url\": \"https://mypayments.com/rates\",\n \"checkout_js_url\": \"https://mypayments.com/checkout.min.js\",\n \"supported_currencies\": [\n \"ARS\",\n \"BRL\"\n ],\n \"supported_payment_methods\": [\n {\n \"payment_method_type\": \"credit_card\",\n \"payment_methods\": [\n \"visa\",\n \"mastercard\",\n \"amex\",\n \"diners\"\n ],\n \"installments\": {\n \"min_installment_value\": [\n {\n \"currency\": \"ARS\",\n \"value\": \"100.00\"\n }\n ],\n \"specification\": [\n {\n \"installments\": 1,\n \"interest_rate\": \"0.00\",\n \"applies_to\": [\n \"bbva\",\n \"itau\",\n \"santander\",\n \"galicia\",\n \"icbc\"\n ]\n },\n {\n \"installments\": 3,\n \"interest_rate\": \"0.00\",\n \"applies_to\": [\n \"bbva\",\n \"itau\"\n ],\n \"minimum_purchase_value\": [\n {\n \"value\": \"300.00\",\n \"currency\": \"ARS\"\n }\n ]\n },\n {\n \"installments\": 6,\n \"interest_rate\": \"0.045\",\n \"applies_to\": [\n \"santander\",\n \"galicia\"\n ],\n \"minimum_purchase_value\": [\n {\n \"value\": \"500.00\",\n \"currency\": \"ARS\"\n },\n {\n \"value\": \"100.00\",\n \"currency\": \"BRL\"\n }\n ]\n },\n {\n \"installments\": 12,\n \"interest_rate\": \"0.15\",\n \"applies_to\": [\n \"icbc\"\n ]\n }\n ]\n }\n },\n {\n \"payment_method_type\": \"debit_card\",\n \"payment_methods\": [\n \"visa_debit\",\n \"maestro\"\n ]\n },\n {\n \"payment_method_type\": \"boleto\",\n \"payment_methods\": [\n \"boleto\",\n \"banco_do_brasil\", \n \"bradesco\", \n \"caixa\"\n ]\n }\n ],\n \"rates\": [\n {\n \"payment_method_type\": \"credit_card\",\n \"rates_definition\": [\n {\n \"percent_fee\": \"2.25\",\n \"flat_fee\": {\n \"value\": \"1.00\",\n \"currency\": \"ARS\"\n },\n \"plus_tax\": true,\n \"days_to_withdraw_money\": 10\n },\n {\n \"percent_fee\": \"3.99\",\n \"flat_fee\": {\n \"value\": \"2.50\",\n \"currency\": \"BRL\"\n },\n \"plus_tax\": false,\n \"days_to_withdraw_money\": 5\n }\n ]\n }\n ],\n \"checkout_payment_options\": [\n {\n \"id\": \"mypayments_transparent_card\",\n \"name\": \"My Payments Card\",\n \"description\": \"Some description for transparent card option\",\n \"logo_url\": \"https://cdn.mypayments.com/apps/tiendanube/logo.png\",\n \"supported_billing_countries\": [\n \"AR\"\n ],\n \"supported_payment_method_types\": [\n \"credit_card\",\n \"debit_card\"\n ]\n },\n {\n \"id\": \"mypayments_transparent_offline\",\n \"name\": \"My Payments Boleto\",\n \"description\": \"Some description for transparent offline option\",\n \"logo_url\": \"https://cdn.mypayments.com/apps/tiendanube/logo.png\",\n \"supported_billing_countries\": [\n \"BR\"\n ],\n \"supported_payment_method_types\": [\n \"boleto\"\n ]\n },\n {\n \"id\": \"mypayments_redirect\",\n \"name\": \"My Payments External\",\n \"description\": \"Some description for external option\",\n \"logo_url\": \"https://cdn.mypayments.com/apps/tiendanube/logo.png\",\n \"supported_billing_countries\": [\n \"AR\",\n \"BR\"\n ],\n \"supported_payment_method_types\": [\n \"credit_card\",\n \"wire_transfer\",\n \"wallet\"\n ]\n }\n ],\n \"features\": [\n \"special_rates\",\n \"transparent_checkout\",\n \"gateway\"\n ],\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/payment_providers", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "payment_providers" ] } }, "response": [] }, { "name": "Update a payment provider for a given store", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"checkout_payment_options\": [\n {\n \"id\": \"epayco_external\",\n \"name\": \"Credit card - Paga con ePayco\",\n \"description\": \"ePayco payment method for credit card\",\n \"logo_url\": \"https://tiendanube.epayco.co/alerts-icons/logoepayco.svg\",\n \"supported_billing_countries\": [\n \"ES\",\n \"AR\",\n \"BO\",\n \"BR\",\n \"BQ\",\n \"CL\",\n \"CO\",\n \"EC\",\n \"FK\",\n \"GF\",\n \"GY\",\n \"PY\",\n \"PE\",\n \"GS\",\n \"SR\",\n \"UY\",\n \"VE\",\n \"CA\",\n \"US\"\n ],\n \"supported_payment_method_types\": [\n \"credit_card\"\n ],\n \"integration_type\": \"redirect\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/payment_providers/148695e5-234c-4536-81a4-c239588111f1", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "payment_providers", "148695e5-234c-4536-81a4-c239588111f1" ] } }, "response": [] }, { "name": "Remove a payment provider for a given store", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/payment_providers/{{payment_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "payment_providers", "{{payment_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version `v1`.\n\nA Payment Provider, shorter name for Payments Services Provider, represents any entity which provides all the necessary resources and infrastructure for merchants and consumers to execute [Transactions](https://transaction.md) between them. This entities could be any of the following:\n\n- **Aggregator**\n \n- **Acquirer**\n \n- **Gateway**\n \n\nPayments companies have many different and sometimes complex features which add value to the purchase experience, mainly providing multiple payments options and simpler checkout flows. They also provide merchants with tools to make better management of their Transactions as well as their incomes.\n\nIn our platform, a Payment Provider is created for a specific `store`.\n\n## Properties\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | String | \\[Read-only\\] Unique identifier of the Payment Provider object. |\n| `store_id` | Integer | \\[Read-only\\] Id of the store to which the Payment Provider belongs. |\n| `app_id` | String | \\[Read-only\\] Id of the app to which the Payment Provider belongs. |\n| `name` | String | Name to be displayed to merchants at the store admin tool. |\n| `public_name` | String | \\[Optional\\] Name to be displayed to consumers at the storefront. If not specified, the same value as `name` is used. |\n| `description` | String | Short paragraph which provides merchants with a description of the Payment Provider. |\n| `logo_urls` | Object | Object containing `key:value` pair for each version of the logos for the frontend. Only supports HTTPS URLs. See [Logos](#Logos). |\n| `supported_currencies` | Array(String) | ISO.4217 currency codes supported by the Payment Provider. See [Currency Codes](#Currency-Codes). |\n| `supported_payment_methods` | Array(Object) | List of available payment methods for each payment method type. See [Payment Methods](#Payment-Methods). |\n| `checkout_js_url` | String | HTTPS URL of the JavaScript file to be included in the checkout frontend. See [Checkout](https://checkout.md). |\n| `checkout_payment_options` | Array(Object) | Object containing the available payment options for the checkout frontend. See [Checkout Options](#Checkout-Options). |\n| `configuration_url` | String | \\[Optional\\] HTTPS URL of the Payment Provider configuration UI. |\n| `support_url` | String | \\[Optional\\] Payment Provider support site HTTPS URL. |\n| `rates` | Array(Object) | \\[Optional\\] List of rates definitions for merchants by payment method type. See [Rates](#Rates). |\n| `rates_url` | String | \\[Optional\\] HTTPS URL of the Payment Provider's rate information site. |\n| `features` | Array(String) | \\[Optional\\] List of payment provider's features. See [Features](#Features). |\n| `enabled` | Boolean | \\[Optional\\] Indicates whether the Payment Provider is activated or deactivated in the store. Defaults to `true`. |\n\n> _**Note:**_ All URLs must be secure URLs (https). \n \n> _**Note:**_ Read-only properties will only appear in our responses, which means that should not be part of the requests." }, { "name": "Product", "item": [ { "name": "Receive a list of all products", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products" ] } }, "response": [] }, { "name": "Receive a list of all products filtering fields", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products?created_at_min=2013-01-01T00:00:00-03:00&fields=id,name", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products" ], "query": [ { "key": "created_at_min", "value": "2013-01-01T00:00:00-03:00" }, { "key": "fields", "value": "id,name" } ] } }, "response": [] }, { "name": "Receive a single product", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/{{product_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "{{product_id}}" ] } }, "response": [] }, { "name": "Receive the first product found where one of its variants has the given SKU", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/sku/{{sku_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "sku", "{{sku_id}}" ] } }, "response": [] }, { "name": "Create a new product", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"images\": [\n {\n \"src\": \"http://images1.wikia.nocookie.net/__cb20101106022321/pokemon/images/f/f1/UltraBallArt.png\"\n }\n ],\n \"name\": {\n \"en\": \"Ultra Ball\",\n \"es\": \"Ultra Ball\",\n \"pt\": \"Ultra Ball\"\n },\n \"variants\": [\n {\n \"price\": \"10.00\",\n \"stock_management\": true,\n \"stock\": 12,\n \"weight\": \"2.00\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products" ] } }, "response": [] }, { "name": "Modify a existing product", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"categories\": [\n 7040751,\n 14019281,\n 14019382,\n 14019389\n ],\n \"attributes\": [\n {\n \"en\": \"COLOR\",\n \"es\": \"COLOR\",\n \"pt\": \"COLOR\"\n },\n {\n \"en\": \"TALLE\",\n \"es\": \"TALLE\",\n \"pt\": \"TALLE\"\n }\n ],\n \"created_at\": null,\n \"description\": {\n \"en\": \"

p>\\\"\\\"<\\/p>\",\n \"es\": \"

p>\\\"\\\"<\\/p>\",\n \"pt\": \"

p>\\\"\\\"<\\/p>\"\n },\n \"handle\": null,\n \"tags\": \"\",\n \"id\": 236250134,\n \"images\": null,\n \"name\": {\n \"en\": \"B\",\n \"es\": \"B\",\n \"pt\": \"1\"\n },\n \"updated_at\": null,\n \"variants\": null,\n \"brand\": \"COCOT - DUFOUR - DISNEY - LEVANTE\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/{{product_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "{{product_id}}" ] } }, "response": [] }, { "name": "Modify Stock or Price of multiple products and variants", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 192859705,\n \"variants\": [\n {\n \"id\": 147085180,\n \"price\": 1000,\n \"inventory_levels\": [\n {\n \"stock\": 300\n }\n ]\n }\n ]\n },\n {\n \"id\": 49819000,\n \"variants\": [\n {\n \"id\": 133862417,\n \"price\": 222.03\n },\n {\n \"id\": 133862416,\n \"inventory_levels\": [\n {\n \"stock\": 100\n }\n ]\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/stock-price", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "stock-price" ] } }, "response": [] }, { "name": "Remove a product", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/{{product_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "{{product_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version `v1`.\n\nA Product is an item for sale in a Tiendanube/Nuvemshop's store. It can be either a good or a service.\n\n## Properties\n\n| Property | Explanation |\n| --- | --- |\n| id | The unique numeric identifier for the Product |\n| name | List of the names of the Product, in every language supported by the store |\n| description | List of the descriptions of the Product, as HTML, in every language supported by the store |\n| handle | List of the url-friendly strings generated from the Product's names, in every language supported by the store |\n| variants | List of [Product Variant](https://github.com/tiendanube/api-docs/blob/master/resources/product_variant.md) objects representing the different version of the Product |\n| images | List of [Product Image](https://github.com/tiendanube/api-docs/blob/master/resources/product_image.md) objects representing the Product's images |\n| categories | List of [Category](https://github.com/tiendanube/api-docs/blob/master/resources/category.md) objects representing the Product's categories |\n| brand | The Product's brand |\n| published | _true_ if the Product is published in the store. _false_ otherwise |\n| free_shipping | _true_ if the Product is elegible for free shipping. _false_ otherwise |\n| seo_title | The SEO friendly title for the Product. Up to 70 characters |\n| seo_description | The SEO friendly description for the Product. Up to 320 characters |\n| attributes | List of the names of the attributes whose values define the variants. E.g.: Color, Size, etc |\n| tags | String with all the Product's tags, separated by commas |\n| created_at | Date when the Product was created in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601) |\n| updated_at | Date when the Product was last updated in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601) |\n| requires_shipping | _true_ if the Product is physical. _false_ if it is digital |" }, { "name": "Product Image", "item": [ { "name": "Receive a list of all product images for a given product", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/{{product_id}}/images", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "{{product_id}}", "images" ] } }, "response": [] }, { "name": "Receive a list of all product images for a given product filtering fields", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/{{product_id}}/images?since_id=105", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "{{product_id}}", "images" ], "query": [ { "key": "since_id", "value": "105" } ] } }, "response": [] }, { "name": "Receive a single product image", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/{{product_id}}/images/{{image_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "{{product_id}}", "images", "{{image_id}}" ] } }, "response": [] }, { "name": "Create a new product image from url source", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"src\": \"http://example.com/charmander.jpg\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/{{product_id}}/images", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "{{product_id}}", "images" ] } }, "response": [] }, { "name": "Create a new product image from base64 encode", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"filename\": \"mewtwo.gif\",\n \"position\": 5,\n \"attachment\": \"R0lGODlhIAAgAPIAAPj4+MCgyHh4eGBgWLgomEBAQP///wAAACH/C05FVFNDQVBFMi4wAwEAAAAh/hFwb2tlZ3VpZGUuZmlsYi5kZQAh+QQJEQAGACwAAAAAIAAgAAADj2i63P4wykmrvTjrzbv/YNgUBUN+BUCuQFB2JNCmgeulbV2/y3rhup2pReBJgDuhgkYoUnA5mm0ZaBojyAJBadAWr8fgylXSgrEFMim5M1uka3H8VEm7BOmx3T59lvFVRWJcbyRNgjo+GAMCjQOHAzoDGoyOBgOYmAGTG5kOkZsil0GcIQMyNaUgmaqirhcJACH5BAkRAAYALAAAAAAgACAAAAOLaLrc/jDKSau9OOvNu/9gKEpFwZRfAZQsEJhdCbhq8Hqqa9tww1a5Hc9RI/QgQd7w5CIYSTNd7XYKOI+PZIGwXGyNWKSQ9UIZtmExq6DclZ5AKXtc4qWzPAGbPJ9TKSgFelZGY10VAyxOhW5mFgMCkQMDiwM7AxuTmAaamgGTI5aXoTM2myGdI6oaCQA7\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/{{product_id}}/images", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "{{product_id}}", "images" ] } }, "response": [] }, { "name": "Modify an existing product image", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 145,\n \"src\": \"http://d26lpennugtm8s.cloudfront.net/stores/001/234/products/mewtwo-640-0.jpg\",\n \"position\": 1,\n \"product_id\": 1234\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/{{product_id}}/images/{{image_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "{{product_id}}", "images", "{{image_id}}" ] } }, "response": [] }, { "name": "Remove a product image", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/{{product_id}}/images/{{image_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "{{product_id}}", "images", "{{image_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version `v1`.\n\nProduct images could well be the single most important design aspect of any store. Without the ability to touch, hold, smell, taste or otherwise handle the products they are interested in, potential customers have only images to interact with.\n\nThe product images have the following restrictions:\n\n- Must weight less than 10MB\n \n- Must be in one of the following formats: .gif, .jpg, .png, .webp\n \n\n| Property | Explanation |\n| --- | --- |\n| `id` | The unique numeric identifier for the Product Image |\n| `product_id` | The id of the product associated with the image |\n| `src` | URL of the product image |\n| `position` | Number indicating the position of the image in the product's image list. 1 is the first and the main product image |\n| `created_at` | Date when the Product Image was created in ISO 8601 format |\n| `updated_at` | Date when the Product Image was last updated in ISO 8601 format |\n| `alt` | Image alt text helps search engines like Google understand when to show the image in a search result |" }, { "name": "Product Variant", "item": [ { "name": "Receive a list of all product variants for a given product", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/{{product_id}}/variants", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "{{product_id}}", "variants" ] } }, "response": [] }, { "name": "Receive a list of all product variants for a given product filtering fields", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/{{product_id}}/variants?since_id=105", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "{{product_id}}", "variants" ], "query": [ { "key": "since_id", "value": "105" } ] } }, "response": [] }, { "name": "Receive a single product variant", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/{{product_id}}/variants/{{variant_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "{{product_id}}", "variants", "{{variant_id}}" ] } }, "response": [] }, { "name": "Create a new product variant", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"values\": [\n {\n \"en\": \"X-Large\"\n }\n ],\n \"price\": \"19.00\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/{{product_id}}/variants", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "{{product_id}}", "variants" ] } }, "response": [] }, { "name": "Modify an existing product variant", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 144,\n \"image_id\": null,\n \"promotional_price\": \"19.00\",\n \"created_at\": \"2013-01-03T09:11:51-03:00\",\n \"depth\": null,\n \"height\": null,\n \"values\": [\n {\n \"en\": \"X-Large\"\n }\n ],\n \"price\": \"25.00\",\n \"product_id\": 1234,\n \"stock_management\": true,\n \"stock\": 5,\n \"sku\": \"BSG1234D\",\n \"updated_at\": \"2013-06-01T09:15:11-03:00\",\n \"weight\": \"2.75\",\n \"width\": null\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/{{product_id}}/variants/{{variant_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "{{product_id}}", "variants", "{{variant_id}}" ] } }, "response": [] }, { "name": "Modify the product variants of one product", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"values\": [\n {\n \"es\": \"Large\"\n }\n ],\n \"stock\": 4,\n \"price\": 10.5\n },\n {\n \"values\": [\n {\n \"es\": \"Medium\"\n }\n ]\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/{{product_id}}/variants/", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "{{product_id}}", "variants", "" ] } }, "response": [] }, { "name": "Partially update a product variant collection", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "TS Support Test ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 377642128,\n \"values\": [\n {\n \"pt\": \"37\"\n }\n ],\n \"price\": 199.9,\n \"promotional_price\": null,\n \"stock\": 0\n },\n {\n \"id\": 377642139,\n \"values\": [\n {\n \"pt\": \"33\"\n }\n ],\n \"price\": 199.9,\n \"promotional_price\": null,\n \"stock\": 0\n },\n {\n \"id\": 377642151,\n \"values\": [\n {\n \"pt\": \"34\"\n }\n ],\n \"price\": 199.9,\n \"promotional_price\": null,\n \"stock\": 0\n },\n {\n \"id\": 377642162,\n \"values\": [\n {\n \"pt\": \"35\"\n }\n ],\n \"price\": 199.9,\n \"promotional_price\": null,\n \"stock\": 0\n },\n {\n \"id\": 377642175,\n \"values\": [\n {\n \"pt\": \"36\"\n }\n ],\n \"price\": 199.9,\n \"promotional_price\": null,\n \"stock\": 0\n },\n {\n \"id\": 377642195,\n \"values\": [\n {\n \"pt\": \"38\"\n }\n ],\n \"price\": 199.9,\n \"promotional_price\": null,\n \"stock\": 0\n },\n {\n \"id\": 377642206,\n \"values\": [\n {\n \"pt\": \"39\"\n }\n ],\n \"price\": 199.9,\n \"promotional_price\": null,\n \"stock\": 0\n },\n {\n \"id\": 377642215,\n \"values\": [\n {\n \"pt\": \"40\"\n }\n ],\n \"price\": 199.9,\n \"promotional_price\": null,\n \"stock\": 0\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/215035985/variants", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "215035985", "variants" ] } }, "response": [] }, { "name": "Remove a product variant", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/{{product_id}}/variants/{{variant_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "{{product_id}}", "variants", "{{variant_id}}" ] } }, "response": [] }, { "name": "Modify the stock for one or all variants of a product", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"action\": \"replace\",\n \"value\": 10\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/{{product_id}}/variants/stock", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "{{product_id}}", "variants", "stock" ] } }, "response": [] } ], "description": "Resource available starting from API version `v1`.\n\nProduct variants allow you to group a shoe with different sizes and colors in the same product. You can only create products with up to 1000 variants." }, { "name": "Product Custom Fields", "item": [ { "name": "Create a new custom field", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Supplier\",\n \"description\": \"Material supplier\",\n \"value_type\": \"text_list\",\n \"read_only\": false,\n \"values\": [\n \"Acme\",\n \"Umbrella\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/custom-fields", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "custom-fields" ] } }, "response": [] }, { "name": "Receive a list of all products custom fields", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true }, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/custom-fields", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "custom-fields" ] } }, "response": [] }, { "name": "Modify the custom field values", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"values\": [\n \"Massive Dynamic\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/custom-fields/{{custom-field_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "custom-fields", "{{custom-field_id}}" ] } }, "response": [] }, { "name": "Modify a value associated with a product.", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"57358282-92e5-47cc-8c6e-9f0a4e7bf05f\",\n \"value\": \"Acme\"\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/{{product_id}}/custom-fields/values", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "{{product_id}}", "custom-fields", "values" ] } }, "response": [] }, { "name": "Receive the custom fields associated with a specific product", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true }, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/{{product_id}}/custom-fields", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "{{product_id}}", "custom-fields" ] } }, "response": [] }, { "name": "Receive products associated with a specific custom field", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true }, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/custom-fields/{{custom-field_id}}/owners", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "custom-fields", "{{custom-field_id}}", "owners" ] } }, "response": [] }, { "name": "Receive the data of a given product custom field", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true }, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/custom-fields/{{custom-field_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "custom-fields", "{{custom-field_id}}" ] } }, "response": [] }, { "name": "Remove a custom field", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/custom-fields/{{custom-field_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "custom-fields", "{{custom-field_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version `v1`.\n\nA custom field allows the store owner/merchant to expand their experience and control their own business through personalized and unique custom fields for products.\n\n## Properties\n\n| Property | Explanation |\n| --- | --- |\n| id | The unique universal identifier for the custom field. |\n| name | Name of the custom field. |\n| descripton | Description of the custom field. |\n| value_type | Custom field type (text_list, text, numeric, date). |\n| owner_resource | Custom field owner (`product`). |\n| read_only | If set to true, it restricts the association of the custom field by merchants via the administrator panel, the merchant can only read the value associated with the custom field. (default value is false). |\n| values | A list of all values for a custom field (for value_type text_list only, for other types can be an empty array). |" }, { "name": "Product Variant Custom Fields", "item": [ { "name": "Create a new custom field", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Production status\",\n \"description\": \"Possible product production status\",\n \"value_type\": \"text_list\",\n \"read_only\": false,\n \"values\": [\n \"Started\",\n \"In Production\",\n \"Finished\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/variants/custom-fields", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "variants", "custom-fields" ] } }, "response": [] }, { "name": "Receive a list of all custom fields from a specific owner resource", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true }, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/variants/custom-fields", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "variants", "custom-fields" ] } }, "response": [] }, { "name": "Modify the custom field values", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"values\": [\n \"Waiting for supplier\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/variants/custom-fields/{{custom-field_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "variants", "custom-fields", "{{custom-field_id}}" ] } }, "response": [] }, { "name": "Receive the custom fields associated with a specific product", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true }, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/variants/{{variant_id}}/custom-fields", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "variants", "{{variant_id}}", "custom-fields" ] } }, "response": [] }, { "name": "Receive the product variants associated with a specific custom field", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true }, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/variants/custom-fields/{{custom-field_id}}/owners", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "variants", "custom-fields", "{{custom-field_id}}", "owners" ] } }, "response": [] }, { "name": "Modify a value associated with a product variant.", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": \"d6079ed1-6aaf-4392-8c10-32557e7f93f3\",\n \"value\": \"Finished\"\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/variants/{{variant_id}}/custom-fields/values", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "variants", "{{variant_id}}", "custom-fields", "values" ] } }, "response": [] }, { "name": "Remove a custom field", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/variants/custom-fields/{{custom-field_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "variants", "custom-fields", "{{custom-field_id}}" ] } }, "response": [] }, { "name": "Receive he data of a given product variant custom field", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true }, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/products/variants/custom-fields/{{custom-field_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "products", "variants", "custom-fields", "{{custom-field_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version `v1`.\n\nA custom field allows the store owner/merchant to expand their experience and control their own business through personalized and unique custom fields for product variants.\n\n## Properties\n\n| Property | Explanation |\n| --- | --- |\n| id | The unique universal identifier for the custom field. |\n| name | Name of the custom field. |\n| descripton | Description of the custom field. |\n| value_type | Custom field type (text_list, text, numeric, date). |\n| owner_resource | Custom field owner (`product_variant`). |\n| read_only | If set to true, it restricts the association of the custom field by merchants via the administrator panel, the merchant can only read the value associated with the custom field. (default value is false). |\n| values | A list of all values for a custom field (for value_type text_list only, for other types can be an empty array). |" }, { "name": "Script (legacy)", "item": [ { "name": "Receive a list of all scripts", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/scripts", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "scripts" ] } }, "response": [] }, { "name": "Receive a list of all scripts filtering fields", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/scripts?since_id=1234", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "scripts" ], "query": [ { "key": "since_id", "value": "1234" } ] } }, "response": [] }, { "name": "Receive a single script", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/scripts/{{script_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "scripts", "{{script_id}}" ] } }, "response": [] }, { "name": "Create a new script", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"src\": \"https://myapp.com/new.js\",\n \"event\" : \"onload\",\n \"where\" : \"store\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/scripts", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "scripts" ] } }, "response": [] }, { "name": "Modify an existing script", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"src\": \"https://myapp.com/new2.js\",\n \"event\" : \"onload\",\n \"where\" : \"store\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/scripts/{{script_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "scripts", "{{script_id}}" ] } }, "response": [] }, { "name": "Remove a script", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/scripts/{{script_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "scripts", "{{script_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version `v1`.\n\nThe Script resource allows the app to register custom Javascript to be run in the store or in the checkout page. Also, if the user deletes your app, then he will not have to edit his theme to remove your JavaScript. When an app is uninstalled from a store, all of the scripts the app created are automatically removed along with it.\n\nYou should have the following things into consideration:\n\n- Scripts **must be served over HTTPS**.\n \n- You cannot depend of any JavaScript available in the store's theme. Not even jQuery.\n \n- Another applications may be installed and can include other JavaScript in addition to yours.\n \n- When we include your script in the store, we will send a `store` parameter with the store id (e.g. ).\n \n\n## Properties\n\n| Property | Explanation |\n| --- | --- |\n| id | The unique numeric identifier for the Script |\n| src | Specifies the location of the Script. **Must be HTTPS**. |\n| event | DOM event which triggers the loading of the script. Valid values are **onload** (default) |\n| where | A comma-separated list of places where the javascript will run. Valid values are **store** (default) or **checkout** |\n| created_at | Date when the Script was created in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601) |\n| updated_at | Date when the Script was last updated in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601) |" }, { "name": "Script Management", "item": [ { "name": "Receive a list of all scripts", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/scripts", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "scripts" ] } }, "response": [] }, { "name": "Receive a single script", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/scripts/{{script_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "scripts", "{{script_id}}" ] } }, "response": [] }, { "name": "Creates script-store association.", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"script_id\": 12345,\n \"query_params\": \"{\\\"paramA\\\": 2}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/scripts", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "scripts" ] } }, "response": [] }, { "name": "Modifies an existing script-store association (parameters).", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"script_id\": 12345,\n \"query_params\": \"{\\\"paramA\\\": 3}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/scripts/{{script_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "scripts", "{{script_id}}" ] } }, "response": [] }, { "name": "Remove a script", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/scripts/{{script_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "scripts", "{{script_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version `v1`.\n\nThe Script resource allows an app to register a custom Javascript file to be loaded and executed in the Merchant's storefront page. More precisely, on products (store) and payment (checkout) pages.\n\nThis is necessary when apps, besides its page on the Merchant's admin, must also impact the merchant store web page in some manner. For example, an App that recoveries user's carts might want to display a dialog component in which the user can see previous carts and choose which one to recover.\n\nThe script is inserted in the HTML code of the Merchant's webpage in a `html tag` the decision process of loading a custom script or not is based on the script configuration that will be soon explained.\n\nApps that require a script to work fully should be registered in the Partner's portal with the `scripts` scope permission assigned. This permission will be added to the apps scopes and guarantees that every time a merchant decides to install the app, they will be required to accept a term of use that informs them that an additional script will be run in their storefront. Apps without this permission won't be able to have scripts being associated." }, { "name": "Shipping Carrier", "item": [ { "name": "Create a new shipping carrier", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"My Shipping Company\",\n \"callback_url\": \"https://example.com/rates\",\n \"types\": \"ship,pickup\",\n \"status\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/shipping_carriers", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "shipping_carriers" ], "query": [ { "key": "XDEBUG_SESSION_START", "value": "PHPSTORM", "disabled": true } ] } }, "response": [] }, { "name": "Receive a list of all shipping carriers", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/shipping_carriers", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "shipping_carriers" ], "query": [ { "key": "XDEBUG_SESSION_START", "value": "PHPSTORM", "disabled": true } ] } }, "response": [] }, { "name": "Receive a single shipping carrier", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/shipping_carriers/{{carrier_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "shipping_carriers", "{{carrier_id}}" ], "query": [ { "key": "XDEBUG_SESSION_START", "value": "PHPSTORM", "disabled": true } ] } }, "response": [] }, { "name": "Modify an existing shipping carrier", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"My Super Shipping Company\",\n \"types\": \"ship\",\n \"active\": false \n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/shipping_carriers/{{carrier_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "shipping_carriers", "{{carrier_id}}" ] } }, "response": [] }, { "name": "Remove a shipping carrier", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/shipping_carriers/{{carrier_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "shipping_carriers", "{{carrier_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version `v1`.\n\nA shipping carrier (or shipping company) service provides real-time shipping rates for merchants.\n\nUsing these endpoints, you can add a shipping carrier to a store and provide shipping rates at checkout.\n\n## Shipping Carrier Properties\n\n| Property | Explanation |\n| --- | --- |\n| id | The unique numeric identifier for the Shipping Carrier. |\n| name | The name of the Shipping Carrier as seen by both merchants and buyers. |\n| callback_url | The URL endpoint that we need to retrieve shipping rates. **Must be HTTPS.** |\n| types | The supported shipping types, can be one or both _ship_ or _pickup_. |\n| active | Whether this Shipping Carrier is active. |\n| created_at | Date when the Shipping Carrier was created in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601). |\n| updated_at | Date when the Shipping Carrier was last updated in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601). |\n\n## Shipping Carrier Options\n\nAlmost every shipping carrier has multiple options to offer to the consumers, like standard and express shipping options. These options may provide some configurable values to the merchants through the store's admin, like additional costs and days, and also free shipping availability options.\n\n## Shipping Carrier Options Properties\n\n| Property | Explanation |\n| --- | --- |\n| id | The unique numeric identifier for the Shipping Carrier Option. |\n| code | A unique code associated with the Shipping Carrier Option. |\n| name | The name of the Shipping Carrier Option as seen by both merchants and buyers. |\n| additional_days | The additional days configurable value that will be added to the option's estimated delivery time. |\n| additional_cost | The additional cost configurable value that will be added to the option's consumer price. |\n| allow_free_shipping | The configurable free shipping eligible parameter that specifies that an option allows free shipping. |\n| active | Whether this Shipping Carrier Option is active. |\n| created_at | Date when the Shipping Carrier Option was created in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601). |\n| updated_at | Date when the Shipping Carrier Option was last updated in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601). |", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Shipping Carrier Option", "item": [ { "name": "Create a new shipping carrier option", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Shipping Carrier Ship Option 4\",\n \"code\": \"ship-code-4\",\n \"active\": true,\n \"additional_days\": 0,\n \"additional_cost\": 0,\n \"allow_free_shipping\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/shipping_carriers/{{carrier_id}}/options", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "shipping_carriers", "{{carrier_id}}", "options" ] } }, "response": [] }, { "name": "Receive a list of all shipping carriers options", "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Shipping Carrier Ship Option 4\",\n \"code\": \"ship-code-4\",\n \"active\": true,\n \"additional_days\": 1,\n \"additional_cost\": 0,\n \"allow_free_shipping\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/shipping_carriers/{{carrier_id}}/options", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "shipping_carriers", "{{carrier_id}}", "options" ] } }, "response": [] }, { "name": "Receive a single shipping carrier option", "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Shipping Carrier Ship Option 4\",\n \"code\": \"ship-code-4\",\n \"active\": true,\n \"additional_days\": 1,\n \"additional_cost\": 0,\n \"allow_free_shipping\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/shipping_carriers/{{carrier_id}}/options/{{carrier_option_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "shipping_carriers", "{{carrier_id}}", "options", "{{carrier_option_id}}" ] } }, "response": [] }, { "name": "Modify an existing shipping carrier option", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"additional_days\": 2,\n \"additional_cost\": 10.0,\n \"allow_free_shipping\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/shipping_carriers/{{carrier_id}}/options/{{carrier_option_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "shipping_carriers", "{{carrier_id}}", "options", "{{carrier_option_id}}" ] } }, "response": [] }, { "name": "Remove a shipping carrier option", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/shipping_carriers/{{carrier_id}}/options/{{carrier_option_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "shipping_carriers", "{{carrier_id}}", "options", "{{carrier_option_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version `v1`.\n\nAlmost every shipping carrier has multiple options to offer to the consumers, like standard and express shipping options. These options may provide some configurable values to the merchants through the store's admin, like additional costs and days, and also free shipping availability options." }, { "name": "Shipping Fulfillment Event", "item": [ { "name": "Receive a list of all fulfillment events for an order", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/fulfillments", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "fulfillments" ] } }, "response": [] }, { "name": "Receive a single fulfillment event", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/fulfillments/{{fulfillment_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "fulfillments", "{{fulfillment_id}}" ] } }, "response": [] }, { "name": "Create a new fulfillment event", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"delivered\",\n \"description\": \"Objeto entregue ao destinatário\",\n \"city\": \"São Paulo\",\n \"province\": \"São Paulo\",\n \"country\": \"BR\",\n \"happened_at\": \"2013-04-22T11:39:12-03:00\",\n \"estimated_delivery_at\": \"2013-04-22T11:39:12-03:00\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/fulfillments", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "fulfillments" ] } }, "response": [] }, { "name": "Remove a fulfillment event", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/fulfillments/{{fulfillment_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "fulfillments", "{{fulfillment_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version `v1`." }, { "name": "Store", "item": [ { "name": "Receive a single store filtering fields", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/store?fields", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "store" ], "query": [ { "key": "fields", "value": null } ] } }, "response": [] } ], "description": "Resource available starting from API version `v1`.\n\nThe Store resource contains general settings and information about a Tiendanube/Nuvemshop's store.\n\n## Properties\n\n| Property | Explanation |\n| --- | --- |\n| id | The unique numeric identifier for the Store |\n| name | List of the names of the Store, in every language supported by the store |\n| description | List of the descriptions of the Store, in every language supported by the store |\n| type | Store type. Examples are \"clothing\", \"sports\", \"electronic\" |\n| email | Store owner's e-mail |\n| logo | Store logo URL, starting with // (or null if it has no logo) |\n| contact_email | Store's contact e-mail |\n| facebook | Store's Facebook URL |\n| twitter | Store's Twitter URL |\n| google_plus | Store's G+ URL |\n| instagram | Store's Instagram URL |\n| pinterest | Store's Pinterest URL |\n| blog | Store's blog URL |\n| address | Store's address |\n| phone | Store's phone |\n| business_id | Business identifier (different for each country) of the company who owns the store |\n| business_name | Business name of the company who owns the store |\n| business_address | Business address of the company who owns the store |\n| customer_accounts | \"optional\" if the customer is allowed to checkout as guest. \"mandatory\" if not. |\n| plan_name | Name of the Tiendanube/Nuvemshop's plan the store is on |\n| country | Store's country in [ISO 3166-1 format](http://en.wikipedia.org/wiki/ISO_3166-1) |\n| languages | Store available languages with its currency and whether or not is active |\n| domains | List of store's domains |\n| original_domain | Original `tiendanube.com` or `nuvemshop.com.br` domain for the Store |\n| current_theme | Store's current theme |\n| main_language | Store's main language |\n| main_currency | Store's main currency in [ISO 4217 format](http://en.wikipedia.org/wiki/ISO_4217) |\n| admin_language | Store's admin language |\n| created_at | Date when the Store was created in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601) |" }, { "name": "Transaction", "item": [ { "name": "Create a transaction for a given order", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"payment_provider_id\": \"60cdeefe-4dfe-4405-8ce1-ff9b75d357a1\",\n \"payment_method\": {\n \"type\": \"credit_card\",\n \"id\": \"visa\"\n },\n \"info\": {\n \"card\": {\n \"brand\": \"visa\",\n \"expiration_month\": 12,\n \"expiration_year\": 2020,\n \"first_digits\": \"445566\",\n \"last_digits\": \"1234\",\n \"masked_number\": \"XXXXXXXXXXXX1234\",\n \"name\": \"Ash Ketchum\"\n },\n \"installments\": {\n \"quantity\": 3,\n \"interest\": \"0.15\"\n },\n \"external_id\": \"1234\",\n \"external_url\": \"https://mypayments.com/account/transactions/1234\",\n \"ip\": \"192.168.0.25\"\n },\n \"first_event\": {\n \"amount\": {\n \"value\": \"132.95\",\n \"currency\": \"BRL\"\n },\n \"type\": \"sale\",\n \"status\": \"success\",\n \"happened_at\": \"2020-01-25T12:30:15.000Z\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/transactions", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "transactions" ] } }, "response": [] }, { "name": "Create a transaction event for a given transaction", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"sale\",\n \"status\": \"success\",\n \"authorization_code\": \"1a2b3c4d\",\n \"amount\": {\n \"value\": \"9999\",\n \"currency\": \"ARS\"\n },\n \"happened_at\": \"2020-01-25T12:30:15.000Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/transactions/{{transaction_id}}/events", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "transactions", "{{transaction_id}}", "events" ] } }, "response": [] }, { "name": "Receive all transactions for a given order", "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/transactions", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "transactions" ] } }, "response": [] }, { "name": "Receive a specific transaction for a given order", "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/orders/{{order_id}}/transactions/{{transaction_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "orders", "{{order_id}}", "transactions", "{{transaction_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version `v1`.\n\nEach movement of money is modeled through a `Transaction` object, which can be of different types (e.g. credit card, debit card, boleto, wire transfer, etc.). Each `Transaction` type has a Finite State Machine (FSM) that defines its current status. The `Transaction Event` object represents transitions in the `Transaction`'s FSM.\n\nA [Payment Provider](https://payment_provider.md) can create a Transaction and update its status through Transaction Events as it changes over time. Since an order can be related to multiple payment methods, a different Transaction must be created for each of them using the same order ID.\n\n## Properties\n\nAll `Transaction` types have the same attributes, but may generate different kinds of _events_ and contain some _info_ fields specific to their type.\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | String | \\[Read-only\\] Unique identifier of the Transaction object. |\n| `payment_provider_id` | String | ID of the [Payment Provider](https://payment_provider.md) that processed this Transaction. |\n| `payment_method` | Object | Object containing the payment method used in this Transaction. See [Payment Method](#Payment-Method). |\n| `info` | Object | Object containing specific info related to this Transaction. See [Transaction Info](#Transaction-Info). |\n| `status` | Object | \\[Read-only\\] The state of the FSM in which the Transaction is. See [Transaction Status](#Transaction-Status). |\n| `events` | Array(Object) | \\[Read-only\\] List of fulfillment events related to this Transaction. See [Transaction Events](#Transaction-Events). |\n| `captured_amount` | Object | \\[Read-only\\] Object containing the captured amount of this Transaction. See [Money](#Money). |\n| `refunded_amount` | Object | \\[Read-only\\] Object containing the refunded amount of this Transaction. See [Money](#Money). |\n| `authorized_amount` | Object | \\[Read-only\\] Object containing the authorized amount of this Transaction. See [Money](#Money). |\n| `voided_amount` | Object | \\[Read-only\\] Object containing the voided amount of this Transaction. See [Money](#Money). |\n| `failure_code` | String | \\[Read-only\\] If the transaction failed, this field is used to indicate the code related to the failure cause. See [Transaction Failure Codes](#Transaction-Failure-Codes). |\n| `created_at` | Date | \\[Read-only\\] ISO 8601 date for the date the Transaction was created in our platform. Defaults to current time. E.g. `\"2020-03-11T12:42:15.000Z\"`. |\n\n> _**Note:**_ Read-only properties will only appear in our responses, which means that should not be part of the requests." }, { "name": "Webhook", "item": [ { "name": "Receive a list of all webhooks for your application", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/webhooks", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "webhooks" ] } }, "response": [] }, { "name": "Receive a list of all webhooks for your application filtering fields", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/webhooks?fields", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "webhooks" ], "query": [ { "key": "fields", "value": null } ] } }, "response": [] }, { "name": "Receive a single webhook", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/webhooks/{{webhook_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "webhooks", "{{webhook_id}}" ] } }, "response": [] }, { "name": "Create a new webhook", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"event\": \"product/created\",\n \"url\": \"https://myapp.com/product_created_hook\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/webhooks", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "webhooks" ] } }, "response": [] }, { "name": "Modify an existing webhook", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"event\": \"product/created\",\n \"url\": \"https://myapp.com/product_created_hook\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/webhooks/{{webhook_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "webhooks", "{{webhook_id}}" ] } }, "response": [] }, { "name": "Remove a webhook", "protocolProfileBehavior": { "disabledSystemHeaders": { "user-agent": true } }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{app_token}}", "type": "text" }, { "key": "User-Agent", "value": "Your App Name ({{app_id}})", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://{{api_url}}/{{api_version}}/{{store_id}}/webhooks/{{webhook_id}}", "protocol": "https", "host": [ "{{api_url}}" ], "path": [ "{{api_version}}", "{{store_id}}", "webhooks", "{{webhook_id}}" ] } }, "response": [] } ], "description": "Resource available starting from API version `v1`.\n\nA Webhook is a tool that allows you to receive a notification for a certain event. It allows you to register an _https_ URL which will receive the event data, stored in JSON. Webhooks can be registered for the following events:\n\n| Category | Events |\n| --- | --- |\n| App | uninstalled/suspended/resumed |\n| Category | created/updated/deleted |\n| Order | created/updated/paid/packed/fulfilled/cancelled |\n| Product | created/updated/deleted |\n| Domain | updated |\n| Theme | updated |\n\n## Properties\n\n| Property | Explanation |\n| --- | --- |\n| id | The unique numeric identifier for the Webhook |\n| url | The URL where the webhook should send the POST request when the event occurs. **Must be HTTPS**. |\n| event | The event that will trigger the webhook |\n| created_at | Date when the Webhook was created in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601) |\n| updated_at | Date when the Webhook was last updated in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601) |" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "api_url", "value": "api.tiendanube.com" }, { "key": "api_version", "value": "2025-03", "type": "string" }, { "key": "app_token", "value": "" }, { "key": "app_id", "value": "" }, { "key": "carrier_id", "value": "" }, { "key": "store_id", "value": "", "type": "string" }, { "key": "order_id", "value": "" }, { "key": "product_id", "value": "" }, { "key": "webhook_id", "value": "" }, { "key": "image_id", "value": "" }, { "key": "variant_id", "value": "" }, { "key": "owner_resource", "value": "" }, { "key": "draft_order_id", "value": "" }, { "key": "cart_id", "value": "" }, { "key": "transaction_id", "value": "" }, { "key": "fulfillment_id", "value": "" }, { "key": "script_id", "value": "" }, { "key": "metafield_id", "value": "" }, { "key": "customer_id", "value": "" }, { "key": "coupon_id", "value": "" }, { "key": "category_id", "value": "" }, { "key": "sku_id", "value": "" }, { "key": "promotion_id", "value": "" }, { "key": "callback_url", "value": "" }, { "key": "custom-field_id", "value": "" }, { "key": "line-item_id", "value": "" }, { "key": "location_id", "value": "" }, { "key": "fulfillment_order_id", "value": "" }, { "key": "fulfillment_event_id", "value": "" }, { "key": "plan_id", "value": "", "type": "string" }, { "key": "concept_code", "value": "", "type": "string" }, { "key": "service_id", "value": "", "type": "string" }, { "key": "dispute_id", "value": "", "type": "string" }, { "key": "email_template_id", "value": "", "type": "string" }, { "key": "page_id", "value": "", "type": "string" }, { "key": "client_secret", "value": "", "type": "string" } ] }