CHANGELOG
This changelog reflects changes in the documentation only, not in the API itself.
2025/06/23
RESOURCE:
SECTION:
DESCRIPTION:
- This update adds a note clarifying that apps must request permission to access the Shipping scope through our public API. In order to use the Shipping endpoints, the app must be registered in the Partners Portal and have explicit authorization granted by our Partner Support Team.
2025/06/11
RESOURCE:
SECTION:
DESCRIPTION:
- Updated the Payment Provider guide to reflect an increased timeout duration (from 10 to 20 seconds) for the Process Payment, Cancel Payment, and Payment Status APIs.
2025/06/02
RESOURCE:
SECTION:
DESCRIPTION:
- Add a note clarifying that the example is for a single warehouse, and include a link to the documentation with an example for multiple warehouses.
2025/05/19
RESOURCE:
SECTION:
DESCRIPTION:
- Update Postman Collection with new API endpoints.
2025/05/05
RESOURCE:
SECTION:
DESCRIPTION:
- Clarification on API Default Result Limit.
2025/05/01
RESOURCE:
SECTION:
DESCRIPTION:
- Clarify that the
reference
field in shipping rates must be a non-null string for rates to be visible in the store.
2025/04/21
RESOURCE:
SECTION:
DESCRIPTION:
- Add two new items to the "Common problems" section:
- Curl request with
code
set to null - Requesting partner credentials when accepting the app installation
- Curl request with
2025/04/11
RESOURCE:
SECTION:
DESCRIPTION:
- Add clarification about the 800ms timeout.
2025/02/20
RESOURCE:
SECTION:
DESCRIPTION:
- Clarification about the 10,000ms timeout in Payment API.
2025/02/17
RESOURCE:
SECTION:
DESCRIPTION:
- We are adding the TrackingInfoHistory field. This field will be populated whenever a change occurs in TrackingInfo.
2025/01/30
RESOURCE:
SECTION:
DESCRIPTION:
- Remove the
has_multi_cd
property.
2025/01/28
RESOURCE:
SECTION:
DESCRIPTION:
- Add the
same_billing_and_shipping_address
parameter documentation.
2025/01/24
RESOURCE:
SECTION:
DESCRIPTION:
- Decrease the maximum number of categories that can be created from 5000 to 1000
2025/01/24
RESOURCE:
SECTION:
DESCRIPTION:
- Add the
ids
parameter to the GET /products endpoint. Up to 30ids
can be included.
2025/01/14
RESOURCE:
SECTION:
DESCRIPTION:
- Add the
products.id
field, which identifies the line item ID. - Clarification on the data type of the products.id field (it can exceed int32).
2024/12/24
DESCRIPTION:
- Added Disputes resource documentation.
2024/12/20
RESOURCE:
SECTION:
DESCRIPTION:
- Clarification on sending the same
variant_id
but as separate items (differentproperties
values).
2024/12/18
RESOURCE: resources/openapi/discounts/openapi.yml
DESCRIPTION:
- Add
combines_with_other_discounts
attribute to the POST promotions payload
2024/12/05
RESOURCE:
SECTION:
DESCRIPTION:
- Add
origin.location_id
andcarrier
object with its fields in the example.
2024/11/25
RESOURCE:
SECTION:
DESCRIPTION:
- Deprecation of
MARKED_AS_FULLFILED
status. TheMARKED_AS_FULLFILED
status was originally created to indicate "manual" actions to indicate that Fulfillment Orders were dispatched, but it has no practical use. The correct status to indicate that a Fulfillment Order was dispatched is theDISPATCHED
status. - Deprecation of the
READY_TO_SHIP
status. TheREADY_FOR_SHIP
status has no practical use, in fact its status can be considered the same asPACKED
. - Create a guide for Fulfillment Order Status Workflow. Update the documentation indicating the workflow for the Fulfillment Order status by Fulfillment Order Shipping Types.
2024/11/06
RESOURCE: resources/discounts, resources/openapi/discounts/openapi.yml
DESCRIPTION:
- Remove
shipping_line
value from allocation_type
2024/11/04
RESOURCE:
SECTION:
DESCRIPTION:
- Add that the API timeout is 800ms.
2024/10/28
RESOURCE:
SECTION:
DESCRIPTION:
- Updated Circuit Breaker doc to shipping carriers.
2024/10/28
RESOURCE:
SECTION:
DESCRIPTION:
- Added fields
accepts_marketing
andaccepts_marketing_updated_at
. Theaccepts_marketing
field is read-only in the API.
2024/10/28
RESOURCE:
SECTION:
- POST /v1/{store_id}/orders/{order_id}/fulfillment-orders/{fulfillment_order_id}/tracking-events
- PUT /v1/{store_id}/orders/{order_id}/fulfillment-orders/{fulfillment_order_id}/tracking-events/||{tracking_event_id}}
DESCRIPTION:
- Adding notes on create and update tracking events. Now, if the status is DELIVERED, the fulfillment order will be marked as DELIVERED and fulfilled.
- Adding notes on create tracking events. Now, tracking event will be limited to a maximum of 100 events. An additional 101st event may be delivered.
- Adding notes on create tracking events. Now, tracking event must differ from the previous one.
2024/10/01
RESOURCE:
DESCRIPTION:
- Add Products restriction to Coupon resource.
- Update displayed Category fields in Coupon API responses.
- Rewrite list of Coupon types.
2024/09/30
RESOURCE:
SECTION:
DESCRIPTION:
- Clarification on the use of
code
in rates with pickup options.
2024/09/30
SECTION:
- Fulfillment Order Status
- Patch /v1/{store_id}/orders/{order_id}/fulfillment-orders/{fulfillment_order_id}
- POST /v1/{store_id}/orders/{order_id}/fulfillment-orders/{fulfillment_order_id}/tracking-events
- PUT /v1/{store_id}/orders/{order_id}/fulfillment-orders/{fulfillment_order_id}/tracking-events/{tracking_event_id}
DESCRIPTION:
- Adding new Fulfillment Order status: READY_FOR_SHIP
- Adding notes on update fulfillment orders. Now, if the status is MARKED_AS_FULFILLED or DELIVERED, the fulfillment order will be marked as fulfilled
- Adding notes on create and update tracking events. Now, if the status is READY_FOR_PICKUP or DELIVERED, the fulfillment order will be marked as DELIVERED and fulfilled
2024/09/23
RESOURCE:
SECTION:
DESCRIPTION:
- Clarification about fields in the API when the 'Factura A' checkbox is checked (Only Argentinian stores).
2024/09/23
RESOURCE:
SECTION:
DESCRIPTION:
- Fixed script public api parameters to follow the snake_case application standard
2024/09/19
RESOURCE:
SECTION:
DESCRIPTION:
- Added note explaining the parameters and app scripts relationship more in-depth
2024/09/19
RESOURCE:
SECTION:
DESCRIPTION:
- Modifies past documentation with whole new organization
- Added "Important" section to add disclaimers necessary for developers to be aware of
- Script code describes the script and available resources to be used within it (the script file will later be the "Script Version")
- Scripts Management section describes how scripts are not organized and registered in Tiendanube's platform
- Scripts Public API Endpoints describes the changes that are related to the script in the public API and describes the endpoint's payload
2024/09/18
DESCRIPTION:
- Added
billing_fiscal_regime
andbilling_invoice_use
field specification.
2024/09/17
RESOURCE:
DESCRIPTION:
- Added
combines_with_other_discounts
field specification.
2024/09/13
RESOURCE:
SECTION:
DESCRIPTION:
- Modify the "Bearer" header of the examples to lowcase -> "bearer".
2024/09/06
RESOURCE:
SECTION:
- FulfillmentOrderTrackingInfoInput
- PATCH /v1/{store_id}/orders/{order_id}/fulfillment-orders/{fulfillment_order_id}
DESCRIPTION:
- Add parameter notify_customer in PATCH of Fulfillment Order.
2024/09/03
RESOURCE:
SECTION:
DESCRIPTION:
- Add
properties
field in POST /draft-orders payload.
2024/09/02
RESOURCE:
SECTION:
DESCRIPTION:
- Updated the definition of the
payment->attemptId
field in the payment processing request payload.
2024/08/27
RESOURCE:
SECTION:
DESCRIPTION:
- Add
aggregates
parameter in GET /orders.
2024/08/27
RESOURCE:
SECTION:
DESCRIPTION:
- Update transaction's info object to be required.
2024/08/15
RESOURCE:
SECTION:
DESCRIPTION:
- Add clarification of the default value of the shipping_address.phone field
2024/08/13
RESOURCE:
SECTION:
DESCRIPTION:
- Fixing example for event
location/prioritization
.
2024/08/12
RESOURCE:
SECTION:
DESCRIPTION:
- Update expected response for the Payment Status API.
- Change
external_id
field to be required for new implementations.
2024/08/07
RESOURCE:
SECTION:
DESCRIPTION:
- Change Customer
name
property in Shipping_Address forfirst_name
andlast_name
.
2024/07/29
RESOURCE:
SECTION:
DESCRIPTION:
- Add LINE_ITEMS_UPDATED Checkout SDK event
2024/07/27
RESOURCE:
SECTION:
DESCRIPTION:
- Specify approval requirements for scripts using onload event. Approval needed for storefront or storefront+checkout scripts; not required for checkout-only scripts.
2024/07/17
RESOURCE:
SECTION:
DESCRIPTION:
- Add support for Chilean banks.
2024/07/13
RESOURCE:
SECTION:
DESCRIPTION:
- Remove space in Authentication header from curl.
2024/07/11
RESOURCE:
SECTION:
DESCRIPTION:
- Modify header
X-Linkedstore-HMAC-SHA256
tox-linkedstore-hmac-sha256
.
2024/07/05
RESOURCE:
SECTION:
DESCRIPTION:
- Add first_consumer_purchase attribute and filter properties.
2024/07/03
RESOURCE:
SECTION:
DESCRIPTION:
- Adding fulfillment order line item id in FulfillmentOrderLineItem.
- Adding fulfillment order line item external id in FulfillmentOrderLineItem.
- Adding fulfillment order discounts in FulfillmentOrder.
2024/07/03
RESOURCE:
SECTION:
DESCRIPTION:
- Add new endpoint (Business Rules) to the Postman collection:
- PUT {store_id}/business_rules/integrations/location
2024/06/27
RESOURCE:
SECTION:
DESCRIPTION:
- Adding new Location Prioritization documentation for Partners APIs.
2024/06/25
RESOURCE: Abandoned Checkout
SECTION:
DESCRIPTION:
- Fix the title of endpoint POST /checkouts/{cart_id}/coupons to POST /checkouts/{cart_id}/coupon
2024/06/24
RESOURCE: Postman Collection for Tiendanube/Nuvemshop API
SECTION:
DESCRIPTION:
- Add new endpoints (Business Rules) to the Postman collection:
- GET {store_id}/shipping_carriers/options
- GET {store_id}/payment_providers/options
- PUT {store_id}/business_rules/integrations/shipping
- PUT {store_id}/business_rules/integrations/payments
2024/06/19
RESOURCE: Order
SECTION:
DESCRIPTION:
- Update the default value of field
payment_status
in endpoint POST /orders. Is pending.
2024/06/19
RESOURCE:
SECTION:
DESCRIPTION:
- Add billing_customer_type,billing_business_name,billing_trade_name,billing_state_registration and billing_document_type property to order.
2024/06/14
RESOURCE: Product
SECTION:
DESCRIPTION:
- Add tags field in response examples of Products.
RESOURCE: Checkout
DESCRIPTION:
- Remove code from deprecated payment request integration and add version field to Payment Option examples.
2024/06/12
RESOURCE:
DESCRIPTION:
- Added Business Rules resource documentation.
RESOURCE: Payment Provider App Development Guide
SECTION: JS Script Methods
DESCRIPTION:
- Add specification of the version field of the Payment Option object.
RESOURCE: Checkout
DESCRIPTION:
- Remove code from deprecated payment request integration and add version field to Payment Option examples.
2024/06/11
RESOURCE:
SECTION:
DESCRIPTION:
- Add note on how to keep current category without replacing it by mistake.
2024/06/10
RESOURCES:
DESCRIPTION:
- Updates the FAQ section "How to associate or disassociate a custom-field with a specific entity?"
2024/06/05
RESOURCE:
SECTION:
DESCRIPTION:
- Add clarification on attribute/variants limit per product.
2024/06/05
RESOURCE: Webhooks
DESCRIPTION:
- Add information about deduplication of messages
2024/05/31
RESOURCE:
SECTION:
DESCRIPTION:
- Add includes_shipping property to coupon.
2024/05/28
RESOURCE: Payment Provider App Development Guide
SECTION: Implement the Payment Processing Flow
DESCRIPTION:
- Add documentation related to the new Cancel Payment and Payment Status APIs.
RESOURCE: Checkout
SECTION: Payment Option Examples
DESCRIPTION:
- Deprecate old payment option integration and add
processPayment
examples in JS script.
2024/05/27
RESOURCE:
SECTION:
DESCRIPTION:
- ADD FAQ question with clarification on the use of custom fields as a filter in the store.
2024/05/24
RESOURCE:
SECTION:
DESCRIPTION:
- Add {image_id} in title of endpoint to return a single product image.
2024/05/22
RESOURCE:
SECTION:
DESCRIPTION:
- Fixed
payment_details.installments
field definition.
2024/05/06
RESOURCE: Webhooks
DESCRIPTION:
- Add new Orders webhook: order/edited
2024/05/03
RESOURCE:
SECTION:
DESCRIPTION:
- Change response headers to lowercase: x-rate-limit-limit, x-rate-limit-remaining, x-rate-limit-reset, x-total-count, x-main-language.
2024/05/02
RESOURCE:
SECTION:
DESCRIPTION:
- Update the timeout value to 10 seconds.
2024/04/30
RESOURCE:
SECTION:
DESCRIPTION:
- Update request POST /orders adding location_id field
2024/04/26
RESOURCE:
SECTION:
DESCRIPTION:
- Improve the description of the payload signature verification process.
- Add example scripts of the verification process in Node.js, PHP and Bash languages.
2024/04/17
RESOURCE:
SECTION:
DESCRIPTION:
- Correction of the email to contact.
api@nuvemshop.com-> api@nuvemshop.com.br - Add explication about the email content:
App_id
,App_name
, funcionality of the script, and justification to chargeonload
.
2024/04/16
RESOURCE: Intro
SECTION: Rate Limiting
DESCRIPTION:
- Add note about rate limit.
2024/04/12
RESOURCE:
SECTION:
DESCRIPTION:
- Add aclaration about the code of Shipping Carrier Option and the rates.
2024/04/04
RESOURCE:
SECTION:
DESCRIPTION:
- Update request POST /draft-orders adding discount_type field
2024/04/04
RESOURCE:
SECTION:
DESCRIPTION:
- Updated request and response body examples with location id as ulid
- Update success response status code to 200 for PATCH /locations/priorities
- Update success response status code to 200 for PATCH /locations/{id}/chosen-as-default
- Update success response status code to 200 for PUT /locations/{id}
2024/03/28
RESOURCE:
SECTION:
DESCRIPTION:
- Add new endpoint PATCH /locations/priorities
- Add new endpoint PATCH /locations/{id}/chosen-as-default
- Document new rule from DELETE /locations/{id}
2024/03/04
RESOURCE:
SECTION:
DESCRIPTION:
- Fix inventory levels route.
- Adding pagination to route.
2024/03/04
RESOURCE:
SECTION:
DESCRIPTION:
- Fix title of inventory levels endpoint.
2024/02/27
RESOURCE:
SECTION:
DESCRIPTION:
- Add a note to recommend Partners to use /products/{product_id}/images endpoint in case it need insert a lot images
2024/02/26
RESOURCE:
SECTION:
DESCRIPTION:
- Add new fields to filter orders
2024/02/19
RESOURCE:
DESCRIPTION:
- Add product.properties to callback body request
2024/02/05
RESOURCE:
SECTION:
-
New Section [DELETE /customers/{id}]
DESCRIPTION:
- Add new endpoint: DELETE /customers/{id}.
2024/01/22
RESOURCE: Product Image
DESCRIPTION:
- Updating examples with webp flow
2024/01/16
RESOURCES:
SECTIONS:
-
New Section [FAQ]
DESCRIPTION:
- Add FAQ with one question in resource 'discounts.md' (about Callback URL elimination).
- Add 'phone' field in example of customer creation (
POST /customers
).
2024/01/08
RESOURCE: Postman Collection for Tiendanube/Nuvemshop API
SECTION: Downloading the collection
DESCRIPTION:
- Modify the archive postman.json (Postman Collection):
- Add new resources with endpoints.
- Add endpoints in existing resources.
- Add new variables. RESOURCE: N/A
DESCRIPTION:
- Update footer link for terms and conditions
2024/01/03
RESOURCES:
DESCRIPTION:
- Add section FAQ with two questions: 1.How to associate or disassociate a custom-field with a specific entity? 2.It's possible to delete all custom-fields with the DELETE endpoint?
2023/12/13
RESOURCE: Webhooks
DESCRIPTION:
- Updating response message when we have an 422 error for POST in Webhooks Endpoint.
2023/11/28
RESOURCES:
DESCRIPTION:
- Added message in Order API, Product API and Fulfillment Events API informing about the upcoming changes to support multi inventory.
2023/11/27
RESOURCE: Shipping Carrier App Development Guide
SECTION: Providing rates to our merchants
Description:
- Update the examples (add the Array 'rates' and modify the shipping carrier name to English).
- Add aclaration on how send one or more shipping rates in that Array.
- Add link to section where explain how the partner can providing rates.
2023/11/10
RESOURCE: Product Custom Field
DESCRIPTION:
- Documentation added to custom field endpoints for products.
2023/11/09
RESOURCE: Category Custom Field
DESCRIPTION:
- Documentation added to custom field endpoints for categories.
2023/11/08
RESOURCES:
DESCRIPTION:
- Updating custom field association payload
- Fixing HTTP return code when creating a custom field
2023/10/30
RESOURCE: Customer Custom Field
DESCRIPTION:
- Including the link in the menu.
2023/10/19
RESOURCES:
DESCRIPTION:
- Add "pos" alternative as a channel/storefront possible value.
CHANGELOG
2023/10/18
RESOURCE: Multi Inventory - How to access the new information of the Order
DESCRIPTION:
- Add warning regarding possible errors during fulfillment order creation.
2023/10/10
RESOURCE: Customer Custom Field
DESCRIPTION:
- Documentation added to custom field endpoints for customers.
2023/10/05
RESOURCE: Checkout
SECTION: Remove payment option loading
DESCRIPTION:
- Add explanation on how to use the Checkout.unLoadPaymentMethod() method
2023/09/20
RESOURCE: Fulfillment Order
SECTION: Fulfillment Order Shipping Type
DESCRIPTION:
- Adding new fulfillment order shipping type: non-shippable.
RESOURCE: Fulfillment Order
SECTION: Fulfillment Order Carrier Code Type
DESCRIPTION:
- Adding new fulfillment order carrier code type: draft and default.
RESOURCE: Fulfillment Order
SECTION: Fulfillment Order Shipping Input
DESCRIPTION:
- Adding nullable for CarrierInput and OptionInput.
2023/08/28
RESOURCE: Orders Custom Field
SECTION: Get Single Order Custom Field
DESCRIPTION:
- Endpoint to list the data of a given order custom field.
RESOURCE: Product Variants Custom Field
SECTION: Get Single Product Variants Custom Field
DESCRIPTION:
- Endpoint to list the data of a given product variant custom field.
2023/08/25
RESOURCE: [Webhook] (./resources/webhook.md)
SECTION: About the ordering of messages
DESCRIPTION:
- added context about the distributed nature of message queuing for the webhooks
2023/08/24
RESOURCE: intro
SECTION: Help us make it better.
DESCRIPTION:
- change email to support
- added support in footer to redirect support section
2023/07/27
RESOURCE: Transaction
SECTION: Refund URL
DESCRIPTION:
- Added new optional field
supports_partial_refund
to Transaction Info specification. - Updated transaction refund request specification to cover partial refund use case.
2023/07/24
RESOURCE: [multi-inventory.md] (./guides/multi-inventory)
SECTION: Changes in how to inform shipping status changes for the order
DESCRIPTION:
- Changed endpoint to inform shipping status on a fulfillment order.
RESOURCE: [multi-inventory.md] (./guides/multi-inventory)
SECTION: Webhooks
DESCRIPTION:
- Documentation deleted related to webhooks for fulfillment_orders.
RESOURCE: [fulfillment-order.md] (./resources/fulfillment-order.md)
SECTION: Webhooks
DESCRIPTION:
- Documentation deleted related to webhooks for fulfillment_orders.
2023/06/28
RESOURCE: resources/scripts
SECTION: n/a.
DESCRIPTION:
- Endpoint to list orders associated with a custom field.
- Endpoint to list custom fields associated with an order.
- Endpoint to associate a value with an order.
RESOURCE: resources/scripts
SECTION: n/a.
DESCRIPTION:
- Endpoint to list product variants associated with a custom field.
- Endpoint to list custom fields associated with a product variant.
- Endpoint to associate a value with a product variant.
2023/06/23
RESOURCE: Webhook
SECTION: n/a.
DESCRIPTION:
- Including product variant custom fields webhooks events.
2023/06/22
RESOURCE: Webhook
SECTION: n/a.
DESCRIPTION:
- Including order custom fields webhooks events.
2023/05/29
RESOURCE: resources/scripts
SECTION: n/a.
DESCRIPTION:
- Documentation added to custom field endpoints for orders.
RESOURCE: resources/scripts
SECTION: n/a.
DESCRIPTION:
- Documentation added to custom field endpoints for product variants.
2023/05/19
RESOURCE: Fulfillment Order
SECTION: Fulfillment Order
DESCRIPTION:
- Change de Fulfillment Order Status MARK_AS_FULFILLED to MARKED_AS_FULFILLED.
2023/05/16
RESOURCE: resources/payment-option
SECTION: Payment Option
DESCRIPTION:
- Added payment option resource documentation.
2023/04/28
RESOURCE: resources/scripts
SECTION: Scripts
DESCRIPTION:
- Changed script examples to use the OFI event.
- Changed the default value of script event property to OFI.
- Added the requirements to use the onload event in scripts.
2023/04/27
RESOURCE: Payment Provider
SECTION: Appendix
DESCRIPTION:
- Added more supported payment methods and banks.
2023/04/21
RESOURCE: Payment Provider App Development Guide
SECTION: Secure App Payment Processing Flow
DESCRIPTION:
- Added signature documentation to the secure app payment processing flow.
2023/04/13
RESOURCE: resources/transactions
SECTION: Transaction Info
DESCRIPTION:
- Added charges and discounts to Transaction Info object.
2023/04/12
RESOURCE: Fulfillment Order RESOURCE: Store
SECTION: Fulfillment Order SECTION: Store
DESCRIPTION:
- Add product with product_id on fulfillment order line item response
- Add new atribute
code
typeCarrierCodeType
inCarrier
model - Change FulfillmentOrderShipping.carrier.id to FulfillmentOrderShipping.carrier.carrier_id
- Add new atribute
has_multicd
inStore
model forStore API
.
2023/03/31
RESOURCE: Webhooks
SECTION: Webhooks
DESCRIPTION:
- Removed from category Theme.
2023/03/29
RESOURCE: Authentication
SECTION: Authorization Flow
DESCRIPTION:
- Added sample App ID in body of
curl
call.
2023/03/15
RESOURCE: Authentication
SECTION: Authorization Flow
DESCRIPTION:
- Added a required header to the
curl
call.
2023/03/09
RESOURCE: Payment Provider App Development Guide
SECTION: Secure App Payment Processing Flow
DESCRIPTION:
- Added documentation on the new flow to implement backend-to-backend app payment processing.
RESOURCE: Payment Provider
SECTION: Authentication
DESCRIPTION:
- Added new optional
authentication
field.
RESOURCE: Checkout
SECTION: Checkout Context
DESCRIPTION:
- Added new
Checkout
methodsprocessPayment
andshowErrorCode
.
2023/03/08
RESOURCE: Authentication
SECTION: Authorization Flow
DESCRIPTION:
- Changing auth code lifetime to 5 minutes.
2023/03/06
RESOURCE: Intro
SECTION: Rate Limiting
DESCRIPTION:
- Added rate limiting examples
2023/02/16
RESOURCE: resources/store
SECTION: GET /store
DESCRIPTION:
- Added whatsapp phone number field.
2023/02/14
RESOURCES:
SECTION: n/a.
DESCRIPTION:
- Guide simplified since Order creation API will not be modified for now.
2023/02/14
RESOURCES:
SECTION:
DESCRIPTION:
- Added new section describing changes to GET endpoints.
2023/02/14
RESOURCES:
SECTION: n/a.
DESCRIPTION:
- Added fulfillment order line item variant information
- Added fulfillment order line item identification
- Removed fulfillment order line item order line item identification
- Added multi-inventory changes-to-fulfillment-events migrate description.
2023/02/13
RESOURCES:
SECTION:
DESCRIPTION:
- Added documentation for additional shipping days for product.
2023/02/07
RESOURCES:
SECTION: n/a.
DESCRIPTION:
- Added fulfillment order shipping pickup details pickup hours list property.
- Added fulfillment order shipping option allow free shipping property.
- Added fulfillment order shipping extra properties.
- Added fulfillment order shipping line item unit price.
- Added fulfillment order shipping line item unit dimension.
- Removed paginated response from GET /v1/{store_id}/orders/{order_id}/fulfillment-orders
2023/02/06
RESOURCES:
SECTION: n/a.
DESCRIPTION:
- Added fulfillment order status history.
2023/02/02
RESOURCES:
SECTION: n/a.
DESCRIPTION:
- Added information on how to send data from Local Storage to Partner's Backend
2023/02/01
RESOURCES:
- How to adapt your app to manage stock from multiple locations
- How to access the new information of the Order
- How to adjust the creation of an order or draft order in a multi inventory environment
- resources/fulfillment-order
SECTION: n/a.
DESCRIPTION:
- Added new guide to adapt your app to a multi inventory environment.
- Added new guide for applications that need to adjust information sent when creating an order.
- Added new guide for applications that need to adjust information sent when creating an order.
- Added new Fulfillment Order resource.
2023/01/23
RESOURCE: resources/order
SECTION: Order
DESCRIPTION:
- Changed the way NFe metafields should be created/read.
2023/01/23
RESOURCE: getting started
SECTION: pagination
DESCRIPTION:
- Updated default pagination to none. Partner must specify further pages with the
page
parameter.
2023/01/23
RESOURCE: resources/scripts
SECTION: Scripts
DESCRIPTION:
- Change jQuery injection.
2023/01/09
RESOURCE: resources/discounts, resources/openapi/discounts/openapi.yml
SECTION: Message specifications
DESCRIPTION:
- Added
coupons
property to callbacks body
2022/12/26
RESOURCE: resources/category
SECTION: FAQ
DESCRIPTION:
- Added a new FAQ about adding a subcategory to an existing category.
2022/12/21
RESOURCE: resources/order
SECTION: FAQ
DESCRIPTION:
- Added a new info about best practices on how to retrieve orders.
2022/12/06
RESOURCE: Authentication
SECTION: Common Problems
DESCRIPTION:
- Added a common problems section.
2022/12/05
RESOURCE: guides/installation
SECTION: n/a.
DESCRIPTION:
- Added a new guide about installation flow.
RESOURCE: Resources/location
SECTION: n/a.
DESCRIPTION:
- Added a new feature to manage locations.
2022/12/01
RESOURCE: resources/product
SECTION: Update Stock and Price
DESCRIPTION:
- Added new endpoint (PATCH /products/stock-price) docs.
2022/11/25
RESOURCE: guides/payment-provider
SECTION: FAQs
DESCRIPTION:
- Added a FAQs section.
RESOURCE: resources/category
SECTION: FAQs
DESCRIPTION:
- Added a FAQs section.
RESOURCE: resources/product-variant
SECTION: FAQs
DESCRIPTION:
- Added a FAQs section.
2022/11/15
RESOURCE: resources/order
SECTION: Properties
DESCRIPTION:
- Added de following properties to the table:
- promotional_discount
- checkout_enabled
- shipping_suboption
- completed_at
- attributes
- cancelled_at
- closed_at
- read_at
- gateway_link
- shipping_carrier_name
- landing_url
- app_id
- Updated all the JSON examples
2022/11/14
RESOURCE: resources/shipping_carrier
SECTION: Providing rates to our merchants
DESCRIPTION:
- Added explanation of how price and price_merchant rules work for Partners of Tiendanube that want to integrate through our Shipping API
RESOURCE: guides/shipping_carrier
SECTION: Free Shipping in mixed carts
DESCRIPTION:
- Added explanation of how price and price_merchant rules work for Partners of Tiendanube that want to integrate through our Shipping API
2022/08/15
Added:
-
Resource
- Webhook Section
- Properties
- Verifying a webhook
- Parameters
- Retry policies
- Required Webhooks
- store/redact
- customers/redact
- customers/data_request
- Endpoints
- GET /webhooks/
- GET /webhooks/{id}/
- POST /webhooks/
- PUT /webhooks/{id}/
- DELETE /webhooks/{id}/
- Properties
- Transaction Section
- Payment Method
- Transaction Info
- Card Info
- Installments Info
- Refund URL
- Transaction Events
- Money
- Transaction Status
- Transaction Event Types
- Transaction Event Status
- Transaction Event Info
- Transaction Event Workflow
- Transaction Status Workflow
- Redirect Transactions Discounts
- Endpoints
- GET orders/transaction
- GET orders/{id}/transaction/{id}
- POST orders/{id}/transaction
- POST orders/{id}/transaction/{id}
- HTTP Errors List
- Common Examples
- Appendix
- Transaction Failure Codes
- Store Section
- Properties
- Endpoints
- GET /store
- Shipping Carrier Section
- Shipping Carrier Properties
- Shipping Carrier Options
- Shipping Carrier Options Properties
- Providing rates to our merchants
- Example requests for shipping rates
- Server-side caching of requests
- Endpoints
- POST /shipping_carriers
- GET /shipping_carriers
- GET /shipping_carriers/{id}
- PUT /shipping_carriers/{id}
- DELETE /shipping_carriers/{id}
- POST /shipping_carriers/{carrier_id}/options
- GET /shipping_carriers/{carrier_id}/options
- GET /shipping_carriers/{carrier_id}/options/{option_id}
- PUT /shipping_carriers/{carrier_id}/options/{option_id}
- DELETE /shipping_carriers/{carrier_id}/options/{option_id}
- Fulfillment Events
- GET orders/fulfillment
- GET orders/{id}/fulfillment
- POST orders/{id}/fulfillment
- DELETE orders/{id}/fulfillment
- Script Section
- Variables
- Store
- Checkout
- Properties
- Endpoints
- GET /script/
- GET /script/{id}/
- POST /script/
- PUT /script/{id}/
- DELETE /script/{id}/
- Variables
- Product Section
- Properties
- Endpoints
- GET /products/
- GET /products/{product_id}/
- POST /products/
- PUT /products/{product_id}/
- DELETE /products/{product_id}/
- Product Variant Section
- Properties
- Endpoints
- GET /products/{product_id}/variants
- GET /products/{product_id}/variants/{id}
- POST /products/{product_id}/variants
- PUT /products/{product_id}/variants/{id}
- DELETE /products/{product_id}/variants/{id}
- Product Image Section
- Properties
- Endpoints
- GET /products/{product_id}/images
- Size of images
- POST /products/{product_id}/images
- PUT /products/{product_id}/images/{id}
- DELETE /products/{product_id}/images/{id}
- Payment Provider Section
- Properties
- Logos
- Currency Codes
- Payment Method Types
- Payment Methods
- Rates
- Features
- Checkout Payment Options
- Money
- Endpoints
- POST /payment_providers
- PUT /paymentproviders/{payment_provider_id}
- GET /payment_providers
- GET /paymentproviders/{payment_provider_id}
- DELETE /paymentproviders/{payment_provider_id}
- HTTP Errors List
- Appendix
- Supported Payment Methods by Payment Method Type
- Properties
- Order Section
- Endpoints
- GET orders
- GET orders{id}
- POST orders
- Object
- POST orders/{id}/close
- POST orders/{id}/open
- POST orders/{id}/pack
- POST orders/{id}/fullfill
- POST orders/{id}/cancel
- Invoices (e.g. NFe in Brazil)
- Endpoints
- Metafields Section
- Properties
- Endpoints
- GET metafileds
- GET metafileds{id}
- POST metafileds
- PUT metafileds{id}
- DELETE metafileds{id}
- Draft Order Section
- Endpoints
- GET draft_order
- GET draft_order{id}
- POST draft_order
- PUT draft_order{id}
- DELETE draft_order{id}
- Endpoints
- Discount Section
- Main Concepts
- Promotions and discounts
- Tier
- How it works
- Accountabilities
- Where do I start?
- Integration
- Register a callback
- Create promotions
- Managing discounts
- Remove a discount
- Message specifications
- Request Life Cycle
- Cart Life Cycle
- Uninstalled apps
- Security
- Upcoming changes
- Signed Communication
- Frequently Asked Questions
- What happens if the server does respond properly?
- What happens if my discount is no longer valid?
- Resources
- Main Concepts
- Costumer Section
- Properties
- Endpoints
- GET custumers
- GET custumers{id}
- POST custumers
- PUT custumers {id}
- Coupons Section
- Endpoints
- GET coupons
- GET coupons{id}
- POST coupons
- PUT coupons{id}
- DELETE coupons{id}
- Endpoints
- Checkout SDK Section
- Renders in the console the list of ids of active gateways in the store.
- Hide payment options
- Adds or changes discount and installment information for a gateway
- Adds extra information to the content of the external payment method
- Hide installments from the user's picklist
- Checkout Section
- Payment Options (Javascript Interface)
- Examples
- External Payment Option
- Card Payment Option
- Modal Payment Option
- Checkout Context
- Checkout
- PaymentOptions
- Appendix
- Checkout Runtime Error Codes
- Category Section
- Notes
- Properities
- GET categories
- GET categories{id}
- POST categories
- PUT categories{id}
- DELETE categories{id}
- abandoned-checkout Section
- Notes
- Properities
- Abondoned Checkout
- Promotional Discount
- Products
- Payment Details
- Endpoint
- GET /checkouts
- GET /checkouts/{checkout_id}
- POST /checkouts/{cart_id}/coupons
- Http erros examples
- Webhook Section
-
Utils
-
postman
- Where do I start?
- Downloading the collection
- Import it into Postman
- Update variables
-
lgpd-webhooks-testing-tool
- intro
- Scope
- Test Coverage
- Complexity
- Requirements
- intro
-
Guides
-
payment-provider
- intro
- Glossary
- Payment Provider
- Payment Method Type
- Payment Method ID
- Payment Option
- Integration Type
- Payment App
- Introduction
- Step 1: Partner Account and App Creation
- Step 2: App Installation and Payment Provider Creation Flow
- Step 3: Implementing the Checkout Flow
- Step 4: Transactions Implementation
- Order Management: Refunds and Chargebacks
- Infrastructure
- App Metadata
- intro
-
shipping-provider
- intro
- Integration guide for shipping applications
- Setting-up
- Partner account and creation of the APP
- APP installation
- Get the access_token
- Creation of the Shipping Carrier
- Create shipping services (carrier_option)
- Note 1:
- Note 2:
- Note 3:
- Note 4:
- Note 5:
- example:
- Shipping Rates
- Volumetry
- Treatment of rates
- Limits
- The Code parameter
- Important:
- Example:
- About destination address
- Reference id
- Free Shipping in mixed carts
- 100% free shipping
- Mixed cart
- Shipment management
- Notification of shipments
- How to create an admin link?
- What else can I use the Admin Links for?
- Process the order
- Reporting a tracking code
- Shipping status update
- intro
-
Initial Setup
-
Home
-
template pull request
-
codeowners