Seu pagamento foi aprovado. Referente ao Pedido #1305371685465-01 |
| Olá, jose. Estamos providenciando a emissão da Nota Fiscal do seu pedido e o envio do seu produto. |
Pagamento Visa final 1111 R$ 3,99 à vista |
| Atenciosamente, |
![\"image-8b4364782e664d76a6ebc8702008e478\"](\"~/arquivos/ids/53878805-#width#-#height#/image-8b4364782e664d76a6ebc8702008e478.jpg\")
",
+ "ImagePath": "~/arquivos/ids/53878805-#width#-#height#/image-8b4364782e664d76a6ebc8702008e478.jpg",
+ "IsMain": true,
+ "IsZoomSize": true,
+ "ImageText": "image-8b4364782e664d76a6ebc8702008e478",
+ "LastModified": "2021-04-06T03:01:30.747"
+ },
+ "Offers": [
+ {
+ "SellerId": "1",
+ "SellerSkuId": "1070268",
+ "OffersPerSalesChannel": [
+ {
+ "SaleChannel": 1,
+ "Price": 0,
+ "ListPrice": 0,
+ "PriceWithoutDiscount": 0,
+ "AvailableQuantity": 0
+ }
+ ],
+ "AvailableSalesChannels": null
+ },
+ {
+ "SellerId": "madesacms",
+ "SellerSkuId": "3298",
+ "OffersPerSalesChannel": [
+ {
+ "SaleChannel": 0,
+ "Price": 1200,
+ "ListPrice": 1200,
+ "PriceWithoutDiscount": 1200,
+ "AvailableQuantity": 10000000
+ }
+ ],
+ "AvailableSalesChannels": null
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/offer-manager/pvt/product/{productId}/sku/{skuId}": {
+ "get": {
+ "tags": [
+ "Matched Offers"
+ ],
+ "summary": "Get matched offers' data by SKU ID",
+ "description": "Offers are seller products and SKUs that were sent to the marketplace, and already have their price and inventory level configured. \n\nThis endpoint retrieves the available offers for a speciic SKU ID in the marketplace's catalog. It differs from the [Get Suggestions](https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions/#get-/suggestions) endpoints, since it retrieves products that were already matched by the marketplace operator, and are currently active in its catalog. \n\nThe call returns a list of offers for that ID, that contain the following data: \n\n- Seller that sells the SKU \n\n- Correspondent SKU ID \n\n- SKU's price value \n\n- Inventory level \n\n- Sales channel (or [trade policy](https://help.vtex.com/en/tutorial/como-funciona-uma-politica-comercial--6Xef8PZiFm40kg2STrMkMV#master-data)) that it is available at. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Seller Register | Seller Administration | **View Seller** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Seller manager | View Seller |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).",
+ "operationId": "GetSKUoffers",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/productId"
+ },
+ {
+ "$ref": "#/components/parameters/skuId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/responseGetMatchedOffersDataBySKU"
+ },
+ "example": [
+ {
+ "productId": "1561208",
+ "skuId": "1559161",
+ "nameComplete": "Long sleeve cardigan - Women - Grey - L",
+ "mainImage": {
+ "imagePath": "~/arquivos/ids/8567753-#width#-#height#/image-05b40d3167b5b7ed42285124f6862f12.jpg"
+ },
+ "sellersOffers": [
+ {
+ "sellerId": "1",
+ "sellerSkuId": "1559161",
+ "salesChannelOffer": [
+ {
+ "salesChannelId": "1",
+ "salesChannelName": "Principal",
+ "price": 49.99,
+ "listPrice": 59.99,
+ "priceWithoutDiscount": 49.99,
+ "availableQuantity": 8
+ },
+ {
+ "salesChannelId": "2",
+ "salesChannelName": "Online Store",
+ "price": 47.99,
+ "listPrice": 59.99,
+ "priceWithoutDiscount": 47.99,
+ "availableQuantity": 12
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/offer-manager/pvt/product/{productId}": {
+ "get": {
+ "tags": [
+ "Matched Offers"
+ ],
+ "summary": "Get matched offers' data by product ID",
+ "operationId": "GetProductoffers",
+ "description": "Offers are seller products and SKUs that were sent to the marketplace, and already have their price and inventory level configured. \n\nThis endpoint retrieves the available offers for a speciic Product ID in the marketplace's catalog. It differs from the Get Suggestions endpoints, since it retrieves products that were already matched by the marketplace operator, and are currently active in its catalog. \n\nThe call returns a list of offers for that ID, that contain the following data: \n\n- Seller that sells the SKU \n\n- Correspondent SKU ID \n\n- SKU's price value \n\n- Inventory level \n\n- Sales channel (or [trade policy](https://help.vtex.com/en/tutorial/como-funciona-uma-politica-comercial--6Xef8PZiFm40kg2STrMkMV#master-data)) that it is available at.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Seller Register | Seller Administration | **View Seller** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Seller manager | View Seller |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/productId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/responseGetMatchedOffersDataByProductId"
+ },
+ "example": [
+ {
+ "productId": "1561208",
+ "skuId": "1559161",
+ "nameComplete": "Long sleeve cardigan - Women - Grey - L",
+ "mainImage": {
+ "imagePath": "~/arquivos/ids/8567753-#width#-#height#/image-05b40d3167b5b7ed42285124f6862f12.jpg"
+ },
+ "sellersOffers": [
+ {
+ "sellerId": "1",
+ "sellerSkuId": "1559161",
+ "salesChannelOffer": {
+ "salesChannelId": "1",
+ "salesChannelName": "Principal",
+ "price": 0,
+ "listPrice": 0,
+ "priceWithoutDiscount": 0,
+ "availableQuantity": 0
+ }
+ }
+ ]
+ },
+ {
+ "productId": "1561208",
+ "skuId": "1559163",
+ "nameComplete": "Long sleeve cardigan - Women - Grey - XS",
+ "mainImage": {
+ "imagePath": "~/arquivos/ids/8567753-#width#-#height#/image-05b40d3167b5b7ed42285124f6862f12.jpg"
+ },
+ "sellersOffers": [
+ {
+ "sellerId": "1",
+ "sellerSkuId": "1559161",
+ "salesChannelOffer": {
+ "salesChannelId": "1",
+ "salesChannelName": "Principal",
+ "price": 0,
+ "listPrice": 0,
+ "priceWithoutDiscount": 0,
+ "availableQuantity": 0
+ }
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/seller-register/pvt/seller-leads": {
+ "post": {
+ "tags": [
+ "Seller Invite"
+ ],
+ "summary": "Invite seller lead",
+ "description": "This API is used by marketplace operators to invite sellers to join their marketplace. The request sends an email to the seller, inviting sellers to activate their store. The invitation's link in the email is unique per user, and available for only seven days for the seller to click and begin activating their store. \n\nThe email template is completely customizable. All email templates that VTEX sends to seller leads can be found and edited in the marketplace's VTEX Admin, on the Message Center section.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Seller Register | Seller Administration | **View Seller** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Seller manager | View Seller |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "CreateSellerLead",
+ "requestBody": {
+ "description": "This request requires detailed information about the seller, including their email, name, account name, sales channel, and other related details. Data should be in JSON format and follow the schema specified in 'CreateSellerLeadRequest'. A sample valid payload is provided for reference, including details such as address, contact information, and acceptance of legal terms.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateSellerLeadRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/responseCreateSellerLead"
+ },
+ "example": {
+ "sellerId": "7890123456",
+ "createdAt": "2023-01-01T12:34:56Z",
+ "updatedAt": "2023-01-01T12:34:56Z"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false
+ },
+ "get": {
+ "tags": [
+ "Seller Invite"
+ ],
+ "summary": "List seller leads",
+ "operationId": "ListSellerLeads",
+ "description": "This call's response includes a list of all sellers invited by the marketplace operator to join them. Retrieved results can be filtered by adding optional query fields to the request. Each seller listed includes the following information: \n\n- `id` \n\n- `createdAt` \n\n- `status` \n\n- `isConnected` \n\n- `sellerEmail` \n\n- `sellerName` \n\n- `salesChannel` \n\n- `email`\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Seller Register | Seller Administration | **View Seller** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Seller manager | View Seller |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/offset"
+ },
+ {
+ "$ref": "#/components/parameters/limit"
+ },
+ {
+ "$ref": "#/components/parameters/isConnected"
+ },
+ {
+ "$ref": "#/components/parameters/search"
+ },
+ {
+ "$ref": "#/components/parameters/status"
+ },
+ {
+ "$ref": "#/components/parameters/orderBy"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "headers": {}
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/seller-register/pvt/seller-leads/{sellerLeadId}": {
+ "put": {
+ "tags": [
+ "Seller Invite"
+ ],
+ "summary": "Accept seller lead",
+ "operationId": "AcceptSellerLead",
+ "description": "This endpoint is triggered by the seller onboarding wizard, once the seller confirms their invitation. It can be used by marketplace operators to manually accept seller leads, and carry on with their onboarding process. \n\nNote that there's no specific API call that allows status changes. The operations only allow the seller lead to move forward: \n\n From `invite` > to `Accept` > closing on `[Create seller](https://developers.vtex.com/docs/api-reference/marketplace-apis/#put-/seller-register/pvt/seller-leads/-sellerLeadId-/seller)`. \n\nIf you want to change the status, you can start the process again, by deleting that lead through the *[Delete seller lead](https://developers.vtex.com/docs/api-reference/marketplace-apis/#delete-/seller-register/pvt/seller-leads/-sellerLeadId-)* endpoint, and resending the invite through the *[Resend seller lead's Invite](https://developers.vtex.com/docs/api-reference/marketplace-apis/#put-/seller-register/pvt/seller-leads/-sellerLeadId-/status)* endpoint. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Seller Register | Seller Administration | **Save Seller** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Seller manager | Save Seller |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "requestBody": {
+ "description": "This request requires information about the seller who is accepting the lead, including their email, name, account name, sales channel, and other relevant details.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AcceptSellerLeadRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "headers": {}
+ }
+ },
+ "deprecated": false
+ },
+ "get": {
+ "tags": [
+ "Seller Invite"
+ ],
+ "summary": "Get seller lead's data by ID",
+ "operationId": "RetrieveSellerLead",
+ "description": "Marketplace operators may call this endpoint to retrieve information about a specific seller invited to the Seller Portal, by searching through their seller lead ID. To retrieve the chosen seller's `sellerLeadId`, marketplace operators can use the [List Sellers](https://developers.vtex.com/docs/api-reference/marketplace-apis#get-/seller-register/pvt/sellers?endpoint=get-/seller-register/pvt/sellers) endpoint's response. Each seller listed includes the following information: \n\n- `id` \n\n- `createdAt` \n\n- `status` \n\n- `isConnected` \n\n- `sellerEmail` \n\n- `sellerName` \n\n- `salesChannel` \n\n- `email`. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Seller Register | Seller Administration | **View Seller** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Seller manager | View Seller |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "headers": {}
+ }
+ },
+ "deprecated": false
+ },
+ "delete": {
+ "tags": [
+ "Seller Invite"
+ ],
+ "summary": "Delete seller lead",
+ "description": "This endpoint permanently deletes a seller previously invited to the marketplace, only if the seller has not yet accepted the invitation. For sellers who have already accepted the invitation, it is only possible to [pause the seller](https://help.vtex.com/en/tutorial/gerenciamento-de-sellers--6eEiOISwxuAWJ8w6MtK7iv) through the VTEX Admin. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Seller Register | Seller Administration | **Save Seller** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Seller Manager| Save Seller |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+ "operationId": "RemoveSellerLead",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/sellerLeadId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "headers": {}
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/seller-register/pvt/seller-leads/{sellerLeadId}/seller": {
+ "put": {
+ "tags": [
+ "Seller Invite"
+ ],
+ "summary": "Create seller from lead",
+ "operationId": "CreateSellerFromSellerLead",
+ "description": "This endpoint is used by marketplace operators to create seller accounts. The request will only accept seller leads whose status is `accepted`. If they are already `connected` or `invited`, the call will not be fulfilled. \n\n >❗ The creation of the account at VTEX is done by an internal Billing service. There is no seller account and marketplace affiliation if you do not go through this step. \n\nNote that there's no specific API call that allows status changes. The operations only allow the seller lead to move forward: \n\n From `invite` > to `Accepted` > closing on `Create Seller`. \n\nIf you want to change the status, you can start the process again, by deleting that lead through the *[Delete seller lead](https://developers.vtex.com/docs/api-reference/marketplace-apis#delete-/seller-register/pvt/seller-leads/-sellerLeadId-)* endpoint, and resending the invite through the *[Resend seller lead's invite](https://developers.vtex.com/docs/api-reference/marketplace-apis/#put-/seller-register/pvt/seller-leads/-sellerLeadId-/status)* endpoint. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Seller Register | Seller Administration | **Save Seller** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Seller manager | Save Seller |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/isActive"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "headers": {}
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/seller-register/pvt/seller-leads/{sellerLeadId}/status": {
+ "put": {
+ "tags": [
+ "Seller Invite"
+ ],
+ "summary": "Resend seller lead invite",
+ "description": "This endpoint allows marketplace operators to resend an invitation to a seller lead who was previously invited to join their marketplace. The request will only accept seller leads whose status is `invited`. If they are already `connected` or `accepted`, the call will not be fulfilled. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Seller Register | Seller Administration | **Save Seller** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Seller manager | Save Seller |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "ResendSellerLeadRequest",
+ "requestBody": {
+ "description": "This request requires information specifying the action to be taken, such as the status to be resent.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ResendSellerLeadRequestRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "headers": {}
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/seller-register/pvt/sellers/{sellerId}/commissions": {
+ "get": {
+ "tags": [
+ "Seller Commissions"
+ ],
+ "summary": "List seller commissions by seller ID",
+ "description": "This endpoint retrieves all comissions configured for a specific seller. It is not necessary to send a request body.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n|---|---|---|\r\n| Seller Register | Seller adminstration | View Seller |\r\n| Seller Register | Seller administration | Save Seller |\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Seller manager | View Seller |\r\n|Seller manager | Save Seller | \r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with this feature or use one of the predefined roles from the list above.\r\n\r\n >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+ "operationId": "ListSellerCommissions",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/sellerId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "description": "Array with objects containing information about the category, seller and percentage of commission applied.",
+ "items": {
+ "$ref": "#/components/schemas/responseSellerCommissionsID"
+ }
+ },
+ "example": [
+ {
+ "categoryId": "51",
+ "categoryName": "Clothes",
+ "categoryFullPath": [
+ "2.0",
+ "Boys",
+ "Clothes"
+ ],
+ "productCommissionPercentage": 7.75,
+ "freightCommissionPercentage": 2.33
+ }
+ ]
+ }
+ }
+ }
+ },
+ "deprecated": false
+ },
+ "put": {
+ "tags": [
+ "Seller Commissions"
+ ],
+ "summary": "Upsert seller commissions in bulk",
+ "description": "This endpoint is used by marketplace operators to define comissions for multiple categories, sending an array with multiple objects in the same call.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n|---|---|---|\r\n| Seller Register | Seller administration | Save Seller |\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n|Seller manager | Save Seller | \r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with this feature or use one of the predefined roles from the list above.\r\n\r\n >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "BulkUpsertSellerCommissions",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/sellerId"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "description": "Array with objects containing information about the category, seller and commission percentage to be applied.",
+ "items": {
+ "$ref": "#/components/schemas/BulkUpsertSellerCommissionsRequest"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "204": {
+ "description": "No Content"
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/seller-register/pvt/sellers/{sellerId}/commissions/{categoryId}": {
+ "delete": {
+ "tags": [
+ "Seller Commissions"
+ ],
+ "summary": "Remove seller commissions by category ID",
+ "operationId": "RemoveSellerCommissions",
+ "description": "This endpoint removes a seller comission on the selected category.\r\n\r\n >❗This action cannot be undone, to reconfigure the commission it is necessary to use the [Upsert Seller Commissions in Bulk endpoint](https://developers.vtex.com/docs/api-reference/marketplace-apis#put-/seller-register/pvt/sellers/-sellerId-/commissions/categories?endpoint=put-/seller-register/pvt/sellers/-sellerId-/commissions/categories). \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n|---|---|---|\r\n| Seller Register | Seller administration | Save Seller |\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n|Seller manager | Save Seller | \r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with this feature or use one of the predefined roles from the list above.\r\n\r\n >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/sellerId"
+ },
+ {
+ "$ref": "#/components/parameters/categoryId"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ }
+ },
+ "deprecated": false
+ },
+ "get": {
+ "tags": [
+ "Seller Commissions"
+ ],
+ "summary": "Get seller commissions by category ID",
+ "operationId": "RetrieveSellerCommissions",
+ "description": "This endpoint retrieves seller comissions applied to the selected category. It is not necessary to send a request body.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n|---|---|---|\r\n| Seller Register | Seller administration | View Seller |\r\n| Seller Register | Seller administration | Save Seller |\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n|Seller manager | View Seller |\r\n|Seller manager | Save Seller | \r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with this feature or use one of the predefined roles from the list above.\r\n\r\n >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+ "parameters": [
+ {
+ "name": "sellerId",
+ "in": "path",
+ "description": "A string that identifies the seller in the marketplace. This ID must be created by the marketplace.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "default": "seller123"
+ }
+ },
+ {
+ "name": "categoryId",
+ "in": "path",
+ "description": "ID of the category in which the comission was applied",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "default": "6"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/responseSellerCommissionsID"
+ },
+ "example": {
+ "categoryId": "51",
+ "categoryName": "Clothes",
+ "categoryFullPath": [
+ "2.0",
+ "Boys",
+ "Clothes"
+ ],
+ "productCommissionPercentage": 7.75,
+ "freightCommissionPercentage": 2.33
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/seller-register/pvt/sellers": {
+ "post": {
+ "tags": [
+ "Sellers"
+ ],
+ "summary": "Configure seller account",
+ "description": "This endpoint is used by marketplace operators to configure the accounts of sellers that have already accepted the invitation to join their marketplaces. \n\nFor marketplaces to [add sellers](https://help.vtex.com/en/tutorial/adding-a-seller--tutorials_392) without the [Seller Invite](https://help.vtex.com/en/tutorial/marketplace-invited-sellers--6rb2FkcslmDueJ689Ulb9A) feature, call this endpoint directly. \n\nThis call includes all the information a seller needs to activate their account. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Seller Register | Seller Administration | **Save Seller** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Seller manager | Save Seller |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "UpsertSellerRequest",
+ "requestBody": {
+ "description": "Request to upsert seller information.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UpsertSellerRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "headers": {}
+ }
+ },
+ "deprecated": false
+ },
+ "get": {
+ "tags": [
+ "Sellers"
+ ],
+ "summary": "List sellers",
+ "description": "This endpoint lists all sellers. The results can be filtered by [trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) through the `sc` query param. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Seller Register | Seller Administration | **View Seller** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Seller manager | View Seller |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).",
+ "operationId": "GetListSellers",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/from"
+ },
+ {
+ "$ref": "#/components/parameters/to"
+ },
+ {
+ "$ref": "#/components/parameters/keyword"
+ },
+ {
+ "$ref": "#/components/parameters/integration"
+ },
+ {
+ "$ref": "#/components/parameters/group"
+ },
+ {
+ "$ref": "#/components/parameters/isActive"
+ },
+ {
+ "$ref": "#/components/parameters/isBetterScope"
+ },
+ {
+ "$ref": "#/components/parameters/isVtex"
+ },
+ {
+ "$ref": "#/components/parameters/sc"
+ },
+ {
+ "$ref": "#/components/parameters/sellerType"
+ },
+ {
+ "$ref": "#/components/parameters/sort"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "headers": {}
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/seller-register/pvt/sellers/{sellerId}": {
+ "patch": {
+ "tags": [
+ "Sellers"
+ ],
+ "summary": "Update seller by seller ID",
+ "description": "This endpoint allows marketplace operators to update the information of sellers connected to their account. You can replace a path's value with another value in order to update that single information. There is no need to fill all the body params available, only the one you wish to update. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Seller Register | Seller Administration | **Save Seller** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Seller manager | Save Seller |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "UpdateSeller",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/sellerId"
+ }
+ ],
+ "requestBody": {
+ "description": "array of objects",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "description": "array of objects",
+ "title": "Request body",
+ "items": {
+ "description": "Object representing the mapping configuration between the marketplace's sales channel and the seller's affiliate channel. This configuration allows for associating a marketplace sales channel with a seller's affiliate channel for proper sales channel management.",
+ "type": "object",
+ "required": [
+ "operation",
+ "path",
+ "value"
+ ],
+ "properties": {
+ "operation": {
+ "type": "string",
+ "description": "Action being performed, which should always be `replace`.",
+ "example": "replace"
+ },
+ "path": {
+ "type": "string",
+ "description": "Path in which the value is being updated. It follows the standardized format `/{field}`, where `{field}` is the path's name.",
+ "example": "/field"
+ },
+ "value": {
+ "type": "boolean",
+ "description": "Value that is being updated. Notice that the type will depend on the path that is being updated.",
+ "example": false
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "headers": {}
+ }
+ },
+ "deprecated": false
+ },
+ "get": {
+ "tags": [
+ "Sellers"
+ ],
+ "summary": "Get seller data by ID",
+ "operationId": "GetRetrieveSeller",
+ "description": "Marketplace operators may call this endpoint to retrieve information about a specific seller by filtering by ID. It is also possible to filter results by sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) through the `sc` query param. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Seller Register | Seller Administration | **View Seller** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Seller manager | View Seller |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/sc"
+ },
+ {
+ "$ref": "#/components/parameters/sellerId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "headers": {}
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/seller-register/pvt/sellers/{sellerId}/sales-channel/mapping": {
+ "put": {
+ "tags": [
+ "Sales Channel Mapping"
+ ],
+ "summary": "Upsert sales channel mapping",
+ "description": "This endpoint allows the marketplace to map its [trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) with a seller's [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187). A seller can have multiple [trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) associated with the same marketplace, creating different affiliates. The mapping allows the seller to segment catalog, pricing, inventory, logistics, and payments in the marketplace. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager capabilities](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) in order to successfully execute this request. Otherwise, they will receive a `403` status code error. These are the applicable capabilities for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Seller Register | Seller Administration | **Save seller** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with this resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Seller Manager | Save Seller |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys typically grants permission to several [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not required, consider creating a custom role. For more information about security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "UpsertMapping",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/an"
+ },
+ {
+ "$ref": "#/components/parameters/sellerId"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UpsertMappingRequest"
+ },
+ "example": [
+ {
+ "marketplaceSalesChannel": 1,
+ "sellerChannel": "GCB"
+ },
+ {
+ "marketplaceSalesChannel": 2,
+ "sellerChannel": "DFT"
+ }
+ ]
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "description": "Object that represents the mapping configuration between the marketplace [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) and the seller's affiliate channel. This configuration allows you to associate a marketplace trade policy with a seller's affiliate channel for proper management of trade policies.",
+ "type": "object",
+ "properties": {
+ "marketplaceSalesChannel": {
+ "type": "string",
+ "description": "Marketplace's trade policy that will be associated to the seller's [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187)."
+ },
+ "sellerChannel": {
+ "type": "string",
+ "description": "Seller's [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) that will be associated with the marketplace's trade policy. Through the affiliate, the seller determines which of his trade policy will be used for the mapping."
+ }
+ }
+ }
+ },
+ "example": [
+ {
+ "marketplaceSalesChannel": "1",
+ "sellerChannel": "GCC"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "deprecated": false
+ },
+ "get": {
+ "tags": [
+ "Sales Channel Mapping"
+ ],
+ "summary": "Get sales channel mapping data",
+ "description": "Retrieves information about the mapping between marketplace's sales channels and a specific seller. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Seller Register | Seller Administration | **View Seller** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Seller manager | View Seller |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).",
+ "operationId": "RetrieveMapping",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/an"
+ },
+ {
+ "$ref": "#/components/parameters/sellerId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "description": "Object representing the mapping between the marketplace's trade policy and the seller's affiliate channel. This allows for the association and management of trade policy between the marketplace and the seller's affiliate.",
+ "type": "object",
+ "properties": {
+ "marketplaceSalesChannel": {
+ "type": "string",
+ "description": "Marketplace's sales channel that will be associated to the seller's [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187).",
+ "default": "1"
+ },
+ "sellerChannel": {
+ "type": "string",
+ "description": "Seller's [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) that will be associated with the marketplace's sales channel. Through the affiliate, the seller determines which of his sales channel will be used for the mapping.",
+ "default": "GCB"
+ }
+ }
+ },
+ "title": "UpsertMapping",
+ "properties": {
+ "marketplaceSalesChannel": {
+ "type": "integer",
+ "description": "Marketplace's sales channel that will be associated to the seller's [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187).",
+ "default": 1
+ },
+ "sellerChannel": {
+ "type": "string",
+ "description": "Seller's [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) that will be associated with the marketplace's sales channel. Through the affiliate, the seller determines which of his sales channel will be used for the mapping.",
+ "default": "GCB"
+ }
+ }
+ },
+ "example": [
+ {
+ "marketplaceSalesChannel": "1",
+ "sellerChannel": "GCC"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/fulfillment/pvt/affiliates": {
+ "get": {
+ "summary": "List affiliates",
+ "description": "Lists all [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) configurations in a store.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Save Order Configuration** |\r\n| Checkout | CheckoutResources | **Save OrderForm Configuration** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "tags": [
+ "Affiliates"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/responseListAffiliates"
+ },
+ "example": [
+ {
+ "id": "LNG",
+ "followUpEmail": "your@email.com",
+ "useSellerPaymentMethod": false,
+ "name": "Lengow",
+ "salesChannel": "1",
+ "searchURIEndpoint": null,
+ "searchURIEndpointVersion": "1.x.x",
+ "searchURIEndpointAvailableVersions": [
+ "1.x.x"
+ ],
+ "minimumValueAccumulated": 5000
+ },
+ {
+ "id": "CNT",
+ "followUpEmail": "email@email.com",
+ "useSellerPaymentMethod": false,
+ "name": "Centauro - lojadobreno",
+ "salesChannel": "2",
+ "searchURIEndpoint": "http://centaurointegration.vtexinternal.com.br/api/centaurointegration/indexedstockkeepingunit?an=lojadobreno",
+ "searchURIEndpointVersion": "1.x.x",
+ "searchURIEndpointAvailableVersions": [
+ "1.x.x"
+ ],
+ "minimumValueAccumulated": 1000
+ },
+ {
+ "id": "MLC",
+ "followUpEmail": "null",
+ "useSellerPaymentMethod": false,
+ "name": "Mercado Livre - lojadobreno - gold_special",
+ "salesChannel": "2",
+ "searchURIEndpoint": "http://meliintegration.vtexinternal.com/api/meliintegration/commercialcondition?an=lojadobreno<=gold_special",
+ "searchURIEndpointVersion": "1.x.x",
+ "searchURIEndpointAvailableVersions": [
+ "1.x.x"
+ ],
+ "minimumValueAccumulated": 2000
+ }
+ ]
+ }
+ }
+ }
+ },
+ "operationId": "get_fulfillment_pvt_affiliates"
+ }
+ },
+ "/fulfillment/pvt/affiliates/{affiliateId}": {
+ "get": {
+ "summary": "Get affiliate by ID",
+ "description": "Retrieves the specified [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) configuration by affiliate ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Save Order Configuration** |\r\n| Checkout | CheckoutResources | **Save OrderForm Configuration** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "tags": [
+ "Affiliates"
+ ],
+ "parameters": [
+ {
+ "in": "path",
+ "name": "affiliateId",
+ "description": "Three-letter identifier defined during the affiliate configuration creation. Vowels are not allowed.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "minLength": 3,
+ "maxLength": 3,
+ "example": "LNG"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/responseGetAffiliates"
+ },
+ "example": {
+ "id": "LNG",
+ "followUpEmail": "your@email.com",
+ "useSellerPaymentMethod": false,
+ "name": "Lengow",
+ "salesChannel": "1",
+ "searchURIEndpoint": null,
+ "searchURIEndpointVersion": "1.x.x",
+ "searchURIEndpointAvailableVersions": [
+ "1.x.x"
+ ],
+ "minimumValueAccumulated": 5000
+ }
+ }
+ }
+ }
+ },
+ "operationId": "get_fulfillment_pvt_affiliates_ByAffiliateId"
+ },
+ "put": {
+ "summary": "Update affiliate by ID",
+ "description": "Updates the [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) configuration by ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Save Order Configuration** |\r\n| Checkout | CheckoutResources | **Save OrderForm Configuration** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "tags": [
+ "Affiliates"
+ ],
+ "parameters": [
+ {
+ "in": "path",
+ "name": "affiliateId",
+ "description": "Three-letter identifier defined during the affiliate configuration creation.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "minLength": 3,
+ "maxLength": 3,
+ "example": "LNG"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/requestUpdateAffiliate"
+ },
+ "example": {
+ "followUpEmail": "example@email.com",
+ "name": "Affiliate name",
+ "salesChannel": "1",
+ "searchURIEndpoint": "",
+ "searchURIEndpointVersion": "1.x.x",
+ "searchURIEndpointAvailableVersions": [
+ "1.x.x"
+ ],
+ "minimumValueAccumulated": 5000
+ }
+ }
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "No Content"
+ }
+ },
+ "operationId": "put_fulfillment_pvt_affiliates_ByAffiliateId"
+ },
+ "delete": {
+ "summary": "Delete affiliate by ID",
+ "description": "Deletes the specified [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) configuration by ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Save Order Configuration** |\r\n| Checkout | CheckoutResources | **Save OrderForm Configuration** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "tags": [
+ "Affiliates"
+ ],
+ "parameters": [
+ {
+ "in": "path",
+ "name": "affiliateId",
+ "description": "Three-letter identifier defined during the affiliate configuration creation.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "minLength": 3,
+ "maxLength": 3,
+ "example": "LNG"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ }
+ },
+ "operationId": "delete_fulfillment_pvt_affiliates_ByAffiliateId"
+ }
+ }
+ },
+ "security": [
+ {
+ "appKey": [],
+ "appToken": []
+ }
+ ],
+ "components": {
+ "schemas": {
+ "UpsertMappingRequest": {
+ "description": "Request to upsert a mapping between a marketplace's sales channel and a seller's affiliate.",
+ "required": [
+ "marketplaceSalesChannel",
+ "sellerChannel"
+ ],
+ "type": "object",
+ "properties": {
+ "marketplaceSalesChannel": {
+ "type": "integer",
+ "description": "The sales channel of the marketplace to be associated with the seller's affiliate. It is linked to the seller's affiliate.",
+ "example": 1
+ },
+ "sellerChannel": {
+ "type": "string",
+ "description": "The affiliate of the seller that will be associated with the marketplace's sales channel. Through the affiliate, the seller determines which of his sales channels will be used for the mapping.",
+ "example": "GCB"
+ }
+ },
+ "example": {
+ "marketplaceSalesChannel": 1,
+ "sellerChannel": "GCB"
+ }
+ },
+ "responseSellerCommissionsID": {
+ "type": "object",
+ "description": "Object with the category properties and the commission percentage applied to it.",
+ "properties": {
+ "categoryId": {
+ "type": "string",
+ "description": "Marketplace's category ID that the product belongs to, configured in the Catalog."
+ },
+ "categoryName": {
+ "type": "string",
+ "description": "Category name with applied commission."
+ },
+ "categoryFullPath": {
+ "type": "array",
+ "description": "Full path to the SKU's category.",
+ "items": {
+ "description": "Category level name.",
+ "type": "string"
+ }
+ },
+ "productCommissionPercentage": {
+ "type": "number",
+ "description": "Percentage of the comission applied to the product in decimals."
+ },
+ "freightCommissionPercentage": {
+ "type": "number",
+ "description": "Percentage of the comission applied to the freight in decimals."
+ }
+ }
+ },
+ "BulkUpsertSellerCommissionsRequest": {
+ "description": "Request to bulk upsert (update or insert) seller commission configurations for multiple categories. This includes details such as the category ID, full path of the category, product commission percentage, and freight commission percentage.",
+ "type": "object",
+ "required": [
+ "categoryId",
+ "categoryFullPath",
+ "productCommissionPercentage",
+ "freightCommissionPercentage"
+ ],
+ "properties": {
+ "categoryId": {
+ "type": "string",
+ "description": "Marketplace's Category ID that the product belongs to, configured in the Catalog.",
+ "example": "6"
+ },
+ "categoryFullPath": {
+ "type": "string",
+ "nullable": true,
+ "description": "Full path to the SKU's category. It should be written as {department}/{category}. For example: if the department is **Appliances** and the category is **Oven**, the full path should be 'Appliances/Oven'.",
+ "example": "Appliances/Oven"
+ },
+ "productCommissionPercentage": {
+ "type": "number",
+ "description": "Percentage of the comission applied to the product in decimals.",
+ "example": 9.85
+ },
+ "freightCommissionPercentage": {
+ "type": "number",
+ "description": "Percentage of the comission applied to the freight in decimals.",
+ "example": 2.43
+ }
+ },
+ "example": {
+ "categoryId": "6",
+ "categoryFullPath": null,
+ "productCommissionPercentage": 9.85,
+ "freightCommissionPercentage": 2.43
+ }
+ },
+ "CreateSellerLeadRequest": {
+ "description": "Request to create a seller lead. This includes detailed information about the seller, such as their email, name, account name, trade policy, contact email, seller type, account ID, accountable person, acceptance of legal terms, address, and document details.",
+ "required": [
+ "sellerEmail",
+ "sellerName",
+ "sellerAccountName",
+ "salesChannel",
+ "email",
+ "sellerType",
+ "accountId",
+ "accountable",
+ "hasAcceptedLegalTerms",
+ "address",
+ "document"
+ ],
+ "type": "object",
+ "properties": {
+ "sellerEmail": {
+ "type": "string",
+ "description": "Seller's contact email.",
+ "example": "selleremail@email.com"
+ },
+ "sellerName": {
+ "type": "string",
+ "description": "Seller's store's name.",
+ "example": "Seller Name"
+ },
+ "sellerAccountName": {
+ "type": "string",
+ "description": "Name of the seller's account, part of the url of their VTEX Admin.",
+ "example": "seller123"
+ },
+ "salesChannel": {
+ "type": "string",
+ "description": "Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) associated to the seller account created.",
+ "example": "1"
+ },
+ "email": {
+ "description": "The email address associated with the seller. It should be in a valid email format.",
+ "type": "string",
+ "example": "email@email.com"
+ },
+ "sellerType": {
+ "type": "integer",
+ "description": "Type of seller, which can be: \n\n`1`: Regular seller \n\n`2`: White label seller.",
+ "example": 1
+ },
+ "accountId": {
+ "type": "string",
+ "description": "Marketplace's account ID.",
+ "example": "5fb38ace-d95e-45ad-970d-ee97cce9fbcd"
+ },
+ "document": {
+ "type": "string",
+ "description": "Company's legal document number.",
+ "example": "12345671000"
+ },
+ "hasAcceptedLegalTerms": {
+ "type": "boolean",
+ "description": "Indicates if the seller has accepted the platform's legal terms and conditions.",
+ "example": true
+ },
+ "address": {
+ "$ref": "#/components/schemas/address"
+ },
+ "accountable": {
+ "$ref": "#/components/schemas/accountable"
+ }
+ },
+ "example": {
+ "sellerEmail": "selleremail@email.com",
+ "sellerName": "Seller Name",
+ "sellerAccountName": "seller123",
+ "salesChannel": "1",
+ "email": "email@email.com",
+ "sellerType": 1,
+ "accountId": "5fb38ace-d95e-45ad-970d-ee97cce9fbcd",
+ "document": "12345671000",
+ "hasAcceptedLegalTerms": true,
+ "address": {
+ "postalcode": "12345678",
+ "complement": "Appartment 1234",
+ "street": "VTEX street",
+ "number": "25",
+ "neighborhood": "VTEX quarter",
+ "state": "RJ",
+ "city": "Rio de Janeiro"
+ },
+ "accountable": {
+ "name": "Jane Smith",
+ "email": "email@email.com",
+ "phone": "1234567890"
+ }
+ }
+ },
+ "responseCreateSellerLead": {
+ "type": "object",
+ "description": "Response object for creating a seller lead. It includes details about the created seller, such as their ID, the creation date, and the date of the last update.",
+ "properties": {
+ "sellerId": {
+ "type": "string",
+ "description": "ID of the created seller."
+ },
+ "createdAt": {
+ "type": "string",
+ "description": "Creation date of the seller."
+ },
+ "updatedAt": {
+ "type": "string",
+ "description": "Date of the last update of the seller."
+ }
+ }
+ },
+ "accountable": {
+ "type": "object",
+ "description": "Details of the person accountable for the seller's account. This includes their name, email address, and phone number.",
+ "required": [
+ "name",
+ "email",
+ "phone"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Name of the person responsible for the seller.",
+ "example": "Jane Smith"
+ },
+ "email": {
+ "type": "string",
+ "description": "Email address of the person responsible for the seller.",
+ "example": "email@email.com"
+ },
+ "phone": {
+ "type": "string",
+ "description": "Phone number of the person responsible for the seller.",
+ "example": "1234567890"
+ }
+ }
+ },
+ "address": {
+ "type": "object",
+ "description": "Details of the address associated with the seller. This includes postal code, complement, street, number, neighborhood, state, and city.",
+ "required": [
+ "postalcode",
+ "complement",
+ "street",
+ "number",
+ "neighborhood",
+ "state",
+ "city"
+ ],
+ "properties": {
+ "postalcode": {
+ "type": "string",
+ "description": "Postal code from the seller's address.",
+ "example": "12345678"
+ },
+ "complement": {
+ "type": "string",
+ "description": "Seller's address complement.",
+ "example": "Appartment 1234"
+ },
+ "street": {
+ "type": "string",
+ "description": "Street information, from the seller's address.",
+ "example": "Park Avenue"
+ },
+ "number": {
+ "type": "string",
+ "description": "Street's number, from the seller's address.",
+ "example": "25"
+ },
+ "neighborhood": {
+ "type": "string",
+ "description": "Seller's address neighborhood.",
+ "example": "Manhattan"
+ },
+ "state": {
+ "type": "string",
+ "description": "State, from the seller's address.",
+ "example": "RJ"
+ },
+ "city": {
+ "type": "string",
+ "description": "City name, from the seller's address.",
+ "example": "Rio de Janeiro"
+ }
+ }
+ },
+ "AcceptSellerLeadRequest": {
+ "description": "Request to accept a seller lead. This includes detailed information about the seller, such as their email, name, account name, trade policy, contact email, seller type, account ID, document details, acceptance of legal terms, address, and accountable party.",
+ "required": [
+ "sellerEmail",
+ "sellerName",
+ "sellerAccountName",
+ "salesChannel",
+ "email",
+ "sellerType",
+ "accountId",
+ "document",
+ "hasAcceptedLegalTerms",
+ "address",
+ "accountable"
+ ],
+ "type": "object",
+ "properties": {
+ "sellerEmail": {
+ "type": "string",
+ "description": "Seller's contact email.",
+ "example": "selleremail@email.com"
+ },
+ "sellerName": {
+ "type": "string",
+ "description": "Seller's store's name.",
+ "example": "Seller Name"
+ },
+ "sellerAccountName": {
+ "type": "string",
+ "description": "Name of the seller's account, part of the url of their VTEX Admin.",
+ "example": "seller123"
+ },
+ "salesChannel": {
+ "type": "string",
+ "description": "Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) associated to the seller account created.",
+ "example": "1"
+ },
+ "email": {
+ "type": "string",
+ "description": "email of the admin responsible for the seller.",
+ "example": "seller@email.com"
+ },
+ "sellerType": {
+ "type": "integer",
+ "description": "Type of seller, including: \n\n`1`: Regular seller \n\n`2`: White label seller.",
+ "example": 1
+ },
+ "accountId": {
+ "type": "string",
+ "description": "Marketplace's account ID.",
+ "example": "5fb38ace-d95e-45ad-970d-ee97cce9fbcd"
+ },
+ "document": {
+ "type": "string",
+ "description": "Company's legal document code.",
+ "example": "12345671000"
+ },
+ "hasAcceptedLegalTerms": {
+ "type": "boolean",
+ "description": "Indicates if the seller has accepted the platform's legal terms and conditions.",
+ "example": true
+ },
+ "address": {
+ "$ref": "#/components/schemas/address"
+ },
+ "accountable": {
+ "$ref": "#/components/schemas/accountable"
+ }
+ }
+ },
+ "ResendSellerLeadRequestRequest": {
+ "description": "Request to resend a seller lead. This includes the status of the lead that determines the action to be taken.",
+ "required": [
+ "status"
+ ],
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "Seller lead's status, which can be: `accepted`, `connected` or `invited`.",
+ "example": "accepted"
+ }
+ }
+ },
+ "UpsertSellerRequest": {
+ "title": "Configure Seller Account",
+ "description": "Request to configure or update a seller account. This includes all necessary details for setting up the seller's account, such as ID, name, status, fulfillment settings, payment options, tax information, contact details, commission configuration, policies, and authentication information.",
+ "required": [
+ "id",
+ "name",
+ "isActive",
+ "fulfillmentEndpoint",
+ "allowHybridPayments",
+ "taxCode",
+ "email",
+ "description",
+ "sellerCommissionConfiguration",
+ "isBetterScope",
+ "sellerType",
+ "availableSalesChannels",
+ "CSCIdentification",
+ "account",
+ "channel",
+ "salesChannel",
+ "isVtex",
+ "score",
+ "exchangeReturnPolicy",
+ "deliveryPolicy",
+ "securityPrivacyPolicy",
+ "fulfillmentSellerId",
+ "user",
+ "password",
+ "catalogSystemEndpoint",
+ "trustPolicy"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Seller ID assigned by the marketplace. We recommend filling it in with the seller's account name.",
+ "example": "seller123"
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the seller's store, configured in the seller's environment.",
+ "example": "Seller Name"
+ },
+ "isActive": {
+ "type": "boolean",
+ "description": "Whether the seller is active on the marketplace or not.",
+ "example": true
+ },
+ "fulfillmentEndpoint": {
+ "type": "string",
+ "description": "URL of the endpoint for fulfillment of seller's orders, which the marketplace will use to communicate with the seller. \n\nFor **external sellers**, please include the URL of the seller's endpoint. External sellers have different endpoint standards. The seller must inform this endpoint to the marketplace so that the marketplace can complete the configuration process. \n\nFor **VTEX Stores**, the field format will be as follows: `https://{SellerName}.vtexcommercestable.com.br/api/fulfillment?&sc={TradePolicyID}`. \n\nThe value `SellerName` corresponds to the store name if the seller is a VTEX store. \n\nThe value `TradePolicyID` corresponds to the [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV#master-data) created by the seller in their own VTEX environment. The seller must inform this ID to the marketplace so that the marketplace can complete the configuration process. \n\nThe value `AffiliateID` corresponds to the 3-digit affiliate identification code created by the seller. The seller must inform this ID to the marketplace so that the marketplace can complete the configuration process. \n\nTo configure the [Multilevel Omnichannel Inventory](https://developers.vtex.com/vtex-rest-api/docs/multilevel-omnichannel-inventory) feature, fill in this field with the checkout endpoint following this example: `https://{{sellerAccount}}.vtexcommercestable.com.br/api/checkout?affiliateid={{affiliateId}}&sc={{salesChannel}}`.",
+ "example": "http://{SellerName}.vtexcommercestable.com.br/api/fulfillment?&sc={TradePolicyID}"
+ },
+ "allowHybridPayments": {
+ "type": "boolean",
+ "description": "Indicates if customers can use gift cards from the seller to buy their products on the marketplace (`true`) or not (`false`). If true, it identifies purchases made with a gift card so that only the final price (with discounts applied) is paid to the seller.",
+ "example": false
+ },
+ "taxCode": {
+ "type": "string",
+ "description": "Identity number of the legal entity, which is linked to information in its base country.",
+ "example": "34444"
+ },
+ "email": {
+ "type": "string",
+ "description": "Email of the administrative user responsible for the seller.",
+ "example": "seller@email.com"
+ },
+ "description": {
+ "type": "string",
+ "description": "Description of the seller.",
+ "example": "Seller A, from the B industry."
+ },
+ "sellerCommissionConfiguration": {
+ "description": "Details of the seller's commission configuration, including the product commission percentage, freight commission percentage, and categories commission configuration.",
+ "type": "object",
+ "items": {
+ "$ref": "#/components/schemas/SellerCommissionConfiguration"
+ },
+ "example": {
+ "productCommissionPercentage": 3,
+ "freightCommissionPercentage": 4,
+ "categoriesCommissionConfiguration": []
+ }
+ },
+ "isBetterScope": {
+ "type": "boolean",
+ "description": "Flag used by the VTEX Checkout to simmulate shopping carts, products and shipping only in sellers with the boolean set as `true`, avoiding performance issues.",
+ "example": true
+ },
+ "sellerType": {
+ "type": "integer",
+ "description": "Type of seller, including: \n\n`1`: Regular seller \n\n`2`: White label seller.",
+ "example": 1
+ },
+ "availableSalesChannels": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AvailableSalesChannel"
+ },
+ "description": "Sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) available.",
+ "example": [
+ {
+ "isSelected": true,
+ "id": 1,
+ "name": "Principal store"
+ },
+ {
+ "isSelected": true,
+ "id": 2,
+ "name": "Third"
+ },
+ {
+ "isSelected": true,
+ "id": 3,
+ "name": "Marketplaces"
+ }
+ ]
+ },
+ "CSCIdentification": {
+ "type": "string",
+ "description": "SKU Seller Identification.",
+ "example": "cscidentification 123"
+ },
+ "account": {
+ "type": "string",
+ "description": "Seller's account name.",
+ "example": "partner01"
+ },
+ "channel": {
+ "type": "string",
+ "description": "Channel's name.",
+ "example": "channel name"
+ },
+ "salesChannel": {
+ "type": "string",
+ "description": "Sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) associated to the seller account created. If no value is specified, the system will automatically use the sales channel configured in the seller's [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) ID.",
+ "example": "1"
+ },
+ "isVtex": {
+ "type": "boolean",
+ "description": "Indicates whether the seller configured is a VTEX store or not.",
+ "example": true
+ },
+ "exchangeReturnPolicy": {
+ "type": "string",
+ "description": "Text describing the exchange and return policy previously agreed between the marketplace and the seller.",
+ "example": "Describe exchange and returns policy"
+ },
+ "deliveryPolicy": {
+ "type": "string",
+ "description": "Text describing the delivery policy previously agreed between the marketplace and the seller.",
+ "example": "Describe delivery policy"
+ },
+ "securityPrivacyPolicy": {
+ "type": "string",
+ "nullable": true,
+ "description": "Text describing the security policy previously agreed between the marketplace and the seller.",
+ "example": "Our marketplace ensures that all transactions are encrypted with SSL technology, and we adhere to strict privacy standards to protect both sellers and buyers. Personal data is only shared with authorized parties to facilitate order processing and delivery, and we do not sell or disclose personal information to third parties without consent."
+ },
+ "fulfillmentSellerId": {
+ "type": "string",
+ "description": "Identification code of the seller responsible for fulfilling the order. This is an optional field used when a seller sells SKUs from another seller. If the seller sells their own SKUs, it must be nulled.",
+ "nullable": true,
+ "example": "seller1"
+ },
+ "groups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Groups"
+ },
+ "description": "Array of groups attached to the seller. Groups are defined by keywords that group sellers into categories defined by the marketplace when adding a new seller through the [Configure Seller Account](https://developers.vtex.com/docs/api-reference/marketplace-apis?endpoint=post-/seller-register/pvt/sellers) endpoint. It is possible to filter sellers by group in the Seller Management page in your VTEX Admin. Learn more about groups through our [Seller Management](https://help.vtex.com/en/tutorial/seller-management--6eEiOISwxuAWJ8w6MtK7iv#groups) documentation.",
+ "example": [
+ {
+ "groups": [
+ {
+ "id": "8d845239bf1448dc8bc3ed3121837511",
+ "name": "long tail"
+ },
+ {
+ "id": "b9bcd348ab9c4cec8285ff9485c27a72",
+ "name": "franchise accounts"
+ }
+ ]
+ }
+ ]
+ },
+ "user": {
+ "type": "string",
+ "description": "Username, if you are using a hub to integrate with the external seller.",
+ "example": "integrationHubUserName",
+ "nullable": true
+ },
+ "password": {
+ "type": "string",
+ "description": "User password, if you are using a hub to integrate with the external seller.",
+ "example": "integrationHubPassword",
+ "nullable": true
+ },
+ "catalogSystemEndpoint": {
+ "type": "string",
+ "description": "URL of the endpoint of the seller's catalog. This field will only be displayed if the seller type is VTEX Store. The field format will be as follows: `https://{sellerName}.vtexcommercestable.com.br/api/catalog_system/`.",
+ "example": "https://apiexamples.vtexcommercestable.com.br/api/catalog_system/"
+ },
+ "trustPolicy": {
+ "type": "string",
+ "description": "Specifies the trust policy agreed between the marketplace and the seller, such as permissions related to data sharing.",
+ "example": "AllowEmailSharing"
+ },
+ "score": {
+ "type": "number",
+ "description": "Score attributed to this seller.",
+ "example": 0
+ }
+ }
+ },
+ "SellerCommissionConfiguration": {
+ "deprecated": true,
+ "description": "Configuration details for seller commissions. This includes the product commission percentage, freight commission percentage, and categories commission configuration.",
+ "required": [
+ "productCommissionPercentage",
+ "freightCommissionPercentage",
+ "categoriesCommissionConfiguration"
+ ],
+ "type": "object",
+ "properties": {
+ "productCommissionPercentage": {
+ "type": "number",
+ "description": "Percentage of the comission applied to the product in decimals.",
+ "example": 9.85
+ },
+ "freightCommissionPercentage": {
+ "type": "number",
+ "description": "Percentage of the comission applied to the freight in decimals.",
+ "example": 2.43
+ },
+ "categoriesCommissionConfiguration": {
+ "type": "array",
+ "description": "Array containing the commission configurations for different categories. Each item in the array specifies the category and the commission percentage applied to it.",
+ "items": {
+ "type": "object",
+ "description": "Object representing the commission configuration for a specific category. This includes the category identifier or name and the commission percentage applied to it.",
+ "properties": {
+ "category": {
+ "type": "string",
+ "description": "Category identifier or name.",
+ "example": "electronics"
+ },
+ "commission": {
+ "type": "number",
+ "description": "Percentage of the commission applied to the category in decimal format.",
+ "example": 0.15
+ }
+ },
+ "required": [
+ "category",
+ "commission"
+ ]
+ },
+ "default": []
+ }
+ },
+ "example": {
+ "productCommissionPercentage": 3,
+ "freightCommissionPercentage": 4,
+ "categoriesCommissionConfiguration": []
+ }
+ },
+ "AvailableSalesChannel": {
+ "description": "Details of a trade policy available for the product. This includes whether the sales channel is selected, its ID, and its name.",
+ "required": [
+ "isSelected",
+ "id",
+ "name"
+ ],
+ "type": "object",
+ "properties": {
+ "isSelected": {
+ "type": "boolean",
+ "description": "Defines if the sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) is selected or not.",
+ "example": true
+ },
+ "id": {
+ "type": "integer",
+ "description": "Trade policy ID.",
+ "example": 1
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the trade policy.",
+ "example": "Principal store"
+ }
+ }
+ },
+ "Groups": {
+ "title": "groups",
+ "description": "Array of groups attached to the seller. Groups are defined by key-words that group sellers into categories defined by the marketplace when adding a new seller through the [Configure Seller Account](https://developers.vtex.com/vtex-rest-api/reference/sellers#putupsertseller) endpoint. It is possible to filter sellers by group in the Seller Management page in your VTEX Admin. Know more about groups through our [Seller Management](https://help.vtex.com/en/tutorial/gerenciamento-de-sellers-beta--6eEiOISwxuAWJ8w6MtK7iv#groups) documentation.",
+ "required": [
+ "groups"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Group's unique identifier code.",
+ "example": "8d845239bf1448dc8bc3ed3121837511"
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the tag chosen to identify the group.",
+ "example": "Franchise accounts"
+ }
+ },
+ "example": {
+ "groups": [
+ {
+ "id": "8d845239bf1448dc8bc3ed3121837511",
+ "name": "long tail"
+ },
+ {
+ "id": "b9bcd348ab9c4cec8285ff9485c27a72",
+ "name": "franchise accounts"
+ }
+ ]
+ }
+ },
+ "Sku2": {
+ "description": "Details of the SKU (Stock Keeping Unit) associated with the product. This includes the SKU ID, EAN ID, reference ID, complete name, short name, active status, main image, and offers.",
+ "required": [
+ "SkuId",
+ "EanId",
+ "RefId",
+ "NameComplete",
+ "Name",
+ "IsActive",
+ "MainImage",
+ "Offers"
+ ],
+ "type": "object",
+ "properties": {
+ "SkuId": {
+ "type": "string",
+ "description": "SKU's unique identifier number."
+ },
+ "EanId": {
+ "type": "string",
+ "nullable": true,
+ "description": "EAN's unique identifier number."
+ },
+ "RefId": {
+ "type": "string",
+ "nullable": true,
+ "description": "SKU's Reference ID."
+ },
+ "NameComplete": {
+ "type": "string",
+ "description": "Complete name of the SKU."
+ },
+ "Name": {
+ "type": "string",
+ "description": "Summarized name of the SKU."
+ },
+ "IsActive": {
+ "type": "boolean",
+ "description": "Whether the SKU is active in the trade policy (true), or not (false).",
+ "default": true
+ },
+ "MainImage": {
+ "type": "object",
+ "description": "Main image's information.",
+ "items": {
+ "$ref": "#/components/schemas/MainImage"
+ }
+ },
+ "Offers": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Offer"
+ },
+ "description": "Array with offers."
+ }
+ }
+ },
+ "MainImage": {
+ "description": "Details of the main image associated with the product. This includes the image's ID, label, tag, path, and other attributes indicating its main and zoom size status, as well as additional text and last modification date.",
+ "required": [
+ "ImageId",
+ "ImageLabel",
+ "ImageTag",
+ "ImagePath",
+ "IsMain",
+ "IsZoomSize",
+ "ImageText",
+ "LastModified"
+ ],
+ "type": "object",
+ "properties": {
+ "ImageId": {
+ "type": "string",
+ "description": "Code identifying the image's file."
+ },
+ "ImageLabel": {
+ "type": "string",
+ "nullable": true,
+ "description": "Image's label."
+ },
+ "ImageTag": {
+ "type": "string",
+ "description": "HTML tag for the selected image."
+ },
+ "ImagePath": {
+ "type": "string",
+ "description": "Path for the image's file."
+ },
+ "IsMain": {
+ "type": "boolean",
+ "description": "Whether the image is the main one or not.",
+ "default": true
+ },
+ "IsZoomSize": {
+ "type": "boolean",
+ "description": "If zoom can be applied to the image.",
+ "default": true
+ },
+ "ImageText": {
+ "type": "string",
+ "description": "Alt text for the image."
+ },
+ "LastModified": {
+ "type": "string",
+ "description": "Date of the last change made to the image."
+ }
+ }
+ },
+ "Offer": {
+ "description": "Details of an offer provided by a seller. This includes the seller's identification, SKU, offers per sales channel, and available trade policies.",
+ "required": [
+ "SellerId",
+ "SellerSkuId",
+ "OffersPerSalesChannel",
+ "AvailableSalesChannels"
+ ],
+ "type": "object",
+ "properties": {
+ "SellerId": {
+ "type": "string",
+ "description": "ID of the seller in the marketplace. This ID must be created by the marketplace."
+ },
+ "SellerSkuId": {
+ "type": "string",
+ "description": "Unique identifier of the SKU in the seller. This is the ID that the marketplace will use for future references to this SKU, such as price and inventory notifications."
+ },
+ "OffersPerSalesChannel": {
+ "type": "array",
+ "description": "Each element in the array corresponds to an offer in a specific trade policy.",
+ "items": {
+ "$ref": "#/components/schemas/OffersPerSalesChannel"
+ }
+ },
+ "AvailableSalesChannels": {
+ "type": "string",
+ "nullable": true,
+ "description": "The sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID in which the SKU is available."
+ }
+ }
+ },
+ "OffersPerSalesChannel": {
+ "title": "OffersPerSalesChannel",
+ "description": "Details of offers available per trade policy. This includes pricing information and available quantity specific to each trade policy.",
+ "required": [
+ "SaleChannel",
+ "Price",
+ "ListPrice",
+ "PriceWithoutDiscount",
+ "AvailableQuantity"
+ ],
+ "type": "object",
+ "properties": {
+ "SaleChannel": {
+ "type": "integer",
+ "description": "Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) of the SKU."
+ },
+ "Price": {
+ "type": "integer",
+ "description": "SKU's price."
+ },
+ "ListPrice": {
+ "type": "integer",
+ "description": "SKU's suggested selling price."
+ },
+ "PriceWithoutDiscount": {
+ "type": "integer",
+ "description": "SKU's price without discount applied."
+ },
+ "AvailableQuantity": {
+ "type": "integer",
+ "description": "Available SKU stock quantity."
+ }
+ }
+ },
+ "responseGetMatchedOffersList": {
+ "type": "array",
+ "description": "Response with the list of offers available on the Marketplace.",
+ "items": {
+ "type": "object",
+ "description": "Array of SKUs in the offer.",
+ "properties": {
+ "LastModified": {
+ "type": "string",
+ "description": "Last date when the offer was modified."
+ },
+ "ProductId": {
+ "type": "string",
+ "description": "Unique identifier of the seller's product. This is the ID that the marketplace will use for all references to this product."
+ },
+ "CategoryId": {
+ "type": "integer",
+ "description": "Offer's Category ID that the product belongs to, configured in the Catalog. It should be the marketplace's category chosen for the offer to be matched with."
+ },
+ "BrandId": {
+ "type": "integer",
+ "description": "Offer's brand ID that the product belongs to, configured in the Catalog. It should be the marketplace's brand chosen for the offer to be matched with."
+ },
+ "ProductName": {
+ "type": "string",
+ "description": "Name of the offer's product."
+ },
+ "Skus": {
+ "type": "array",
+ "description": "A list of SKUs (Stock Keeping Units) associated with the product. Each SKU contains detailed information about specific variants of the product, such as color, size, and other specifications.",
+ "items": {
+ "$ref": "#/components/schemas/Sku2"
+ }
+ }
+ }
+ }
+ },
+ "responseGetMatchedOffersDataBySKU": {
+ "description": "Array of matched offers data by SKU.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "description": "Schema for individual offer data.",
+ "properties": {
+ "productId": {
+ "type": "string",
+ "description": "Unique identifier for the product."
+ },
+ "skuId": {
+ "type": "string",
+ "description": "Unique identifier for the product SKU."
+ },
+ "nameComplete": {
+ "type": "string",
+ "description": "Complete name of the product."
+ },
+ "mainImage": {
+ "type": "object",
+ "description": "Schema for the main product image.",
+ "required": [
+ "imagePath"
+ ],
+ "properties": {
+ "imagePath": {
+ "type": "string",
+ "description": "File path of the main product image."
+ }
+ }
+ },
+ "sellersOffers": {
+ "type": "array",
+ "description": "Array of offers from different sellers.",
+ "items": {
+ "type": "object",
+ "description": "Schema for individual seller offer data.",
+ "properties": {
+ "sellerId": {
+ "type": "string",
+ "description": "Unique identifier for the seller."
+ },
+ "sellerSkuId": {
+ "type": "string",
+ "description": "Unique identifier for the seller's SKU."
+ },
+ "salesChannelOffer": {
+ "type": "array",
+ "description": "Array of offers on different trade policies from the same seller.",
+ "items": {
+ "type": "object",
+ "description": "Schema for individual trade policy offer data.",
+ "properties": {
+ "salesChannelId": {
+ "type": "string",
+ "description": "Unique identifier for the trade policy."
+ },
+ "salesChannelName": {
+ "type": "string",
+ "description": "Name of the trade policy."
+ },
+ "price": {
+ "type": "number",
+ "description": "Offer price."
+ },
+ "listPrice": {
+ "type": "number",
+ "description": "List price of the product."
+ },
+ "priceWithoutDiscount": {
+ "type": "number",
+ "description": "Offer price without any discount."
+ },
+ "availableQuantity": {
+ "type": "integer",
+ "description": "Available quantity of the product."
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "responseGetMatchedOffersDataByProductId": {
+ "type": "array",
+ "description": "Array of matched offers data by product ID.",
+ "items": {
+ "type": "object",
+ "description": "Schema for individual offer data.",
+ "properties": {
+ "productId": {
+ "type": "string",
+ "description": "Unique identifier for the product."
+ },
+ "skuId": {
+ "type": "string",
+ "description": "Unique identifier for the product SKU."
+ },
+ "nameComplete": {
+ "type": "string",
+ "description": "Complete name of the product."
+ },
+ "mainImage": {
+ "type": "object",
+ "description": "Schema for the main product image.",
+ "required": [
+ "imagePath"
+ ],
+ "properties": {
+ "imagePath": {
+ "type": "string",
+ "description": "File path of the main product image."
+ }
+ }
+ },
+ "sellersOffers": {
+ "type": "array",
+ "description": "Array of offers from different sellers.",
+ "items": {
+ "type": "object",
+ "description": "Schema for individual seller offer data.",
+ "properties": {
+ "sellerId": {
+ "type": "string",
+ "description": "Unique identifier for the seller."
+ },
+ "sellerSkuId": {
+ "type": "string",
+ "description": "Unique identifier for the seller's SKU."
+ },
+ "salesChannelOffer": {
+ "type": "object",
+ "description": "Schema for the offer data on a specific sales channel (trade policy).",
+ "properties": {
+ "salesChannelId": {
+ "type": "string",
+ "description": "Unique identifier for the sales channel (trade policy)."
+ },
+ "salesChannelName": {
+ "type": "string",
+ "description": "Name of the trade policy."
+ },
+ "price": {
+ "type": "number",
+ "description": "Offer price."
+ },
+ "listPrice": {
+ "type": "number",
+ "description": "List price of the product."
+ },
+ "priceWithoutDiscount": {
+ "type": "number",
+ "description": "Offer price without any discount."
+ },
+ "availableQuantity": {
+ "type": "integer",
+ "description": "Available quantity of the product."
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "responseListAffiliates": {
+ "description": "Array containing all configured affiliates in the store.",
+ "type": "array",
+ "items": {
+ "description": "[Affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) information.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Three-letter identifier defined during the affiliate configuration creation. Vowels are not allowed.",
+ "type": "string"
+ },
+ "followUpEmail": {
+ "description": "Email address in which the user will receive notifications about the integration.",
+ "type": "string"
+ },
+ "useSellerPaymentMethod": {
+ "description": "Indicates if the store uses the payment split, seller payment method, (`true`) or not (`false`). Recommended for use only in VTEX-with-VTEX integrations because of compatibility of payment methods.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "Affiliate name.",
+ "type": "string"
+ },
+ "salesChannel": {
+ "description": "Number of the sales channel that will define the catalog assortment, prices, and the shipping strategy of items sent to the marketplace.",
+ "type": "string"
+ },
+ "searchURIEndpoint": {
+ "description": "URL of the application that will receive products, price, and inventory notifications, among others. The Search Endpoint should be filled with the value: `http://productnotification.vtexcommerce.com.br/api/notification/{NameOfMarketplace}/{SellerID}`. For [external marketplaces](https://help.vtex.com/en/tutorial/marketplace-strategies-at-vtex--tutorials_402#integrating-with-an-external-marketplace), fill in the value: `https://{endpointDoAfiliado}/api/notification/`. Learn more in our article [How to confugure the affiliate endpoint](https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update#how-to-configure-the-affiliate-endpoint).",
+ "type": "string",
+ "nullable": true
+ },
+ "searchURIEndpointVersion": {
+ "description": "Search URI endpoint version. The default option is the only one available.",
+ "type": "string",
+ "default": "1.x.x."
+ },
+ "searchURIEndpointAvailableVersions": {
+ "description": "Search URI endpoint available versions.",
+ "type": "array",
+ "items": {
+ "description": "Search URI endpoint available version. The default option is the only one available.",
+ "type": "string",
+ "default": "1.x.x."
+ }
+ },
+ "minimumValueAccumulated": {
+ "description": "Minimum value accumulated in the cart to checkout the order.",
+ "type": "integer",
+ "nullable": true
+ }
+ }
+ }
+ },
+ "responseGetAffiliates": {
+ "description": "Object containing detailed information about a specific affiliate.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Three-letter identifier defined during the affiliate configuration creation. Vowels are not allowed.",
+ "type": "string"
+ },
+ "followUpEmail": {
+ "description": "Email address in which the user will receive notifications about the integration.",
+ "type": "string"
+ },
+ "useSellerPaymentMethod": {
+ "description": "Indicates if the store uses the payment split, seller payment method, (`true`) or not (`false`). Recommended for use only in VTEX-with-VTEX integrations because of compatibility of payment methods.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "Affiliate name.",
+ "type": "string"
+ },
+ "salesChannel": {
+ "description": "Number of the sales channel that will define the catalog assortment, prices, and the shipping strategy of items sent to the marketplace.",
+ "type": "string"
+ },
+ "searchURIEndpoint": {
+ "description": "URL of the application that will receive products, price, and inventory notifications, among others. The Search Endpoint should be filled with the value: `http://productnotification.vtexcommerce.com.br/api/notification/{NameOfMarketplace}/{SellerID}`. For [external marketplaces](https://help.vtex.com/en/tutorial/marketplace-strategies-at-vtex--tutorials_402#integrating-with-an-external-marketplace), fill in the value: `https://{endpointDoAfiliado}/api/notification/`. Learn more in our article [How to confugure the affiliate endpoint](https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update#how-to-configure-the-affiliate-endpoint).",
+ "type": "string",
+ "nullable": true
+ },
+ "searchURIEndpointVersion": {
+ "description": "Search URI endpoint version. The default option is the only one available.",
+ "type": "string",
+ "default": "1.x.x."
+ },
+ "searchURIEndpointAvailableVersions": {
+ "description": "Search URI endpoint available versions.",
+ "type": "array",
+ "items": {
+ "description": "Search URI endpoint available version. The default option is the only one available.",
+ "type": "string",
+ "default": "1.x.x."
+ }
+ },
+ "minimumValueAccumulated": {
+ "description": "Minimum value accumulated in the cart to checkout the order.",
+ "type": "integer",
+ "nullable": true
+ }
+ }
+ },
+ "requestUpdateAffiliate": {
+ "description": "Object containing the data structure required to update an affiliate configuration.",
+ "type": "object",
+ "properties": {
+ "followUpEmail": {
+ "description": "Email address in which the user will receive notifications about the integration.",
+ "type": "string"
+ },
+ "useSellerPaymentMethod": {
+ "description": "Indicates if the store uses the payment split, seller payment method, (`true`) or not (`false`). Recommended for use only in VTEX-with-VTEX integrations because of compatibility of payment methods.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "Affiliate name.",
+ "type": "string"
+ },
+ "salesChannel": {
+ "description": "Number of the sales channel that will define the catalog assortment, prices, and the shipping strategy of items sent to the marketplace.",
+ "type": "string"
+ },
+ "searchURIEndpoint": {
+ "description": "URL of the application that will receive products, price, and inventory notifications, among others. The Search Endpoint should be filled with the value: `http://productnotification.vtexcommerce.com.br/api/notification/{NameOfMarketplace}/{SellerID}`. For [external marketplaces](https://help.vtex.com/en/tutorial/marketplace-strategies-at-vtex--tutorials_402#integrating-with-an-external-marketplace), fill in the value: `https://{endpointDoAfiliado}/api/notification/`. Learn more in our article [How to confugure the affiliate endpoint](https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update#how-to-configure-the-affiliate-endpoint).",
+ "type": "string",
+ "nullable": true
+ },
+ "searchURIEndpointVersion": {
+ "description": "Search URI endpoint version. The default option is the only one available.",
+ "type": "string",
+ "default": "1.x.x."
+ },
+ "searchURIEndpointAvailableVersions": {
+ "description": "Search URI endpoint available versions.",
+ "type": "array",
+ "items": {
+ "description": "Search URI endpoint available version. The default option is the only one available.",
+ "type": "string",
+ "default": "1.x.x."
+ }
+ },
+ "minimumValueAccumulated": {
+ "description": "Minimum value accumulated in the cart to checkout the order.",
+ "type": "integer",
+ "nullable": true
+ }
+ }
+ }
+ },
+ "parameters": {
+ "isBetterScope": {
+ "name": "isBetterScope",
+ "in": "query",
+ "description": "The flag `isBetterScope` is used by the VTEX Checkout to simulate shopping carts, products, and shipping only in sellers with the field set as `true`, avoiding performance issues. When used as a query param, `isBetterScope` filters sellers that have the flag set as `true` or `false`.",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ },
+ "isConnected": {
+ "name": "isConnected",
+ "in": "query",
+ "description": "Query param that enables results to be filter by whether the seller lead is already connected to the marketplace or not.",
+ "required": true,
+ "style": "form",
+ "explode": true,
+ "schema": {
+ "type": "string",
+ "default": ""
+ }
+ },
+ "search": {
+ "name": "search",
+ "in": "query",
+ "description": "Custom search field, that filters sellers invited by specific marketplace operator's email.",
+ "required": true,
+ "style": "form",
+ "explode": true,
+ "schema": {
+ "type": "string",
+ "default": "user email"
+ }
+ },
+ "status": {
+ "name": "status",
+ "in": "query",
+ "description": "Seller Lead's status. Includes `accepted`, `connected` or `invited`.",
+ "required": true,
+ "style": "form",
+ "explode": true,
+ "schema": {
+ "type": "string",
+ "default": "invited"
+ }
+ },
+ "orderBy": {
+ "name": "orderBy",
+ "in": "query",
+ "description": "Query param determining how data will be ordered in the response, ordering by name or ID in descending our ascending order. Includes the following values: \n\n`namesort` = desc/asc \n\n`idsort` = desc/asc",
+ "required": true,
+ "style": "form",
+ "explode": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ "limit": {
+ "name": "limit",
+ "in": "query",
+ "description": "This field determines the limit used to retrieve the list of sellers. The response includes objects until the value inputted here. ",
+ "required": true,
+ "style": "form",
+ "explode": true,
+ "schema": {
+ "type": "integer",
+ "default": 15
+ }
+ },
+ "offset": {
+ "name": "offset",
+ "in": "query",
+ "description": "This field determines the limit used to retrieve the list of sellers. The response includes objects starting `from` the value inputted here.",
+ "required": true,
+ "style": "form",
+ "explode": true,
+ "schema": {
+ "type": "integer",
+ "default": 0
+ }
+ },
+ "categoryId": {
+ "name": "categoryId",
+ "in": "path",
+ "description": "ID of the category in which the comission was applied",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "default": "6"
+ }
+ },
+ "sellerLeadId": {
+ "name": "sellerLeadId",
+ "in": "path",
+ "description": "ID of the Seller Lead invited to the marketplace.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "from": {
+ "name": "from",
+ "in": "query",
+ "description": "The start number of pagination, being `0` the default value.",
+ "required": false,
+ "schema": {
+ "type": "number",
+ "default": 0
+ }
+ },
+ "to": {
+ "name": "to",
+ "in": "query",
+ "description": "The end number of pagination, being `100` the default value.",
+ "required": false,
+ "schema": {
+ "type": "number",
+ "default": 100
+ }
+ },
+ "keyword": {
+ "name": "keyword",
+ "in": "query",
+ "description": "Search sellers by a keyword in `sellerId` or `sellerName`.",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "keyword"
+ }
+ },
+ "integration": {
+ "name": "integration",
+ "in": "query",
+ "description": "Filters sellers by the name of who made the integration, if VTEX or an external hub. The possible values for VTEX integrations are: `vtex-sellerportal`, `vtex-seller` and `vtex-franchise`.",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "vtex-seller"
+ }
+ },
+ "group": {
+ "name": "group ",
+ "in": "query",
+ "description": "Groups are defined by keywords that group sellers into categories defined by the marketplace.",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "Group"
+ }
+ },
+ "isActive": {
+ "name": "isActive",
+ "in": "query",
+ "description": "Enables to filter sellers that are active (`true`) or unactive (`false`) in the marketplace.",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ },
+ "sellerId": {
+ "name": "sellerId",
+ "in": "path",
+ "description": "A string that identifies the seller in the marketplace. This ID must be created by the marketplace and informed to the seller before the integration is built.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "seller123"
+ }
+ },
+ "skuId": {
+ "name": "skuId",
+ "in": "path",
+ "description": "A string that identifies the seller's SKU that suffered the change. This is the ID that the marketplace will use for all references to this SKU, such as price and inventory notifications.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "1234"
+ }
+ },
+ "sort": {
+ "name": "sort",
+ "in": "query",
+ "description": "Criteria used to sort the list of offers. For sorting values in ascending order, use `asc`, while for descending order, use `desc`. To fill in the field, insert the sorting criteria, followed by 'asc', or 'desc', separated by a comma. You can sort by the following criteria: \n\n- **price:** sorts offers by price. *Ascending* goes from lowest to highest price, while *Descending* goes from highest to lowest price. \n\n- **name:** sorts offers by *productName*, in alphabetical order. *Ascending* goes from *A* to *Z*, while *Descending* goes from *Z* to *A*. \n\n- **availability:** availability in the sales channel (sc). The default value is 1. \n\nEx. sort=availability,desc \n\nEx. sort=name,asc \n\nEx. price,desc",
+ "required": false,
+ "style": "form",
+ "explode": true,
+ "schema": {
+ "type": "string",
+ "example": "availability,desc"
+ }
+ },
+ "rows": {
+ "name": "rows",
+ "in": "query",
+ "description": "Number of rows included in the response. Each row corresponds to a single offer. The default amount of rows in the response is 1, and the maximum amount is 50. To have more than one offer listed in the response, please add the `rows` parameter with a number greater than 1.",
+ "required": false,
+ "style": "form",
+ "explode": true,
+ "schema": {
+ "type": "integer",
+ "example": 20
+ }
+ },
+ "start": {
+ "name": "start",
+ "in": "query",
+ "description": "Number corresponding to the row from which the offer list will begin, used for pagination. Filters the list of offers by retrieving the offers starting from the row defined. The default value is 0, if the param is not included in the call.",
+ "required": false,
+ "style": "form",
+ "explode": true,
+ "schema": {
+ "type": "integer",
+ "default": 0
+ }
+ },
+ "fq": {
+ "name": "fq",
+ "in": "query",
+ "description": "This filter query can be used to filter offers by the criteria described below. It should be filled in by following the format: `fq={{criteriaName}}:{{criteriaValue}}`. \n\n- **productId:** integer of the product ID \n\n- **productName:** string of the product's name \n\n- **skuId:** integer of the SKU ID \n\n- **eanId:** string of the EAN ID \n\n- **refId:** string of the Ref ID \n\n- **categoryId:** integer of the category ID \n\n- **brandId:** integer of the brand ID \n\n- **sellerId:** string of the seller ID \n\n- **sc:** integer of the sales channel's ID (trade policy in VTEX) \n\nEx: skuId:172 \n\nEx: categoryId:13 \n\nEx. productName:Product example-123",
+ "required": false,
+ "style": "form",
+ "explode": true,
+ "schema": {
+ "type": "string",
+ "example": "skuId:172"
+ }
+ },
+ "productId": {
+ "name": "productId",
+ "in": "path",
+ "description": "A string that identifies the seller's product. This is the ID that the marketplace will use for all references to this product, such as price and inventory notifications.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "123456"
+ }
+ },
+ "an": {
+ "name": "an",
+ "in": "query",
+ "description": "Marketplace's account name, the same one inputted on the endpoint's path.",
+ "required": true,
+ "style": "form",
+ "explode": true,
+ "schema": {
+ "type": "string",
+ "default": "apiexamples"
+ }
+ },
+ "sc": {
+ "name": "sc",
+ "in": "query",
+ "description": "Sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) associated to the seller account created.",
+ "required": false,
+ "style": "form",
+ "explode": true,
+ "schema": {
+ "type": "string",
+ "default": "1"
+ }
+ },
+ "sellerType": {
+ "name": "sellerType",
+ "in": "query",
+ "description": "Filters sellers by their type, which can be regular seller (`1`) or whitelabel seller (`2`).",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ },
+ "isVtex": {
+ "name": "isVtex",
+ "in": "query",
+ "description": "When set as `true`, the list returned will be of sellers who have a VTEX store configured. When set as `false`, the list will be of sellers who do not have a VTEX store configured.",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ }
+ },
+ "tags": [
+ {
+ "name": "Sellers"
+ },
+ {
+ "name": "Seller Invite"
+ },
+ {
+ "name": "Seller Commissions"
+ },
+ {
+ "name": "Affiliates"
+ },
+ {
+ "name": "Notification"
+ },
+ {
+ "name": "Matched Offers"
+ },
+ {
+ "name": "Sales Channel Mapping"
+ }
+ ]
+}
diff --git a/clients/manitou/output/masterdata-v1.json b/clients/manitou/output/masterdata-v1.json
new file mode 100644
index 0000000000..682ca83774
--- /dev/null
+++ b/clients/manitou/output/masterdata-v1.json
@@ -0,0 +1,2349 @@
+{
+ "openapi": "3.0.3",
+ "info": {
+ "title": "Master Data API - v1",
+ "description": "Master Data is a highly customizable VTEX database solution, which enables you to create applications. By default, Master Data is used to store and organize Customer data from your store. It features a powerful search engine, allowing you to store, search, expand, and customize data. Learn more about [Master Data v1](https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw).\r\n\r\n## Index\r\n\r\n### Data Entities\r\n\r\nObtain information about the structure of the data entities.\r\n\r\n- `GET` [List data entities](https://developers.vtex.com/docs/api-reference/masterdata-api#get-/api/dataentities)\r\n- `GET` [Get data entity structure](https://developers.vtex.com/docs/api-reference/masterdata-api#get-/api/dataentities/-acronym-)\r\n\r\n### Documents\r\n\r\nCreate, update and retrieve documents.\r\n\r\n- `POST` [Create new document](https://developers.vtex.com/docs/api-reference/masterdata-api#post-/api/dataentities/-acronym-/documents)\r\n- `PUT` [Create document with custom ID or Update entire document](https://developers.vtex.com/docs/api-reference/masterdata-api#put-/api/dataentities/-acronym-/documents/-id-)\r\n- `PATCH` [Create or update partial document](https://developers.vtex.com/docs/api-reference/masterdata-api#patch-/api/dataentities/-acronym-/documents)\r\n- `GET` [Get document](https://developers.vtex.com/docs/api-reference/masterdata-api#get-/api/dataentities/-acronym-/documents/-id-)\r\n- `PUT` [Update entire document](https://developers.vtex.com/docs/api-reference/masterdata-api#put-/api/dataentities/-acronym-/documents/-id-)\r\n- `PATCH` [Update partial document](https://developers.vtex.com/docs/api-reference/masterdata-api#patch-/api/dataentities/-acronym-/documents/-id-)\r\n- `DELETE` [Delete document](https://developers.vtex.com/docs/api-reference/masterdata-api#delete-/api/dataentities/-acronym-/documents/-id-)\r\n\r\n### Customer profiles\r\n\r\nModify customer profiles in the CL entity.\r\n\r\n- `POST` [Create new customer profile](https://developers.vtex.com/docs/api-reference/masterdata-api#post-/api/dataentities/CL/documents)\r\n- `PATCH` [Update customer profile](https://developers.vtex.com/docs/api-reference/masterdata-api#patch-/api/dataentities/CL/documents/-id-)\r\n- `DELETE` [Delete customer profile](https://developers.vtex.com/docs/api-reference/masterdata-api#delete-/api/dataentities/CL/documents/-id-)\r\n\r\n### Addresses\r\n\r\nModify customer addresses in the AD entity.\r\n\r\n- `POST` [Create new customer address](https://developers.vtex.com/docs/api-reference/masterdata-api#post-/api/dataentities/AD/documents)\r\n- `PATCH` [Update customer address](https://developers.vtex.com/docs/api-reference/masterdata-api#patch-/api/dataentities/AD/documents/-id-)\r\n- `DELETE` [Delete customer address](https://developers.vtex.com/docs/api-reference/masterdata-api#delete-/api/dataentities/AD/documents/-id-)\r\n\r\n### Versions\r\n\r\nMaster Data documents are versioned. This means that, for each change, a new version is generated. The versions endpoints allow you to query the versions and also apply the state of a document to the most current version.\r\n\r\n- `GET` [List versions](https://developers.vtex.com/docs/api-reference/masterdata-api#get-/api/dataentities/-acronym-/documents/-id-/versions)\r\n- `GET` [Get version](https://developers.vtex.com/docs/api-reference/masterdata-api#get-/api/dataentities/-acronym-/documents/-id-/versions/-versionId-)\r\n- `PUT` [Put version](https://developers.vtex.com/docs/api-reference/masterdata-api#put-/api/dataentities/-acronym-/documents/-id-/versions/-versionId-)\r\n\r\n### Scroll\r\n\r\nDeveloped for external integration scenarios. If your collection is over 10.000 documents or you need to query the entire VTEX Master Data database, use these endpoints.\r\n\r\n- `GET` [Scroll documents](https://developers.vtex.com/docs/api-reference/masterdata-api#get-/api/dataentities/-acronym-/scroll)\r\n\r\n### Search\r\n\r\nQuery a collection of documents.\r\n\r\n- `GET` [Search documents](https://developers.vtex.com/docs/api-reference/masterdata-api#get-/api/dataentities/-acronym-/search)\r\n\r\n### Attachments\r\n\r\nUpload and download files.\r\n\r\n- `GET` [Retrieve attachment](https://developers.vtex.com/docs/api-reference/masterdata-api#get-/api/dataentities/-acronym-/documents/-id-/-field-/attachments/-file-name-)\r\n- `POST` [Save attachment](https://developers.vtex.com/docs/api-reference/masterdata-api#post-/api/dataentities/-acronym-/documents/-id-/-field-/attachments)\r\n\r\n### Clusters\r\n\r\nCheck if a particular document is in one or more clusters.\r\n\r\n- `POST` [Validate Document by Clusters](https://developers.vtex.com/docs/api-reference/masterdata-api#post-/api/dataentities/-acronym-/documents/-id-/clusters)\r\n\r\n### Score\r\n\r\nRecord and remove points in `Score2` type fields. Learn more about [Data entity field types](https://help.vtex.com/en/tutorial/creating-data-entity--tutorials_1265#understanding-the-types). \r\n\r\n- `PUT` [Put scores](https://developers.vtex.com/docs/api-reference/masterdata-api#put-/api/dataentities/-acronym-/documents/-id-/score)\r\n- `PUT` [Put score by field](https://developers.vtex.com/docs/api-reference/masterdata-api#put-/api/dataentities/-acronym-/documents/-id-/score/-field-name-)\r\n- `DELETE` [Delete score by field](https://developers.vtex.com/docs/api-reference/masterdata-api#delete-/api/dataentities/-acronym-/documents/-id-/score/-field-name-)\r\n",
+ "contact": {},
+ "version": "1.0"
+ },
+ "servers": [
+ {
+ "url": "https://{accountName}.{environment}.com.br",
+ "description": "VTEX server URL.",
+ "variables": {
+ "accountName": {
+ "description": "Name of the VTEX account. Used as part of the URL.",
+ "default": "apiexamples"
+ },
+ "environment": {
+ "description": "Environment to use. Used as part of the URL.",
+ "enum": [
+ "vtexcommercestable"
+ ],
+ "default": "vtexcommercestable"
+ }
+ }
+ }
+ ],
+ "paths": {
+ "/api/dataentities": {
+ "get": {
+ "tags": [
+ "Data entities"
+ ],
+ "summary": "List data entities",
+ "description": "Retrieves the list of existing data entities in the store. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n| Dynamic Storage | Data entity | **List data entity** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Listdataentities",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Listdataentity"
+ }
+ },
+ "example": [
+ {
+ "acronym": "SP",
+ "name": "Sample",
+ "primaryKeyType": "GUID",
+ "allowGetAll": false
+ },
+ {
+ "acronym": "AD",
+ "name": "Endereço",
+ "primaryKeyType": "GUID",
+ "allowGetAll": false
+ },
+ {
+ "acronym": "CL",
+ "name": "Cliente",
+ "primaryKeyType": "GUID",
+ "allowGetAll": false
+ }
+ ]
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "Message": {
+ "type": "string",
+ "description": "Error message."
+ }
+ }
+ },
+ "example": {
+ "Message": "Unauthorized"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/dataentities/{acronym}": {
+ "get": {
+ "tags": [
+ "Data entities"
+ ],
+ "summary": "Get data entity structure",
+ "description": "Returns the data entity structure with its respective fields and data type. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n| Dynamic Storage | Data entity | **View data entity details** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Getdataentitystructure",
+ "parameters": [
+ {
+ "name": "acronym",
+ "in": "path",
+ "description": "Data entity acronym.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "SP"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Getdataentityfields"
+ },
+ "example": {
+ "acronym": "SP",
+ "name": "Sample",
+ "primaryKeyType": "GUID",
+ "allowGetAll": false,
+ "fields": [
+ {
+ "name": "updatedIn",
+ "type": "Date and Time",
+ "displayName": "Atualizado em",
+ "isNullable": true,
+ "isSearchable": false,
+ "isFilter": true,
+ "isInternal": true
+ },
+ {
+ "name": "updatedBy",
+ "type": "User Login",
+ "displayName": "Atualizado por",
+ "isNullable": true,
+ "isSearchable": false,
+ "isFilter": true,
+ "isInternal": true
+ },
+ {
+ "name": "Auto_Increment",
+ "type": "Auto Increment",
+ "displayName": "Auto increment",
+ "isNullable": true,
+ "isSearchable": false,
+ "isFilter": false,
+ "isInternal": false
+ },
+ {
+ "name": "Boolean",
+ "type": "Boolean",
+ "displayName": "Boolean",
+ "isNullable": true,
+ "isSearchable": false,
+ "isFilter": true,
+ "isInternal": false
+ },
+ {
+ "name": "createdIn",
+ "type": "Date and Time",
+ "displayName": "Criado em",
+ "isNullable": true,
+ "isSearchable": false,
+ "isFilter": true,
+ "isInternal": true
+ },
+ {
+ "name": "createdBy",
+ "type": "User Login",
+ "displayName": "Criado por",
+ "isNullable": true,
+ "isSearchable": false,
+ "isFilter": true,
+ "isInternal": true
+ },
+ {
+ "name": "Currency",
+ "type": "Currency",
+ "displayName": "Currency",
+ "isNullable": true,
+ "isSearchable": false,
+ "isFilter": true,
+ "isInternal": false
+ },
+ {
+ "name": "Date",
+ "type": "Date",
+ "displayName": "Date",
+ "isNullable": true,
+ "isSearchable": false,
+ "isFilter": true,
+ "isInternal": false
+ },
+ {
+ "name": "Date_Time",
+ "type": "Date and Time",
+ "displayName": "Date and Time",
+ "isNullable": true,
+ "isSearchable": false,
+ "isFilter": true,
+ "isInternal": false
+ },
+ {
+ "name": "Decimal",
+ "type": "Decimal",
+ "displayName": "Decimal",
+ "isNullable": true,
+ "isSearchable": false,
+ "isFilter": true,
+ "isInternal": false
+ },
+ {
+ "name": "Email",
+ "type": "Email",
+ "displayName": "Email",
+ "isNullable": true,
+ "isSearchable": true,
+ "isFilter": false,
+ "isInternal": false
+ },
+ {
+ "name": "dataEntityId",
+ "type": "Varchar 10",
+ "displayName": "Entidade de dados",
+ "isNullable": false,
+ "isSearchable": true,
+ "isFilter": false,
+ "isInternal": true
+ },
+ {
+ "name": "File",
+ "type": "File",
+ "displayName": "File",
+ "isNullable": true,
+ "isSearchable": false,
+ "isFilter": false,
+ "isInternal": false
+ },
+ {
+ "name": "auto_filter",
+ "type": "Text",
+ "displayName": "Filtro automático",
+ "isNullable": true,
+ "isSearchable": false,
+ "isFilter": false,
+ "isInternal": true
+ },
+ {
+ "name": "accountId",
+ "type": "Varchar 50",
+ "displayName": "ID da loja",
+ "isNullable": false,
+ "isSearchable": false,
+ "isFilter": false,
+ "isInternal": true
+ },
+ {
+ "name": "id",
+ "type": "Varchar 100",
+ "displayName": "Id do documento",
+ "isNullable": false,
+ "isSearchable": true,
+ "isFilter": false,
+ "isInternal": true
+ },
+ {
+ "name": "Integer",
+ "type": "Integer",
+ "displayName": "Integer",
+ "isNullable": true,
+ "isSearchable": false,
+ "isFilter": true,
+ "isInternal": false
+ },
+ {
+ "name": "Long",
+ "type": "Long",
+ "displayName": "Long",
+ "isNullable": true,
+ "isSearchable": false,
+ "isFilter": true,
+ "isInternal": false
+ },
+ {
+ "name": "accountName",
+ "type": "Varchar 100",
+ "displayName": "Nome da loja",
+ "isNullable": false,
+ "isSearchable": true,
+ "isFilter": false,
+ "isInternal": true
+ },
+ {
+ "name": "Percent",
+ "type": "Percent",
+ "displayName": "Percent",
+ "isNullable": true,
+ "isSearchable": false,
+ "isFilter": true,
+ "isInternal": false
+ },
+ {
+ "name": "Relationship",
+ "type": "Relationship",
+ "displayName": "Relationship",
+ "isNullable": true,
+ "isSearchable": true,
+ "isFilter": false,
+ "isInternal": false
+ },
+ {
+ "name": "Score2",
+ "type": "Score2",
+ "displayName": "Score2",
+ "isNullable": true,
+ "isSearchable": false,
+ "isFilter": true,
+ "isInternal": false
+ },
+ {
+ "name": "followers",
+ "type": "Text",
+ "displayName": "Seguidores",
+ "isNullable": true,
+ "isSearchable": true,
+ "isFilter": false,
+ "isInternal": true
+ },
+ {
+ "name": "tags",
+ "type": "Text",
+ "displayName": "Tags",
+ "isNullable": true,
+ "isSearchable": true,
+ "isFilter": false,
+ "isInternal": true
+ },
+ {
+ "name": "Text",
+ "type": "Text",
+ "displayName": "Text",
+ "isNullable": true,
+ "isSearchable": false,
+ "isFilter": false,
+ "isInternal": false
+ },
+ {
+ "name": "Time",
+ "type": "Time",
+ "displayName": "Time",
+ "isNullable": true,
+ "isSearchable": false,
+ "isFilter": false,
+ "isInternal": false
+ },
+ {
+ "name": "lastInteractionIn",
+ "type": "Date and Time",
+ "displayName": "Ultima interação em",
+ "isNullable": true,
+ "isSearchable": false,
+ "isFilter": true,
+ "isInternal": true
+ },
+ {
+ "name": "lastInteractionBy",
+ "type": "User Login",
+ "displayName": "Ultima interação por",
+ "isNullable": true,
+ "isSearchable": false,
+ "isFilter": true,
+ "isInternal": true
+ },
+ {
+ "name": "URL",
+ "type": "URL",
+ "displayName": "URL",
+ "isNullable": true,
+ "isSearchable": false,
+ "isFilter": true,
+ "isInternal": false
+ },
+ {
+ "name": "User_Login",
+ "type": "User Login",
+ "displayName": "User Login",
+ "isNullable": true,
+ "isSearchable": true,
+ "isFilter": false,
+ "isInternal": false
+ },
+ {
+ "name": "Varchar10",
+ "type": "Varchar 10",
+ "displayName": "Varchar 10",
+ "isNullable": true,
+ "isSearchable": true,
+ "isFilter": false,
+ "isInternal": false
+ },
+ {
+ "name": "Varchar100",
+ "type": "Varchar 100",
+ "displayName": "Varchar 100",
+ "isNullable": true,
+ "isSearchable": true,
+ "isFilter": false,
+ "isInternal": false
+ },
+ {
+ "name": "Varchar50",
+ "type": "Varchar 50",
+ "displayName": "Varchar 50",
+ "isNullable": true,
+ "isSearchable": true,
+ "isFilter": false,
+ "isInternal": false
+ },
+ {
+ "name": "Varchar750",
+ "type": "Varchar 750",
+ "displayName": "Varchar 750",
+ "isNullable": true,
+ "isSearchable": true,
+ "isFilter": false,
+ "isInternal": false
+ }
+ ]
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "Message": {
+ "type": "string",
+ "description": "Error message."
+ }
+ }
+ },
+ "example": {
+ "Message": "Unauthorized"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/dataentities/{acronym}/documents": {
+ "post": {
+ "tags": [
+ "Documents"
+ ],
+ "summary": "Create new document",
+ "description": "Creates a new document with an ID automatically generated by VTEX, corresponding to a given data entity. The request body is a JSON object where the key is the name of the field.\r\n\r\n>ℹ️ You can use this request to create documents in any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update.\r\n\r\n## Custom field types\r\n\r\nThe table below presents the types of custom fields you can use when creating or updating documents in Master Data v1 and example values.\r\n\r\n| Field Type| Example value |\r\n| - | - |\r\n| Boolean | `true` |\r\n| Currency | `2.5` |\r\n| Date | `1992-11-17` |\r\n| Date_Time | `2016-09-14T19:21:01.3163733Z` |\r\n| Decimal | `2.5` |\r\n| Email | `meu@email.com` |\r\n| Integer | `1000000` |\r\n| Long | `1000000000` |\r\n| Percent | `85.42` |\r\n| Time | `23:50` |\r\n| URL | `https://www.vtex.com` |\r\n| Varchar10 | `Lorem ipsu` |\r\n| Varchar50 | `Lorem ipsum dolor sit amet, consectetur adipiscing` |\r\n| Varchar750 | `Lorem ipsum dolor sit amet, consectetur adipiscing elit...` |\r\n| Varchar100 | `Lorem ipsum dolor sit amet, consectetur adipiscing elit...` |\r\n| Relationship | `5eb31afb-7ab0-11e6-94b4-0a44686e393f` |\r\n| Text | `Lorem ipsum dolor sit amet, consectetur adipiscing elit...` |\r\n \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "Createnewdocument",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/acronym"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "description": "Object with document fields and their respective values.",
+ "additionalProperties": true,
+ "properties": {
+ "{fieldName}": {
+ "type": "string",
+ "description": "Field name.",
+ "example": "{fieldValue}"
+ }
+ }
+ },
+ "example": {
+ "Boolean": true,
+ "Currency": 2.5,
+ "Date": "1992-11-17",
+ "Date_Time": "2016-09-14T19:21:01.3163733Z",
+ "Decimal": 2.5,
+ "Email": "meu@email.com",
+ "Integer": 1000000,
+ "Long": 1000000000,
+ "Percent": 85.42,
+ "Time": "23:50",
+ "URL": "http://www.vtex.com",
+ "Varchar10": "Lorem ipsu",
+ "Varchar50": "Lorem ipsum dolor sit amet, consectetur adipiscing",
+ "Varchar750": "Lorem ipsum dolor sit amet, consectetur adipiscing elit...",
+ "Varchar100": "Lorem ipsum dolor sit amet, consectetur adipiscing elit...",
+ "Relationship": "5eb31afb-7ab0-11e6-94b4-0a44686e393f",
+ "Text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit..."
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/IdHrefDocumentID"
+ },
+ "example": {
+ "id": "CL-be30ed0b-78ec-11ee-83ab-0eca8d1868e1",
+ "href": "http://apiexamples.vtexcommercestable.com.br/api/dataentities/CL/documents/be30ed0b-78ec-11ee-83ab-0eca8d1868e1",
+ "documentId": "be30ed0b-78ec-11ee-83ab-0eca8d1868e1"
+ }
+ }
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Documents"
+ ],
+ "summary": "Create partial document",
+ "description": "Creates a partial document, sending only some of the fields.\r\n\r\n> You can use this request to create documents in any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "Createorupdatepartialdocument",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/acronym"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": true,
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Unique identifier of the document to be created.",
+ "example": "4e4c55ac-e491-11e6-94f4-0ac138d2d42e"
+ },
+ "{fieldName}": {
+ "type": "string",
+ "description": "Field(s) to be filled in and its respective value(s).",
+ "example": "{fieldValue}"
+ }
+ }
+ },
+ "example": {
+ "id": "4e4c55ac-e491-11e6-94f4-0ac138d2d42e",
+ "addressName": "4726026151251"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/IdHrefDocumentID"
+ },
+ "example": {
+ "id": "CL-be30ed0b-78ec-11ee-83ab-0eca8d1868e1",
+ "href": "http://apiexamples.vtexcommercestable.com.br/api/dataentities/CL/documents/be30ed0b-78ec-11ee-83ab-0eca8d1868e1",
+ "documentId": "be30ed0b-78ec-11ee-83ab-0eca8d1868e1"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ }
+ }
+ }
+ },
+ "/api/dataentities/{acronym}/documents/{id}": {
+ "get": {
+ "tags": [
+ "Documents"
+ ],
+ "summary": "Get document",
+ "description": "Retrieves a document.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Getdocument",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/acronym"
+ },
+ {
+ "$ref": "#/components/parameters/id"
+ },
+ {
+ "$ref": "#/components/parameters/fields"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Document"
+ },
+ "example": {
+ "id": "2f5dde81-1613-11ea-82ee-12f868feb457",
+ "accountId": "a8b27fb4-6516-4cc0-82b6-a5f2b011e6e2",
+ "accountName": "apiexamples",
+ "dataEntityId": "AS"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "description": "Error response body.",
+ "type": "object",
+ "properties": {
+ "Message": {
+ "description": "Error message.",
+ "type": "string"
+ }
+ }
+ },
+ "example": {
+ "Message": "Cannot read private fields"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Documents"
+ ],
+ "summary": "Create document with custom ID or update entire document",
+ "description": "Creates a new document with a custom ID, or updates an entire document if there is already a document with the informed ID.\r\n\r\n>ℹ️ You can use this request to create or update documents in any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update.\r\n\r\n## Custom field types\r\n\r\nThe table below presents the types of custom fields you can use when creating or updating documents in Master Data v1 and example values.\r\n\r\n| Field Type| Example value |\r\n| - | - |\r\n| Boolean | `true` |\r\n| Currency | `2.5` |\r\n| Date | `1992-11-17` |\r\n| Date_Time | `2016-09-14T19:21:01.3163733Z` |\r\n| Decimal | `2.5` |\r\n| Email | `meu@email.com` |\r\n| Integer | `1000000` |\r\n| Long | `1000000000` |\r\n| Percent | `85.42` |\r\n| Time | `23:50` |\r\n| URL | `https://www.vtex.com` |\r\n| Varchar10 | `Lorem ipsu` |\r\n| Varchar50 | `Lorem ipsum dolor sit amet, consectetur adipiscing` |\r\n| Varchar750 | `Lorem ipsum dolor sit amet, consectetur adipiscing elit...` |\r\n| Varchar100 | `Lorem ipsum dolor sit amet, consectetur adipiscing elit...` |\r\n| Relationship | `5eb31afb-7ab0-11e6-94b4-0a44686e393f` |\r\n| Text | `Lorem ipsum dolor sit amet, consectetur adipiscing elit...` |\r\n \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "Updateentiredocument",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/acronym"
+ },
+ {
+ "$ref": "#/components/parameters/id"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "description": "Object with document fields and their respective values.",
+ "additionalProperties": true,
+ "properties": {
+ "{fieldName}": {
+ "type": "string",
+ "description": "Field name and value.",
+ "example": "{fieldValue}"
+ }
+ }
+ },
+ "example": {
+ "Boolean": true,
+ "Currency": 2.5,
+ "Date": "1992-11-17",
+ "Date_Time": "2016-09-14T19:21:01.3163733Z",
+ "Decimal": 2.5,
+ "Email": "meu@email.com",
+ "Integer": 1000000,
+ "Long": 1000000000,
+ "Percent": 85.42,
+ "Time": "23:50",
+ "URL": "http://www.vtex.com",
+ "Varchar10": "Lorem ipsu",
+ "Varchar50": "Lorem ipsum dolor sit amet, consectetur adipiscing",
+ "Varchar750": "Lorem ipsum dolor sit amet, consectetur adipiscing elit...",
+ "Varchar100": "Lorem ipsum dolor sit amet, consectetur adipiscing elit...",
+ "Relationship": "5eb31afb-7ab0-11e6-94b4-0a44686e393f",
+ "Text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit..."
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "204": {
+ "description": "No Content"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Documents"
+ ],
+ "summary": "Update partial document",
+ "description": "Updates a subset of fields of a document, without impacting the other fields.\r\n\r\n>ℹ️ You can use this request to update documents in any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "Updatepartialdocument",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/acronym"
+ },
+ {
+ "$ref": "#/components/parameters/id"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "description": "Object with the fields to be updated and their respective values."
+ },
+ "example": {
+ "addressName": "4726026151253"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "204": {
+ "description": "No Content"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Documents"
+ ],
+ "summary": "Delete document",
+ "description": "Deletes a document. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Deletedocument",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/acronym"
+ },
+ {
+ "$ref": "#/components/parameters/id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ }
+ }
+ }
+ },
+ "/api/dataentities/{acronym}/documents/{id}/versions": {
+ "get": {
+ "tags": [
+ "Versions"
+ ],
+ "summary": "List versions",
+ "description": "Lists all versions of a document. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Listversions",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/acronym"
+ },
+ {
+ "$ref": "#/components/parameters/id"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Listversion"
+ }
+ },
+ "example": [
+ {
+ "id": "_EAR0cJ7XB5k5grnmm0zeKGlVvVM9WCPV_",
+ "date": "2016-10-18T16:53:32+00:00"
+ },
+ {
+ "id": "_E5SH9WXVvhPBNnbQtYAAGqrIysIeNYhy_",
+ "date": "2016-09-08T20:11:42+00:00"
+ },
+ {
+ "id": "_cwVfOG7S6XeAiDBhNpLiJM1cwRiJcvdp_",
+ "date": "2016-07-14T00:36:36+00:00"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/dataentities/{acronym}/documents/{id}/versions/{versionId}": {
+ "get": {
+ "tags": [
+ "Versions"
+ ],
+ "summary": "Get version",
+ "description": "Returns the version of a document. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Getversion",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/acronym"
+ },
+ {
+ "$ref": "#/components/parameters/id"
+ },
+ {
+ "name": "versionId",
+ "in": "path",
+ "description": "Unique identifier of the version to retrieve.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "_X58kLameckHYRuBMUbaimlhwqslsrrwT_"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Getversion"
+ },
+ "example": {
+ "id": "version-id",
+ "author": "user-id",
+ "document": {
+ "id": "2f5dde81-1613-11ea-82ee-12f868feb457",
+ "accountId": "a8b27fb4-6516-4cc0-82b6-a5f2b011e6e2",
+ "accountName": "apiexamples",
+ "dataEntityId": "AS"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Versions"
+ ],
+ "summary": "Update version",
+ "description": "Updates the version of a document. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Putversion",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/acronym"
+ },
+ {
+ "$ref": "#/components/parameters/id"
+ },
+ {
+ "name": "versionId",
+ "in": "path",
+ "description": "Unique identifier of the version to update.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "_X58kLameckHYRuBMUbaimlhwqslsrrwT_"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/IdHref"
+ },
+ "example": {
+ "Id": "CL-b818cbda-e489-11e6-94f4-0ac138d2d42e",
+ "Href": "http://{{accountName}}.vtexcommercestable.com.br/api/dataentities/CL/documents/b818cbda-e489-11e6-94f4-0ac138d2d42e"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified\n\nThis response happens when the versionId informed in the path already corresponds to the current version of the document."
+ }
+ }
+ }
+ },
+ "/api/dataentities/{acronym}/scroll": {
+ "get": {
+ "tags": [
+ "Scroll"
+ ],
+ "summary": "Scroll documents",
+ "description": "Returns a list of documents according to query parameter filters. If you need to query the entire database, or your collection is over 10000 documents, use this endpoint.\r\n\r\nIn the first request, the `X-VTEX-MD-TOKEN` token will be obtained in the response header. This token must be passed to the next request in the `_token` query string parameter. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer.\r\n\r\nAfter the token is obtained, it is no longer necessary to send the filter or document size per page parameters. You only need to resend the token until the document collection is empty.\r\n\r\n### First request example:\r\n```\r\n/dataentities/CL/scroll?isCluster=true&_size=250&_fields=email,firstName\r\n```\r\n\r\nTo inform the number of documents per request, use the query string parameter `_size`, which has the maximum value of 1000.\r\n\r\nAfter the first request, retrieve the token in the header `X-VTEX-MD-TOKEN` and make the next requests.\r\n\r\n### Example of subsequent requests:\r\n```\r\n/dataentities/CL/scroll?_token={tokenValue}\r\n```\r\n\r\n>ℹ️ Learn more about [Pagination in the Master Data API](https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api).\r\n\r\n## Query examples\r\n\r\n\r\n| **Filter Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `/dataentities/CL/scroll?email=my@email.com` |\r\n| **Complex filter** | `/dataentities/CL/scroll?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `/dataentities/CL/scroll?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Numeric field range** | `/dataentities/CL/scroll?_where=age between 18 AND 25` |\r\n| **Partial filter** | `/dataentities/CL/scroll?firstName=*Maria*` |\r\n| **Null values** | `/dataentities/CL/scroll?_where=firstName is null` |\r\n| **Non-null values** | `/dataentities/CL/scroll?_where=firstName is not null` |\r\n| **Difference** | `/dataentities/CL/scroll?_where=firstName<>maria` |\r\n| **Greater than** | `/dataentities/CL/scroll?_where=number>5` |\r\n| **Less than** | `/dataentities/CL/scroll?_where=date<2001-01-01` |\r\n\r\n>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens, you will receive an error with status code `429`.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Scrolldocuments",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/acronym"
+ },
+ {
+ "$ref": "#/components/parameters/fields"
+ },
+ {
+ "name": "_where",
+ "in": "query",
+ "description": "Defines a condition the document must comply with. When referring to fields, you can use a nested field up to the first level (e.g. `wishlistProduct.productName`).",
+ "required": false,
+ "style": "form",
+ "schema": {
+ "type": "string",
+ "example": "firstName is not null"
+ }
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "description": "Defines sorting mode in two parts. The first part is the name of the field you want to sort by. It can be a nested field up to the first level (e.g. `wishlistProduct.productName`). In the second part, use `ASC` for ascending order or `DESC` for descending order.",
+ "required": false,
+ "style": "form",
+ "schema": {
+ "type": "string",
+ "example": "firstName ASC"
+ }
+ },
+ {
+ "name": "_size",
+ "in": "query",
+ "description": "Maximum amount of documents returned per request. The maximum value you can set is `1000`.",
+ "required": false,
+ "style": "form",
+ "schema": {
+ "type": "string",
+ "example": "10"
+ }
+ },
+ {
+ "name": "_token",
+ "in": "query",
+ "description": "Value of the `X-VTEX-MD-TOKEN` token obtained in the response header of the first request, necessary on subsequent requests to continue scrolling through documents. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer.",
+ "required": false,
+ "style": "form",
+ "schema": {
+ "type": "string",
+ "example": "123456"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "headers": {
+ "X-VTEX-MD-TOKEN": {
+ "schema": {
+ "type": "string",
+ "description": "Scroll token, which must be informed in the `_token` query parameter in the subsequent requests. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer."
+ }
+ },
+ "REST-Content-Total": {
+ "schema": {
+ "type": "string",
+ "description": "Total amount of documents corresponding to the query."
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "description": "List of documents.",
+ "items": {
+ "type": "object",
+ "description": "Object representing each document.",
+ "properties": {
+ "additionalProperties": {
+ "type": "string",
+ "description": "Custom properties."
+ },
+ "id": {
+ "type": "string",
+ "description": "Unique identifier of the document."
+ },
+ "accountId": {
+ "type": "string",
+ "description": "Unique identifier of the account."
+ },
+ "accountName": {
+ "type": "string",
+ "description": "Account name."
+ },
+ "dataEntityId": {
+ "type": "string",
+ "description": "Two-letter string that identifies the data entity."
+ }
+ }
+ }
+ },
+ "example": [
+ {
+ "id": "2f5dde81-1613-11ea-82ee-12f868feb457",
+ "accountId": "a8b27fb4-6516-4cc0-82b6-a5f2b011e6e2",
+ "accountName": "apiexamples",
+ "dataEntityId": "AS"
+ },
+ {
+ "id": "3b3a3fc9-164b-11ea-82ee-121449f60ecb",
+ "accountId": "a8b27fb4-6516-4cc0-82b6-a5f2b011e6e2",
+ "accountName": "apiexamples",
+ "dataEntityId": "AS"
+ }
+ ]
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "description": "Response body with error message.",
+ "properties": {
+ "Message": {
+ "description": "Error message."
+ }
+ }
+ },
+ "example": {
+ "Message": "Maximum simultaneous scrolls rate exceeded (10)"
+ }
+ }
+ }
+ },
+ "429": {
+ "description": "Too Many Requests\n\nWildcard queries temporarily blocked due to excessive usage. Consider adjusting your code to remove them or reduce the rate of search requests with wildcards (*). This temporary block may also be due to excessive use of requests with the parameter `keyword`."
+ }
+ }
+ }
+ },
+ "/api/dataentities/{acronym}/search": {
+ "get": {
+ "tags": [
+ "Search"
+ ],
+ "summary": "Search documents",
+ "description": "Retrieves Master Data v1 documents' information, while choosing which fields will be returned and filtering documents by specific fields.\r\n\r\n>ℹ️ Learn more about [Pagination in the Master Data API](https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api) and [Querying documents in Master Data v1](https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1).\r\n\r\n## Query examples\r\n\r\n\r\n| **Filter Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `/dataentities/CL/search?email=my@email.com` |\r\n| **Complex filter** | `/dataentities/CL/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `/dataentities/CL/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Numeric field range** | `/dataentities/CL/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `/dataentities/CL/search?firstName=*Maria*` |\r\n| **Null values** | `/dataentities/CL/search?_where=firstName is null` |\r\n| **Non-null values** | `/dataentities/CL/search?_where=firstName is not null` |\r\n| **Difference** | `/dataentities/CL/search?_where=firstName<>maria` |\r\n| **Greater than** | `/dataentities/CL/search?_where=number>5` |\r\n| **Less than** | `/dataentities/CL/search?_where=date<2001-01-01` |\n\r\n\r>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code `503`. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Searchdocuments",
+ "parameters": [
+ {
+ "name": "REST-Range",
+ "in": "header",
+ "description": "Specifies the range of documents to be returned in the response. The value should follow the format `resources={x}-{y}`, where:\n* `x`: Index of the first document in the returned array.\n* `y`: Index of the last document in the returned array + 1.\n\nThis field controls pagination by defining the subset of documents to be retrieved. The maximum number of documents returned per query is limited to 100.\nFor example, `resources=0-10` returns the first 10 documents.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "resources=0-10"
+ }
+ },
+ {
+ "$ref": "#/components/parameters/acronym"
+ },
+ {
+ "$ref": "#/components/parameters/fields"
+ },
+ {
+ "name": "_where",
+ "in": "query",
+ "description": "Defines a condition the document must comply with. When referring to fields, you can use a nested field up to the first level (e.g. `wishlistProduct.productName`).",
+ "required": false,
+ "style": "form",
+ "schema": {
+ "type": "string",
+ "example": "firstName is not null"
+ }
+ },
+ {
+ "name": "_sort",
+ "in": "query",
+ "description": "Defines sorting mode in two parts. The first part is the name of the field you want to sort by. It can be a nested field up to the first level (e.g. `wishlistProduct.productName`). In the second part, use `ASC` for ascending order or `DESC` for descending order.",
+ "required": false,
+ "style": "form",
+ "schema": {
+ "type": "string",
+ "example": "firstName ASC"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "headers": {
+ "REST-Content-Range": {
+ "schema": {
+ "type": "string",
+ "description": "Indicates the range of documents returned in the current response, as well as the total number of documents available in the dataset. The value follows the format `resources={x}-{y}/{total}`, where:\n* `x`: Index of the first document in the returned array.\n* `y`: Index of the last document in the returned array + 1.\n* `total`: Total number of documents that match the query.\nFor example, `resources=0-10/98` indicates that documents from 0 to 9 are returned out of a total of 98 matching documents.",
+ "example": "resources=0-10/98"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "description": "List of documents.",
+ "items": {
+ "type": "object",
+ "description": "Object representing each document.",
+ "properties": {
+ "additionalProperties": {
+ "type": "string",
+ "description": "Custom properties."
+ },
+ "id": {
+ "type": "string",
+ "description": "Unique identifier of the document."
+ },
+ "accountId": {
+ "type": "string",
+ "description": "Unique identifier of the account."
+ },
+ "accountName": {
+ "type": "string",
+ "description": "Account name."
+ },
+ "dataEntityId": {
+ "type": "string",
+ "description": "Two-letter string that identifies the data entity."
+ }
+ }
+ }
+ },
+ "example": [
+ {
+ "id": "2f5dde81-1613-11ea-82ee-12f868feb457",
+ "accountId": "a8b27fb4-6516-4cc0-82b6-a5f2b011e6e2",
+ "accountName": "apiexamples",
+ "dataEntityId": "AS"
+ },
+ {
+ "id": "3b3a3fc9-164b-11ea-82ee-121449f60ecb",
+ "accountId": "a8b27fb4-6516-4cc0-82b6-a5f2b011e6e2",
+ "accountName": "apiexamples",
+ "dataEntityId": "AS"
+ }
+ ]
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\n\nWildcard queries temporarily blocked due to excessive usage. Consider adjusting your code to remove them or reduce the rate of search requests with wildcards (*). This temporary block may also be due to excessive use of requests with the parameter `keyword`."
+ }
+ }
+ }
+ },
+ "/api/dataentities/{acronym}/documents/{id}/{field}/attachments/{file-name}": {
+ "get": {
+ "tags": [
+ "Attachments"
+ ],
+ "summary": "Retrieve attachment",
+ "description": "Retrieves a file that had been previously saved in a field of type `File`.\r\n\r\n>⚠️ Make sure to include the file extension in the name, like in this example: `/api/dataentities/CL/documents/123/file/attachments/image.png`. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Retrieveattachment",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/acronym"
+ },
+ {
+ "$ref": "#/components/parameters/id"
+ },
+ {
+ "name": "field",
+ "in": "path",
+ "description": "Name of the field where the file is saved, as it appears on VTEX Admin.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "image"
+ }
+ },
+ {
+ "name": "file-name",
+ "in": "path",
+ "description": "File name and extension.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "image.png"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "image/jpg": {
+ "schema": {
+ "type": "string",
+ "format": "binary",
+ "description": "Image file."
+ },
+ "example": "binary image data"
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/dataentities/{acronym}/documents/{id}/{field}/attachments": {
+ "post": {
+ "tags": [
+ "Attachments"
+ ],
+ "summary": "Save attachment",
+ "description": "Saves a file in a field of type `File`. Learn more about [Data entity field types](https://help.vtex.com/en/tutorial/creating-data-entity--tutorials_1265#understanding-the-types).`\n\r\n\r> You can upload more than one file. Just add a new field in the `form-data` with type `File`. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "Saveattachment",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/acronym"
+ },
+ {
+ "$ref": "#/components/parameters/id"
+ },
+ {
+ "name": "field",
+ "in": "path",
+ "description": "Name of the field to attach the file to, as it appears in VTEX Admin.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "profilePicture"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "multipart/form-data": {
+ "encoding": {},
+ "schema": {
+ "required": [
+ "file"
+ ],
+ "type": "object",
+ "properties": {
+ "file": {
+ "type": "array",
+ "description": "Files to be uploaded.",
+ "items": {
+ "type": "string",
+ "format": "binary",
+ "description": "File to be uploaded."
+ }
+ }
+ }
+ },
+ "example": {
+ "file": [
+ "image.jpg"
+ ]
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "204": {
+ "description": "No Content"
+ }
+ }
+ }
+ },
+ "/api/dataentities/{acronym}/documents/{id}/clusters": {
+ "post": {
+ "tags": [
+ "Clusters"
+ ],
+ "summary": "Validate document by clusters",
+ "description": "Validate documents by clusters.\n\r\n\r> Learn more about Master Data [clusters](https://help.vtex.com/en/tutorial/how-can-i-create-cluster-of-customers--frequentlyAskedQuestions_1724). \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "ValidateDocumentbyClusters",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/acronym"
+ },
+ {
+ "$ref": "#/components/parameters/id"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "description": "Array of clusters.",
+ "items": {
+ "type": "object",
+ "description": "Cluster information.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Cluster validation rule name.",
+ "example": "male"
+ },
+ "rule": {
+ "type": "string",
+ "description": "Cluster validation rule.",
+ "example": "gender=male"
+ }
+ }
+ }
+ },
+ "example": [
+ {
+ "name": "male",
+ "rule": "gender=male"
+ },
+ {
+ "name": "complex",
+ "rule": "((gender=male AND percent=0.35) AND any is null) AND (name=*go*)"
+ },
+ {
+ "name": "complex2",
+ "rule": "((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)"
+ },
+ {
+ "name": "createdIn",
+ "rule": "createdIn between 2015-10-28 AND 2015-10-30"
+ }
+ ]
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK"
+ }
+ }
+ }
+ },
+ "/api/dataentities/{acronym}/documents/{id}/score": {
+ "put": {
+ "tags": [
+ "Score"
+ ],
+ "summary": "Update scores",
+ "description": "Updates the score of more than one `Score2` type field and more than one key. Learn more about [Data entity field types](https://help.vtex.com/en/tutorial/creating-data-entity--tutorials_1265#understanding-the-types). \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "Putscores",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/acronym"
+ },
+ {
+ "$ref": "#/components/parameters/id"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PutscoresRequest"
+ }
+ },
+ "example": [
+ {
+ "field": "carttag",
+ "key": "Payment",
+ "point": 1,
+ "until": "10m"
+ },
+ {
+ "field": "scoretest",
+ "key": "Point 1",
+ "point": 1,
+ "until": "1d"
+ }
+ ]
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "204": {
+ "description": "No Content"
+ }
+ }
+ }
+ },
+ "/api/dataentities/{acronym}/documents/{id}/score/{field-name}": {
+ "put": {
+ "tags": [
+ "Score"
+ ],
+ "summary": "Update score by field",
+ "description": "Updates the score of a specific `Score2` type field. Learn more about [Data entity field types](https://help.vtex.com/en/tutorial/creating-data-entity--tutorials_1265#understanding-the-types). \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "Putscorebyfield",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/acronym"
+ },
+ {
+ "name": "id",
+ "in": "path",
+ "description": "Unique identifier of the document.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "SP-b818cbda-e489-11e6-94f4-0ac138d2d42e"
+ }
+ },
+ {
+ "name": "field-name",
+ "in": "path",
+ "description": "Name of the field to score.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "carttag"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PutscorebyfieldRequest"
+ },
+ "example": {
+ "key": "first key",
+ "point": 1,
+ "until": "10m"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "204": {
+ "description": "No Content"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Score"
+ ],
+ "summary": "Delete score by field",
+ "description": "Removes a key from a specific `Score2` type field. Learn more about [Data entity field types](https://help.vtex.com/en/tutorial/creating-data-entity--tutorials_1265#understanding-the-types). \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Deletescorebyfield",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/acronym"
+ },
+ {
+ "$ref": "#/components/parameters/id"
+ },
+ {
+ "name": "field-name",
+ "in": "path",
+ "description": "Name of the field to remove a key from.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "carttag"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DeletescorebyfieldRequest"
+ },
+ "example": {
+ "key": "first key"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "204": {
+ "description": "No Content"
+ }
+ }
+ }
+ },
+ "/api/dataentities/AD/documents/{addressId}": {
+ "get": {
+ "tags": [
+ "Addresses"
+ ],
+ "summary": "Get address by ID",
+ "description": "This endpoint retrieves information of a specific address by its unique identifier.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "parameters": [
+ {
+ "name": "addressId",
+ "in": "path",
+ "description": "ID of the address to retrieve.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "example": "4286e252-050b-11f0-b37f-d6617047d485"
+ },
+ {
+ "name": "_fields",
+ "in": "query",
+ "description": "Specifies that all fields of the document should be included in the response.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "default": "_all"
+ },
+ "example": "_all"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AddressResponse"
+ },
+ "example": {
+ "addressLabel": "NC Office",
+ "addressType": "commercial",
+ "city": "Raleigh",
+ "complement": "",
+ "country": "USA",
+ "countryfake": null,
+ "geoCoordinate": "",
+ "neighborhood": "",
+ "number": "11",
+ "postalCode": "48226",
+ "receiverName": "Backpack-Klub-LLC",
+ "reference": null,
+ "state": "NC",
+ "street": "Toringon Street",
+ "userId": "2da4e9ab-050b-11f0-b37f-f4b136dbcce1",
+ "id": "4286e252-050b-11f0-b37f-d6617047d485",
+ "accountId": "5f1fe23b-9fd1-417d-a4aa-14df38e7746e",
+ "accountName": "qastore",
+ "dataEntityId": "AD",
+ "createdBy": "c83ea7ed-f875-4a10-b0a0-98d96aedab06",
+ "createdIn": "2025-03-19T21:44:01.4199691Z",
+ "updatedBy": null,
+ "updatedIn": null,
+ "lastInteractionBy": "c83ea7ed-f875-4a10-b0a0-98d96aedab06",
+ "lastInteractionIn": "2025-03-19T21:44:01.4199691Z",
+ "followers": [],
+ "tags": [],
+ "auto_filter": null
+ }
+ }
+ }
+ }
+ },
+ "operationId": "get_api_dataentities_ad_documents_ByAddressId"
+ },
+ "patch": {
+ "tags": [
+ "Addresses"
+ ],
+ "summary": "Update address by ID",
+ "description": "This endpoint allows you to update an existing address document in the `AD` data entity. Partially updates a customer address.\n\n> ⚠️ When updating addresses you must send each field according to the specifications provided. Otherwise, the Checkout module will not be able to autofill data during the shopping flow, which can block the purchase. Learn more about [SmartCheckout - Customer information automatic fill-in](https://help.vtex.com/en/tutorial/smartcheckout-preenchimento-automatico-de-dados-do-cliente--2Nuu3xAFzdhIzJIldAdtan#).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "UpdateCustomerAddress",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/_schema"
+ },
+ {
+ "name": "addressId",
+ "in": "path",
+ "description": "ID of the address to update.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "example": "4286e252-050b-11f0-b37f-d6617047d485"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/createUpdateAddressRequests"
+ },
+ "example": {
+ "addressName": "NC Office",
+ "addressLabel": "NC Office",
+ "postalCode": "48226",
+ "street": "Toringon Street",
+ "number": "11",
+ "neighborhood": "",
+ "complement": "",
+ "city": "Raleigh",
+ "state": "NC",
+ "country": "USA",
+ "receiverName": "Backpack-Klub-LLC",
+ "geoCoordinate": "",
+ "addressType": "commercial",
+ "reference": "Grey building",
+ "userId": "2da4e9ab-050b-11f0-b37f-d6617047d485"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/documentResponse"
+ },
+ "example": {
+ "Id": "AD-b818cbda-e489-11e6-94f4-0ac138d2d42e",
+ "Href": "http://api.vtex.com/my-store-name/dataentities/AD/documents/b818cbda-e489-11e6-94f4-0ac138d2d42e"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Addresses"
+ ],
+ "summary": "Delete address by ID",
+ "description": "This endpoint allows you to delete a specific address document from the `AD` data entity. Deletes a customer address.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "DeleteCustomerAD",
+ "parameters": [
+ {
+ "name": "addressId",
+ "in": "path",
+ "description": "ID of the address to be deleted.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "example": "4286e252-050b-11f0-b37f-d6617047d485"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "appKey": [],
+ "appToken": []
+ },
+ {
+ "VtexIdclientAutCookie": []
+ }
+ ],
+ "components": {
+ "parameters": {
+ "acronym": {
+ "name": "acronym",
+ "in": "path",
+ "description": "Two-letter string that identifies the data entity.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "SP"
+ }
+ },
+ "id": {
+ "name": "id",
+ "in": "path",
+ "description": "Unique identifier of the document.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "SP-b818cbda-e489-11e6-94f4-0ac138d2d42e"
+ }
+ },
+ "fields": {
+ "name": "_fields",
+ "in": "query",
+ "description": "Names of the fields that will be returned per document, separated by a comma `,`. It is possible to fetch all fields using `_all` as the value of this query parameter. However, in order to avoid permission errors, we strongly recommend informing only the names of the exact fields that will be used.",
+ "required": false,
+ "style": "form",
+ "schema": {
+ "type": "string",
+ "example": "email,firstName,document"
+ }
+ },
+ "_schema": {
+ "name": "_schema",
+ "in": "query",
+ "description": "Name of the [schema](https://developers.vtex.com/docs/guides/master-data-schema-lifecycle) that the document complies with. This field is required when using `_where` or `_fields` query parameters.",
+ "required": false,
+ "style": "form",
+ "schema": {
+ "type": "string",
+ "example": "schema"
+ }
+ }
+ },
+ "schemas": {
+ "Listdataentity": {
+ "title": "Listdataentity",
+ "required": [
+ "acronym",
+ "name",
+ "primaryKeyType",
+ "allowGetAll"
+ ],
+ "type": "object",
+ "description": "Data entity information.",
+ "properties": {
+ "acronym": {
+ "title": "acronym",
+ "type": "string",
+ "description": "Two-letter string that identifies the data entity."
+ },
+ "name": {
+ "title": "name",
+ "type": "string",
+ "description": "Data entity name."
+ },
+ "primaryKeyType": {
+ "title": "primaryKeyType",
+ "type": "string",
+ "description": "Primary key type."
+ },
+ "allowGetAll": {
+ "title": "allowGetAll",
+ "type": "boolean",
+ "description": "Defines if it will be allowed to retrieve all fields from documents from this data entity at once using the [Get document](https://developers.vtex.com/docs/api-reference/masterdata-api#get-/api/dataentities/-acronym-/documents/-id-) endpoint (`true`) or not (`false`)."
+ }
+ }
+ },
+ "Getdataentityfields": {
+ "title": "Data entity structure",
+ "required": [
+ "acronym",
+ "name",
+ "primaryKeyType",
+ "allowGetAll",
+ "fields"
+ ],
+ "type": "object",
+ "description": "Data entity structure.",
+ "properties": {
+ "acronym": {
+ "$ref": "#/components/schemas/Listdataentity/properties/acronym"
+ },
+ "name": {
+ "$ref": "#/components/schemas/Listdataentity/properties/name"
+ },
+ "primaryKeyType": {
+ "$ref": "#/components/schemas/Listdataentity/properties/primaryKeyType"
+ },
+ "allowGetAll": {
+ "$ref": "#/components/schemas/Listdataentity/properties/allowGetAll"
+ },
+ "fields": {
+ "title": "fields",
+ "type": "array",
+ "description": "List of fields that documents from the given data entity have.",
+ "items": {
+ "$ref": "#/components/schemas/Field"
+ }
+ }
+ }
+ },
+ "Field": {
+ "title": "Field",
+ "description": "Field information.",
+ "required": [
+ "name",
+ "type",
+ "displayName",
+ "isNullable",
+ "isSearchable",
+ "isFilter",
+ "isInternal"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Field name."
+ },
+ "type": {
+ "type": "string",
+ "description": "Field type."
+ },
+ "displayName": {
+ "type": "string",
+ "description": "Field display name."
+ },
+ "isNullable": {
+ "type": "boolean",
+ "description": "Defines whether the field is nullable (`true`) or not (`false`)."
+ },
+ "isSearchable": {
+ "type": "boolean",
+ "description": "Defines whether the field is searchable (`true`) or not (`false`)."
+ },
+ "isFilter": {
+ "type": "boolean",
+ "description": "Defines whether the field is a filter (`true`) or not (`false`)."
+ },
+ "isInternal": {
+ "type": "boolean",
+ "description": "Defines whether the field is for internal use only (`true`) or not (`false`)."
+ }
+ }
+ },
+ "IdHrefDocumentID": {
+ "type": "object",
+ "description": "Document information.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "ID of the document that was created, with data entity prefix."
+ },
+ "href": {
+ "type": "string",
+ "description": "Document reference URL."
+ },
+ "documentId": {
+ "type": "string",
+ "description": "Unique identifier of the document."
+ }
+ }
+ },
+ "IdHref": {
+ "title": "IdHref",
+ "required": [
+ "Id",
+ "Href"
+ ],
+ "type": "object",
+ "description": "Document information.",
+ "properties": {
+ "Id": {
+ "type": "string",
+ "description": "ID of the document that was created, with data entity prefix."
+ },
+ "Href": {
+ "type": "string",
+ "description": "Document reference URL."
+ }
+ }
+ },
+ "PutscoresRequest": {
+ "title": "PutscoresRequest",
+ "required": [
+ "field",
+ "key",
+ "point",
+ "until"
+ ],
+ "type": "object",
+ "description": "Score information.",
+ "properties": {
+ "field": {
+ "type": "string",
+ "description": "Field name.",
+ "example": "carttag"
+ },
+ "key": {
+ "type": "string",
+ "description": "Key name.",
+ "example": "Payment"
+ },
+ "point": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Amount of points to be added to the score.",
+ "example": 1
+ },
+ "until": {
+ "type": "string",
+ "description": "Amount of time the added points will be valid for.",
+ "example": "10m"
+ }
+ }
+ },
+ "PutscorebyfieldRequest": {
+ "title": "PutscorebyfieldRequest",
+ "required": [
+ "key",
+ "point",
+ "until"
+ ],
+ "type": "object",
+ "description": "Request body object to update score.",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Key name.",
+ "example": "Payment"
+ },
+ "point": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Amount of points to be added to the score.",
+ "example": 1
+ },
+ "until": {
+ "type": "string",
+ "description": "Amount of time the added points will be valid for.",
+ "example": "10m"
+ }
+ }
+ },
+ "DeletescorebyfieldRequest": {
+ "title": "DeletescorebyfieldRequest",
+ "required": [
+ "key"
+ ],
+ "type": "object",
+ "description": "Request body object to delete score.",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Key name.",
+ "example": "Payment"
+ }
+ }
+ },
+ "Listversion": {
+ "title": "Listversion",
+ "required": [
+ "id",
+ "date"
+ ],
+ "type": "object",
+ "description": "Version information.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Unique identifier of the version."
+ },
+ "date": {
+ "type": "string",
+ "description": "Date when the version was created, in ISO 8601 format."
+ }
+ }
+ },
+ "Getversion": {
+ "title": "Getversion",
+ "required": [
+ "id",
+ "author",
+ "document"
+ ],
+ "type": "object",
+ "description": "Version information.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Unique identifier of the version."
+ },
+ "author": {
+ "type": "string",
+ "description": "Unique identifier of the user who created the version."
+ },
+ "document": {
+ "$ref": "#/components/schemas/Document"
+ }
+ }
+ },
+ "Document": {
+ "title": "Document",
+ "required": [
+ "id",
+ "dataEntityId",
+ "accountId",
+ "accountName"
+ ],
+ "type": "object",
+ "description": "Object representing each document.",
+ "properties": {
+ "{customProperty}": {
+ "type": "string",
+ "description": "Custom property."
+ },
+ "id": {
+ "type": "string",
+ "description": "Unique identifier of the document."
+ },
+ "accountId": {
+ "type": "string",
+ "description": "Unique identifier of the account."
+ },
+ "accountName": {
+ "type": "string",
+ "description": "Account name."
+ },
+ "dataEntityId": {
+ "type": "string",
+ "description": "Two-letter string that identifies the data entity."
+ }
+ }
+ },
+ "createUpdateAddressRequests": {
+ "type": "object",
+ "description": "Request body object.",
+ "properties": {
+ "addressName": {
+ "type": "string",
+ "description": "Address name.",
+ "example": "My house",
+ "nullable": true
+ },
+ "addressLabel": {
+ "type": "string",
+ "description": "Custom label for the address used by shoppers and buyer org managers.",
+ "example": "NC Office",
+ "nullable": true
+ },
+ "addressType": {
+ "type": "string",
+ "description": "Type of address. For example, `Residential` or `Pickup`, among others. For B2B Buyer Portal, this field is required and its possible values are `commercial` for shipping or `invoice` for billing.",
+ "enum": [
+ "commercial",
+ "invoice"
+ ],
+ "example": "commercial",
+ "nullable": true
+ },
+ "receiverName": {
+ "type": "string",
+ "description": "Name of the person who is going to receive orders at this address. This field is required for B2B Buyer Portal.",
+ "example": "Clark Kent.",
+ "nullable": true
+ },
+ "city": {
+ "type": "string",
+ "description": "City of the shipping address. This field is required for B2B Buyer Portal.",
+ "example": "Raleigh",
+ "nullable": true
+ },
+ "state": {
+ "type": "string",
+ "description": "State of the shipping address. The state or province of the address. This field is required for B2B Buyer Portal.",
+ "example": "NC",
+ "nullable": true
+ },
+ "country": {
+ "type": "string",
+ "description": "Three letter ISO code of the country of the shipping address. This field is required for B2B Buyer Portal.",
+ "example": "USA",
+ "nullable": true
+ },
+ "postalCode": {
+ "type": "string",
+ "description": "Postal Code. The format must be compatible with the country postal code format (e.g., `00000` for addresses in the USA). This field is required for B2B Buyer Portal.",
+ "example": "12345",
+ "nullable": true
+ },
+ "street": {
+ "type": "string",
+ "description": "The street name of the address. This field is required for B2B Buyer Portal.",
+ "example": "Main Street",
+ "nullable": true
+ },
+ "number": {
+ "type": "string",
+ "description": "Number of the building, house or apartment in the shipping address. This field is required for B2B Buyer Portal.",
+ "example": "300",
+ "nullable": true
+ },
+ "neighborhood": {
+ "type": "string",
+ "description": "Neighborhood of the address.",
+ "example": "Downtown",
+ "nullable": true
+ },
+ "complement": {
+ "type": "string",
+ "description": "Additional information or details that help identify or locate the shipping address, such as apartment number, suite, floor, or unit (if applicable).",
+ "example": "3rd floor",
+ "nullable": true
+ },
+ "reference": {
+ "type": "string",
+ "description": "Optional reference point or nearby landmark to help locate the shipping address during delivery (e.g., next to a park or behind a building).",
+ "example": "Next to the park",
+ "nullable": true
+ },
+ "geoCoordinate": {
+ "type": "string",
+ "description": "The geographical coordinates of the address (optional). This field is recommended for B2B Buyer Portal.",
+ "example": "40.7128,-74.0060",
+ "nullable": true
+ },
+ "userId": {
+ "type": "string",
+ "description": "ID of the customer to whom the address belongs. This information is the `id` returned by the customer profile (or contract) creation request. This field is required for B2B Buyer Portal.",
+ "example": "7e03m794-a33a-11e9-84rt6-0adfa64s5a8e",
+ "nullable": true
+ }
+ }
+ },
+ "documentResponse": {
+ "required": [
+ "Id",
+ "Href"
+ ],
+ "type": "object",
+ "description": "Response body object.",
+ "properties": {
+ "Id": {
+ "type": "string",
+ "description": "ID of the document that was created or updated."
+ },
+ "Href": {
+ "type": "string",
+ "description": "Document reference URL."
+ }
+ }
+ },
+ "AddressResponse": {
+ "type": "object",
+ "description": "Response body for an address document.",
+ "properties": {
+ "addressLabel": {
+ "type": "string",
+ "nullable": true,
+ "description": "A user-defined label to identify the address."
+ },
+ "addressType": {
+ "type": "string",
+ "nullable": true,
+ "description": "The type of address: `commercial` for shipping, `invoice` for billing.",
+ "enum": [
+ "commercial",
+ "invoice"
+ ]
+ },
+ "city": {
+ "type": "string",
+ "nullable": true,
+ "description": "The city of the address."
+ },
+ "complement": {
+ "type": "string",
+ "nullable": true,
+ "description": "Any additional information for the address (e.g., apartment, floor)."
+ },
+ "country": {
+ "type": "string",
+ "nullable": true,
+ "description": "The country of the address in three-letter code format (e.g., `\"USA\"`)."
+ },
+ "countryfake": {
+ "type": "string",
+ "nullable": true,
+ "description": "Placeholder or optional country value."
+ },
+ "geoCoordinate": {
+ "type": "string",
+ "nullable": true,
+ "description": "Geographical coordinates of the address (latitude and longitude)."
+ },
+ "neighborhood": {
+ "type": "string",
+ "nullable": true,
+ "description": "The neighborhood of the address."
+ },
+ "number": {
+ "type": "string",
+ "nullable": true,
+ "description": "The street number of the address."
+ },
+ "postalCode": {
+ "type": "string",
+ "nullable": true,
+ "description": "The postal code of the address. The format must be compatible with the address country postal code format. (e.g., `00000` for addresses in the USA)."
+ },
+ "receiverName": {
+ "type": "string",
+ "nullable": true,
+ "description": "The name of the person or entity receiving at this address."
+ },
+ "reference": {
+ "type": "string",
+ "nullable": true,
+ "description": "Optional reference point or landmark near the address."
+ },
+ "state": {
+ "type": "string",
+ "nullable": true,
+ "description": "The state or province of the address."
+ },
+ "street": {
+ "type": "string",
+ "nullable": true,
+ "description": "The street name of the address."
+ },
+ "userId": {
+ "type": "string",
+ "nullable": true,
+ "description": "The ID of the user or related entity."
+ },
+ "id": {
+ "type": "string",
+ "nullable": true,
+ "description": "Unique identifier for this address record."
+ },
+ "accountId": {
+ "type": "string",
+ "nullable": true,
+ "description": "ID of the account related to this address."
+ },
+ "accountName": {
+ "type": "string",
+ "nullable": true,
+ "description": "Name of the account related to this address."
+ },
+ "dataEntityId": {
+ "type": "string",
+ "nullable": true,
+ "description": "ID of the data entity this address belongs to (always `\"AD\"`)."
+ },
+ "createdBy": {
+ "type": "string",
+ "nullable": true,
+ "description": "ID of the user who created the address record."
+ },
+ "createdIn": {
+ "type": "string",
+ "nullable": true,
+ "description": "Timestamp of when the address record was created."
+ },
+ "updatedBy": {
+ "type": "string",
+ "nullable": true,
+ "description": "ID of the user who last updated the address record."
+ },
+ "updatedIn": {
+ "type": "string",
+ "nullable": true,
+ "description": "Timestamp of the last update to the address record."
+ },
+ "lastInteractionBy": {
+ "type": "string",
+ "nullable": true,
+ "description": "ID of the user who had the last interaction with the record."
+ },
+ "lastInteractionIn": {
+ "type": "string",
+ "nullable": true,
+ "description": "Timestamp of the last interaction with the record."
+ },
+ "followers": {
+ "type": "array",
+ "nullable": true,
+ "description": "List of users following this address record.",
+ "items": {
+ "type": "string",
+ "description": "User ID."
+ }
+ },
+ "tags": {
+ "type": "array",
+ "nullable": true,
+ "description": "List of tags associated with this address.",
+ "items": {
+ "type": "string",
+ "description": "Tag value."
+ }
+ },
+ "auto_filter": {
+ "type": "string",
+ "nullable": true,
+ "description": "Optional field used for automatic filtering or categorization."
+ }
+ }
+ }
+ }
+ },
+ "tags": [
+ {
+ "name": "Data entities"
+ },
+ {
+ "name": "Documents"
+ },
+ {
+ "name": "Customer profiles"
+ },
+ {
+ "name": "Addresses"
+ },
+ {
+ "name": "Versions"
+ },
+ {
+ "name": "Scroll"
+ },
+ {
+ "name": "Search"
+ },
+ {
+ "name": "Attachments"
+ },
+ {
+ "name": "Clusters"
+ },
+ {
+ "name": "Score"
+ }
+ ]
+}
diff --git a/clients/manitou/output/masterdata-v2.json b/clients/manitou/output/masterdata-v2.json
new file mode 100644
index 0000000000..073284e38e
--- /dev/null
+++ b/clients/manitou/output/masterdata-v2.json
@@ -0,0 +1,1604 @@
+{
+ "openapi": "3.0.3",
+ "info": {
+ "title": "Master Data API - v2",
+ "description": ">ℹ️ Master Data v2 is not compatible with data entities from previous versions, such as CL and AD.\r\n\r\n[Master Data](https://developers.vtex.com/docs/guides/master-data-introduction) is a secure, fast, scalable, and extensible solution that allows users to create their own entities, store data, and retrieve information directly from the storefront or external integrations.\r\n\r\nSeveral internal VTEX modules use Master Data as a data repository, including Orders and Sales App. \r\n\r\nThere are two main ways to use Master Data:\r\n\r\n- [Directly from the storefront](#directly-from-the-storefront)\r\n- [With an external integration](#external-integrations)\r\n\r\n## Directly from the storefront\r\n\r\nWhen using Master Data within the storefront, consider the following:\r\n\r\n- Use the storefront host to query or store information to avoid issues related to Cross-origin resource sharing (CORS).\r\n- Use the relative path to avoid CORS issues.\r\n- Configure the JSON Schema of the Data Entity to specify which information should be public and which should not be.\r\n- Avoid creating query loops to prevent potential throttling issues or APIs being disabled due to security protection measures.\r\n- Never add authentication keys, such as `X-VTEX-API-AppKey` or `X-VTEX-API-AppToken`, via JavaScript as this could pose security risks.\r\n\r\n## External integrations\r\n\r\nWhen using Master Data to store data from an external integration, such as client data from another service, consider the following:\r\n\r\n- Use the host `{{accountName}}.vtexcommercestable.com.br`.\r\n- Use the authentication keys (`X-VTEX-API-AppKey` ou `X-VTEX-API-AppToken`).\r\n\r\n## Common parameters\r\n\r\n| Name | Description |\r\n| -------- | -------- |\r\n| `accountName` | Account name in VTEX License Manager. |\r\n| `name` | Data Entity name. |\r\n| `schema` | JSON Schema of a Data Entity. |\r\n| `id` | Identifier of a document. |\r\n| `X-VTEX-API-AppKey` | appKey. |\r\n| `X-VTEX-API-AppToken` | appToken. | \r\n\r\n## Index\r\n\r\n### Documents\r\n\r\n- `POST` [Create new document](https://developers.vtex.com/docs/api-reference/master-data-api-v2#post-/api/dataentities/-dataEntityName-/documents)\r\n- `PATCH` [Create partial document](https://developers.vtex.com/docs/api-reference/master-data-api-v2#patch-/api/dataentities/-dataEntityName-/documents)\r\n- `GET` [Get document](https://developers.vtex.com/docs/api-reference/master-data-api-v2#get-/api/dataentities/-dataEntityName-/documents/-id-)\r\n- `PUT` [Create document with custom ID or Update entire document](https://developers.vtex.com/docs/api-reference/master-data-api-v2#put-/api/dataentities/-dataEntityName-/documents/-id-)\r\n- `PATCH` [Update partial document](https://developers.vtex.com/docs/api-reference/master-data-api-v2#patch-/api/dataentities/-dataEntityName-/documents/-id-)\r\n- `DELETE` [Delete document](https://developers.vtex.com/docs/api-reference/master-data-api-v2#delete-/api/dataentities/-dataEntityName-/documents/-id-)\r\n\r\n### Search\r\n\r\n- `GET` [Search documents](https://developers.vtex.com/docs/api-reference/master-data-api-v2#get-/api/dataentities/-dataEntityName-/search)\r\n\r\n### Scroll\r\n\r\n- `GET` [Scroll documents](https://developers.vtex.com/docs/api-reference/master-data-api-v2#get-/api/dataentities/-dataEntityName-/scroll)\r\n\r\n### Schemas\r\n\r\n- `GET` [Get schemas](https://developers.vtex.com/docs/api-reference/master-data-api-v2#get-/api/dataentities/-dataEntityName-/schemas)\r\n- `GET` [Get schema by name](https://developers.vtex.com/docs/api-reference/master-data-api-v2#get-/api/dataentities/-dataEntityName-/schemas/-schemaName-)\r\n- `PUT` [Save schema by name](https://developers.vtex.com/docs/api-reference/master-data-api-v2#put-/api/dataentities/-dataEntityName-/schemas/-schemaName-)\r\n- `DELETE` [Delete schema by name](https://developers.vtex.com/docs/api-reference/master-data-api-v2#delete-/api/dataentities/-dataEntityName-/schemas/-schemaName-)\r\n\r\n### Indices\r\n\r\n- `GET` [Get indices](https://developers.vtex.com/docs/api-reference/master-data-api-v2#get-/api/dataentities/-dataEntityName-/indices)\r\n- `PUT` [Put indices](https://developers.vtex.com/docs/api-reference/master-data-api-v2#put-/api/dataentities/-dataEntityName-/indices)\r\n- `GET` [Get index by name](https://developers.vtex.com/docs/api-reference/master-data-api-v2#get-/api/dataentities/-dataEntityName-/indices/-index_name-)\r\n- `DELETE` [Delete index by name](https://developers.vtex.com/docs/api-reference/master-data-api-v2#delete-/api/dataentities/-dataEntityName-/indices/-index_name-)\r\n\r\n### Clusters\r\n\r\n- `POST` [Validate document by clusters](https://developers.vtex.com/docs/api-reference/master-data-api-v2#post-/api/dataentities/-dataEntityName-/documents/-id-/clusters)\r\n\r\n### Versions\r\n\r\n- `GET` [List versions](https://developers.vtex.com/docs/api-reference/master-data-api-v2#get-/api/dataentities/-dataEntityName-/documents/-id-/versions)\r\n- `GET` [Get version](https://developers.vtex.com/docs/api-reference/master-data-api-v2#get-/api/dataentities/-dataEntityName-/documents/-id-/versions/-versionId-)\r\n- `PUT` [Put version](https://developers.vtex.com/docs/api-reference/master-data-api-v2#put-/api/dataentities/-dataEntityName-/documents/-id-/versions/-versionId-)",
+ "contact": {},
+ "version": "1.0"
+ },
+ "servers": [
+ {
+ "url": "https://{accountName}.{environment}.com.br",
+ "description": "VTEX server URL.",
+ "variables": {
+ "accountName": {
+ "description": "Name of the VTEX account. Used as part of the URL",
+ "default": "apiexamples"
+ },
+ "environment": {
+ "description": "Environment to use. Used as part of the URL.",
+ "enum": [
+ "vtexcommercestable"
+ ],
+ "default": "vtexcommercestable"
+ }
+ }
+ }
+ ],
+ "paths": {
+ "/api/dataentities/{dataEntityName}/documents": {
+ "post": {
+ "tags": [
+ "Documents"
+ ],
+ "summary": "Create new document",
+ "description": "Creates a new document with an ID automatically generated by VTEX, corresponding to a new or existing data entity. If an unexisting `dataEntityName` is informed in the path, this endpoint will create the data entity as well as the new document. For example, you can create a new customer profile or address.\r\n\r\n>ℹ️ You can use this request to create documents for any data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. However you should be aware of the fields allowed or required for each document you wish to create.\r\n\r\n> To create a document with a custom ID, refer to the [Create document with custom ID](https://developers.vtex.com/docs/api-reference/master-data-api-v2#put-/api/dataentities/-dataEntityName-/documents/-id-) endpoint.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "Createnewdocument",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/dataEntityName"
+ },
+ {
+ "$ref": "#/components/parameters/_schema"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DocumentRequest"
+ },
+ "example": {
+ "email": "clark.kent@examplemail.com",
+ "firstName": "Clark",
+ "lastName": "Kent",
+ "phone": "+12025550195",
+ "documentType": "CPF",
+ "document": "12345678900",
+ "isCorporate": false,
+ "isNewsletterOptIn": false,
+ "localeDefault": "en-US"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateDocumentResponse"
+ },
+ "example": {
+ "Id": "Newsletter-cbfc4f67-6ea3-11ee-83ab-0a8d18f9f827",
+ "Href": "http://cosmetics2.vtexcommercestable.com.br/api/dataentities/Newsletter/documents/cbfc4f67-6ea3-11ee-83ab-0a8d18f9f827",
+ "DocumentId": "cbfc4f67-6ea3-11ee-83ab-0a8d18f9f827"
+ }
+ }
+ }
+ },
+ "202": {
+ "description": "Accepted\n\nThe document creation has been accepted and will be processed asynchronously due to background operations.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateDocumentResponse"
+ },
+ "example": {
+ "Id": "Newsletter-cbfc4f67-6ea3-11ee-83ab-0a8d18f9f827",
+ "Href": "http://cosmetics2.vtexcommercestable.com.br/api/dataentities/Newsletter/documents/cbfc4f67-6ea3-11ee-83ab-0a8d18f9f827",
+ "DocumentId": "cbfc4f67-6ea3-11ee-83ab-0a8d18f9f827"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false
+ },
+ "patch": {
+ "tags": [
+ "Documents"
+ ],
+ "summary": "Create partial document",
+ "description": "This request allows you to partially update a document corresponding to a given data entity.\r\n\r\n>ℹ️ You can use this request to create documents for any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "Createorupdatepartialdocument",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/dataEntityName"
+ },
+ {
+ "$ref": "#/components/parameters/_schema"
+ }
+ ],
+ "requestBody": {
+ "description": "JSON with the fields to be updated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DocumentRequest"
+ },
+ "example": {
+ "phone": "+12025550195",
+ "isNewsletterOptIn": false
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CreateDocumentResponse"
+ },
+ "example": {
+ "Id": "Newsletter-b818cbda-e489-11e6-94f4-0ac138d2d42e",
+ "Href": "http://api.vtex.com/apiexamples/dataentities/Newsletter/documents/b818cbda-e489-11e6-94f4-0ac138d2d42e",
+ "DocumentId": "b818cbda-e489-11e6-94f4-0ac138d2d42e"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/api/dataentities/{dataEntityName}/documents/{id}": {
+ "get": {
+ "tags": [
+ "Documents"
+ ],
+ "summary": "Get document",
+ "description": "Retrieves a document by ID.\n\r\n\r>ℹ️ Assign the `_fields` parameter in the query string to retrieve the desired fields. If you want to return all the fields use `_fields=_all`.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Getdocument",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/dataEntityName"
+ },
+ {
+ "$ref": "#/components/parameters/id"
+ },
+ {
+ "$ref": "#/components/parameters/_fields"
+ },
+ {
+ "$ref": "#/components/parameters/_schema"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Using_fields_all"
+ },
+ "example": {
+ "id": "b818cbda-e489-11e6-94f4-0ac138d2d42e",
+ "accountId": "14af940d-9300-4279-9355-61d44c2ff879",
+ "accountName": "apiexamples",
+ "dataEntityId": "Newsletter"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false
+ },
+ "put": {
+ "tags": [
+ "Documents"
+ ],
+ "summary": "Create document with custom ID or update entire document",
+ "description": "Creates a new document with a custom ID, or updates an entire document if there is already a document with the informed ID. For example, you can update a customer profile or address.\r\n\r\n>ℹ️ You can use this request to create or update documents in any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update.\r\n\r\nA## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "Updateentiredocument",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/dataEntityName"
+ },
+ {
+ "$ref": "#/components/parameters/_where"
+ },
+ {
+ "$ref": "#/components/parameters/_schema"
+ },
+ {
+ "name": "id",
+ "in": "path",
+ "description": "ID of the document. If you inform an **unused ID**, this endpoint will create a new document with the informed custom ID, differently from the [Create new document](https://developers.vtex.com/docs/api-reference/master-data-api-v2#post-/api/dataentities/-dataEntityName-/documents) endpoint, which automatically generates the ID. If you inform an **existing ID**, this endpoint will update the entire document associated with the informed ID.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "Newsletter-b818cbda-e489-11e6-94f4-0ac138d2d42e"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DocumentRequest"
+ },
+ "example": {
+ "email": "clark.kent@examplemail.com",
+ "firstName": "Clark",
+ "lastName": "Kent",
+ "phone": "+12025550195",
+ "documentType": "CPF",
+ "document": "12345678900",
+ "isCorporate": false,
+ "isNewsletterOptIn": false,
+ "localeDefault": "en-US"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "400": {
+ "description": "Bad Request\n\nInvalid information in JSON."
+ },
+ "403": {
+ "description": "Forbidden\n\nUnauthorized access."
+ }
+ },
+ "deprecated": false
+ },
+ "patch": {
+ "tags": [
+ "Documents"
+ ],
+ "summary": "Update partial document",
+ "description": "This request allows you to partially update a document corresponding to a given data entity. For example, you can update some fields of a customer profile or address.\r\n\r\n>ℹ️ You can use this request to update documents for any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "Updatepartialdocument",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/dataEntityName"
+ },
+ {
+ "$ref": "#/components/parameters/_where"
+ },
+ {
+ "$ref": "#/components/parameters/_schema"
+ },
+ {
+ "$ref": "#/components/parameters/id"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DocumentRequest"
+ },
+ "example": {
+ "phone": "+12025550195",
+ "isNewsletterOptIn": false
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "204": {
+ "description": "No Content"
+ }
+ },
+ "deprecated": false
+ },
+ "delete": {
+ "tags": [
+ "Documents"
+ ],
+ "summary": "Delete document",
+ "description": "Deletes a document. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Deletedocument",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/dataEntityName"
+ },
+ {
+ "$ref": "#/components/parameters/id"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/api/dataentities/{dataEntityName}/search": {
+ "get": {
+ "tags": [
+ "Search"
+ ],
+ "summary": "Search documents",
+ "description": "Retrieves Master Data v2 documents' information, while choosing which fields will be returned and filtering documents by specific fields.\r\n\r\n> The response header `REST-Content-Range` indicates the total amount of results for that specific search. For example, it may return `resources 0-100/136108`, which indicates it has returned the first 100 results out of a total of 136108.\r\n\r\nBelow you can see some query examples and learn more about each query parameter.\n\r\n\rLearn more about [Pagination in the Master Data API](https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api).\r\n\r\n>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code `503`.\r\n\r\n## Query examples\r\n\r\n| **Query Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `/dataentities/Newsletter/search?email=my@email.com` |\r\n| **Complex filter** | `/dataentities/Newsletter/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `/dataentities/Newsletter/search?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Range numeric fields** | `/dataentities/Newsletter/search?_where=age between 18 AND 25` |\r\n| **Partial filter** | `/dataentities/Newsletter/search?firstName=*Maria*` |\r\n| **Filter for null values** | `/dataentities/Newsletter/search?_where=firstName is null` |\r\n| **Filter for non-null values** | `/dataentities/Newsletter/search?_where=firstName is not null` |\r\n| **Filter for difference** | `/dataentities/Newsletter/search?_where=firstName<>maria` |\r\n| **Filter greater than** | `/dataentities/Newsletter/search?_where=number>5` |\r\n| **Filter less than** | `/dataentities/Newsletter/search?_where=date<2001-01-01` |\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Searchdocuments",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/dataEntityName"
+ },
+ {
+ "$ref": "#/components/parameters/REST-Range"
+ },
+ {
+ "$ref": "#/components/parameters/_fields"
+ },
+ {
+ "$ref": "#/components/parameters/_where"
+ },
+ {
+ "$ref": "#/components/parameters/_schema"
+ },
+ {
+ "$ref": "#/components/parameters/_sort"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "headers": {
+ "REST-Content-Range": {
+ "schema": {
+ "type": "string",
+ "description": "Indicates the range of documents returned in the current response, as well as the total number of documents available in the dataset. The value follows the format `resources={x}-{y}/{total}`, where:\n* `x`: Index of the first document in the returned array.\n* `y`: Index of the last document in the returned array + 1.\n* `total`: Total number of documents that match the query.\nFor example, `resources=0-10/98` indicates that documents from 0 to 9 are returned out of a total of 98 matching documents.",
+ "example": "resources=0-10/98"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "description": "List of documents that correspond to the result of the search.",
+ "items": {
+ "$ref": "#/components/schemas/Using_fields_all"
+ }
+ },
+ "example": [
+ {
+ "id": "b818cbda-e489-11e6-94f4-0ac138d2d42e",
+ "accountId": "14af940d-9300-4279-9355-61d44c2ff879",
+ "accountName": "apiexamples",
+ "dataEntityId": "Newsletter"
+ }
+ ]
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "description": "Response body object.",
+ "properties": {
+ "Message": {
+ "type": "string",
+ "description": "Error message."
+ }
+ }
+ },
+ "example": {
+ "Message": "Field 'X' not found in schema"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "description": "Response body object.",
+ "properties": {
+ "Message": {
+ "type": "string",
+ "description": "Error message."
+ }
+ }
+ },
+ "example": {
+ "Message": "Cannot filter by private fields"
+ }
+ }
+ }
+ },
+ "503": {
+ "description": "Service Unavailable\n\nWildcard queries temporarily blocked due to excessive usage. Consider adjusting your code to remove them or reduce the rate of search requests with wildcards (*). This temporary block may also be due to excessive use of requests with the parameter `keyword`."
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/api/dataentities/{dataEntityName}/scroll": {
+ "get": {
+ "tags": [
+ "Scroll"
+ ],
+ "summary": "Scroll documents",
+ "description": "Returns a list of documents according to query parameter filters. If you need to query the entire database, or your collection is over 10000 documents, use this endpoint.\r\n\r\nIn the first request, the `X-VTEX-MD-TOKEN` token will be obtained in the response header. This token must be passed to the next request in the `_token` query string parameter. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer.\r\n\r\nAfter the token is obtained, it is no longer necessary to send the filter or document size per page parameters. You only need to resend the token until the document collection is empty.\r\n\r\nFirst request:\r\n```\r\n/dataentities/Newsletter/scroll?isCluster=true&_size=250&_fields=email,firstName\r\n```\r\n\r\nRetrieve the token in the header `X-VTEX-MD-TOKEN` from the first request's response and use it to make the following requests.\r\n\r\nSubsequent requests:\r\n```\r\n/dataentities/Newsletter/scroll?_token={tokenValue}\r\n```\n\r\n\rLearn more about [Pagination in the Master Data API](https://developers.vtex.com/docs/guides/pagination-in-the-master-data-api).\r\n\r\n>⚠️ Avoid sending too many requests with wildcards (`*`) in the search parameters or using the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code `429`.\r\n\r\n## Query examples\r\n\r\n| **Query Type** | **Example** |\r\n|-|-|\r\n| **Simple filter** | `/dataentities/Newsletter/scroll?email=my@email.com` |\r\n| **Complex filter** | `/dataentities/Newsletter/scroll?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)` |\r\n| **Date range** | `/dataentities/Newsletter/scroll?_where=createdIn between 2001-01-01 AND 2016-01-01` |\r\n| **Range numeric fields** | `/dataentities/Newsletter/scroll?_where=age between 18 AND 25` |\r\n| **Partial filter** | `/dataentities/Newsletter/scroll?firstName=*Maria*` |\r\n| **Filter for null values** | `/dataentities/Newsletter/scroll?_where=firstName is null` |\r\n| **Filter for non-null values** | `/dataentities/Newsletter/scroll?_where=firstName is not null` |\r\n| **Filter for difference** | `/dataentities/Newsletter/scroll?_where=firstName<>maria` |\r\n| **Filter greater than** | `/dataentities/Newsletter/scroll?_where=number>5` |\r\n| **Filter less than** | `/dataentities/Newsletter/scroll?_where=date<2001-01-01` |\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Scrolldocuments",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/dataEntityName"
+ },
+ {
+ "$ref": "#/components/parameters/_token"
+ },
+ {
+ "$ref": "#/components/parameters/_size"
+ },
+ {
+ "$ref": "#/components/parameters/_fields"
+ },
+ {
+ "$ref": "#/components/parameters/_where"
+ },
+ {
+ "$ref": "#/components/parameters/_schema"
+ },
+ {
+ "$ref": "#/components/parameters/_sort"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "headers": {
+ "X-VTEX-MD-TOKEN": {
+ "schema": {
+ "type": "string",
+ "description": "Scroll token, which must be informed in the `_token` query parameter in the subsequent requests. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer."
+ }
+ },
+ "REST-Content-Total": {
+ "schema": {
+ "type": "string",
+ "description": "Total amount of documents corresponding to the query."
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "description": "List of documents that correspond to the result of the scroll.",
+ "items": {
+ "$ref": "#/components/schemas/Using_fields_all"
+ }
+ },
+ "example": [
+ {
+ "id": "b818cbda-e489-11e6-94f4-0ac138d2d42e",
+ "accountId": "14af940d-9300-4279-9355-61d44c2ff879",
+ "accountName": "apiexamples",
+ "dataEntityId": "Newsletter"
+ }
+ ]
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "description": "Response body object.",
+ "properties": {
+ "Message": {
+ "type": "string",
+ "description": "Error message."
+ }
+ }
+ },
+ "example": {
+ "Message": "Operation not found for this token: 'X'"
+ }
+ }
+ }
+ },
+ "429": {
+ "description": "Too Many Requests\n\nWildcard queries temporarily blocked due to excessive usage. Consider adjusting your code to remove them or reduce the rate of search requests with wildcards (*). This temporary block may also be due to excessive use of requests with the parameter `keyword`."
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/api/dataentities/{dataEntityName}/schemas": {
+ "get": {
+ "tags": [
+ "Schemas"
+ ],
+ "summary": "Get schemas",
+ "description": "Retrieves all existing [schemas](https://developers.vtex.com/docs/guides/master-data-schema-lifecycle) for a given data entity. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Getschemas",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/dataEntityName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "description": "Array with existing schemas. In case there is only one existing schema, it will be an object instead, without the `name` property and the named `schema` object, following the same structure as the [Get schema by name](https://developers.vtex.com/docs/api-reference/master-data-api-v2#get-/api/dataentities/-dataEntityName-/schemas/-schemaName-?endpoint=get-/api/dataentities/-dataEntityName-/schemas/-schemaName-) endpoint response.",
+ "items": {
+ "$ref": "#/components/schemas/GetSchemasResponse"
+ }
+ },
+ "example": [
+ {
+ "name": "testschema",
+ "schema": {
+ "properties": {
+ "name": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/api/dataentities/{dataEntityName}/schemas/{schemaName}": {
+ "get": {
+ "tags": [
+ "Schemas"
+ ],
+ "summary": "Get schema by name",
+ "description": "Returns an existing [schema](https://developers.vtex.com/docs/guides/master-data-schema-lifecycle) for a given data entity. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Getschemabyname",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/dataEntityName"
+ },
+ {
+ "$ref": "#/components/parameters/schemaName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SaveschemabynameRequest"
+ },
+ "example": {
+ "properties": {
+ "name": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false
+ },
+ "put": {
+ "tags": [
+ "Schemas"
+ ],
+ "summary": "Save schema by name",
+ "description": "Creates or edits a data entity schema. Learn more about [Master Data schemas](https://developers.vtex.com/vtex-rest-api/docs/master-data-schema-lifecycle).\r\n\r\n> Note that if you send a `schemaName` that does not exist for that data entity, this request will create it.\r\n\r\nThis request can also be used to [create or edit Master Data v2 triggers](https://developers.vtex.com/vtex-rest-api/docs/setting-up-triggers-in-master-data-v2).\r\n\r\n> Each Master Data v2 data entity can have up to 60 schemas. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "Saveschemabyname",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/dataEntityName"
+ },
+ {
+ "$ref": "#/components/parameters/schemaName"
+ }
+ ],
+ "requestBody": {
+ "description": "Request body for saving schema",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SaveschemabynameRequest"
+ },
+ "example": {
+ "properties": {
+ "name": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "description": "Response body object.",
+ "properties": {
+ "Message": {
+ "type": "string",
+ "description": "Success message."
+ }
+ }
+ },
+ "example": {
+ "Message": "JSON Schema persisted successfully. Revalidation and indexing process running in background."
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false
+ },
+ "delete": {
+ "tags": [
+ "Schemas"
+ ],
+ "summary": "Delete schema by name",
+ "description": "Deletes an existing [schema](https://developers.vtex.com/docs/guides/master-data-schema-lifecycle) for a given data entity. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Deleteschemabyname",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/dataEntityName"
+ },
+ {
+ "$ref": "#/components/parameters/schemaName"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/api/dataentities/{dataEntityName}/indices": {
+ "get": {
+ "tags": [
+ "Indices"
+ ],
+ "summary": "Get indices",
+ "description": "Returns the list of [indices](https://developers.vtex.com/docs/guides/master-data-components#index) by data entity. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Index | **View index details** |\r\n| Dynamic Storage | Index | **List index** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Getindices",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/dataEntityName"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "description": "Array with information about indices.",
+ "items": {
+ "$ref": "#/components/schemas/Index"
+ }
+ },
+ "example": [
+ {
+ "name": "fullName",
+ "acronym": "Newsletter",
+ "isGlobal": false,
+ "multiple": false,
+ "fields": "firstName,lastName"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "deprecated": false
+ },
+ "put": {
+ "tags": [
+ "Indices"
+ ],
+ "summary": "Create index",
+ "description": "Creates an [index](https://developers.vtex.com/docs/guides/master-data-components#index). \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Index | **Edit index** |\r\n| Dynamic Storage | Index | **Create index** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "Putindices",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/dataEntityName"
+ }
+ ],
+ "requestBody": {
+ "description": "Request body for creating an index",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PutindicesRequest"
+ },
+ "example": {
+ "name": "indexName",
+ "multiple": false,
+ "fields": "fieldName"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK"
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/api/dataentities/{dataEntityName}/indices/{index_name}": {
+ "get": {
+ "tags": [
+ "Indices"
+ ],
+ "summary": "Get index by name",
+ "description": "Retrieves an [index](https://developers.vtex.com/docs/guides/master-data-components#index). \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Index | **View index details** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Getindexbyname",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/dataEntityName"
+ },
+ {
+ "$ref": "#/components/parameters/index_name"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Index"
+ },
+ "example": {
+ "name": "fullName",
+ "acronym": "Newsletter",
+ "isGlobal": false,
+ "multiple": false,
+ "fields": "firstName,lastName"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false
+ },
+ "delete": {
+ "tags": [
+ "Indices"
+ ],
+ "summary": "Delete index by name",
+ "description": "Deletes an [index](https://developers.vtex.com/docs/guides/master-data-components#index). \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Index | **Remove index** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Deleteindexbyname",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/dataEntityName"
+ },
+ {
+ "$ref": "#/components/parameters/index_name"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/api/dataentities/{dataEntityName}/documents/{id}/clusters": {
+ "post": {
+ "tags": [
+ "Clusters"
+ ],
+ "summary": "Validate document by clusters",
+ "description": "Checks if a document is present in one or more clusters (specific set of field values).\r\n\r\n>ℹ️ There is a limit of five rules per request. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "Validatedocumentbyclusters",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/dataEntityName"
+ },
+ {
+ "$ref": "#/components/parameters/id"
+ }
+ ],
+ "requestBody": {
+ "description": "Request body for validating a document by clusters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "description": "List of cluster validation rule information.",
+ "items": {
+ "type": "object",
+ "description": "Cluster validation rule information.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Cluster name.",
+ "example": "male"
+ },
+ "rule": {
+ "type": "string",
+ "description": "Cluster validation rule.",
+ "example": "gender=male"
+ }
+ }
+ }
+ },
+ "example": [
+ {
+ "name": "male",
+ "rule": "gender=male"
+ },
+ {
+ "name": "complex",
+ "rule": "((gender=male AND percent=0.35) AND any is null) AND (name=*go*)"
+ },
+ {
+ "name": "complex2",
+ "rule": "((gender=male AND percent=0.35) AND any is not null) OR (name=*go*)"
+ },
+ {
+ "name": "createdIn",
+ "rule": "createdIn between 2015-10-28 AND 2015-10-30"
+ }
+ ]
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "description": "Array with objects validating each cluster rule.",
+ "items": {
+ "type": "object",
+ "description": "Cluster rule validation object.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Cluster name."
+ },
+ "isValid": {
+ "type": "boolean",
+ "description": "Informs if the document is valid according to the cluster rule (`true`) or not (`false`)."
+ }
+ }
+ }
+ },
+ "example": [
+ {
+ "name": "male",
+ "isValid": false
+ },
+ {
+ "name": "complex",
+ "isValid": false
+ },
+ {
+ "name": "complex2",
+ "isValid": false
+ },
+ {
+ "name": "createdIn",
+ "isValid": false
+ }
+ ]
+ }
+ }
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/api/dataentities/{dataEntityName}/documents/{id}/versions": {
+ "get": {
+ "tags": [
+ "Versions"
+ ],
+ "summary": "List versions",
+ "description": "Lists the versions of a document. \r\n\r\n>ℹ Master Data documents are versioned. This means that, for each change, a new version is generated. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Listversions",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/dataEntityName"
+ },
+ {
+ "$ref": "#/components/parameters/id"
+ },
+ {
+ "name": "load",
+ "in": "query",
+ "description": "If true, return all the fields in each version of the document.",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": true
+ }
+ },
+ {
+ "name": "fields",
+ "in": "query",
+ "description": "If `load` is true, the response will return only these specific fields.",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "default": "id,dataEntityId,isNewsletterOptIn,createdBy"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Listversion"
+ }
+ },
+ "example": [
+ {
+ "id": "_EAR0cJ7XB5k5grnmm0zeKGlVvVM9WCPy_",
+ "date": "2016-10-18T16:53:32+00:00",
+ "document": {
+ "id": "72e7f8dd-1168-23ec-82ac-0e2b61663eb4",
+ "dataEntityId": "Newsletter",
+ "isNewsletterOptIn": true,
+ "createdBy": "81fc8b10-25b7-48de-b425-7b93554002cc"
+ }
+ },
+ {
+ "id": "_E5SH9WXVvhPBNnbQtYAAGqrIysIeNYhV_",
+ "date": "2016-09-08T20:11:42+00:00",
+ "document": {
+ "id": "72e7f8dd-1168-23ec-82ac-0e2b61663eb4",
+ "dataEntityId": "Newsletter",
+ "isNewsletterOptIn": true,
+ "createdBy": "81fc8b10-25b7-48de-b425-7b93554002cc"
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "deprecated": false
+ }
+ },
+ "/api/dataentities/{dataEntityName}/documents/{id}/versions/{versionId}": {
+ "get": {
+ "tags": [
+ "Versions"
+ ],
+ "summary": "Get version",
+ "description": "Returns the version of a document. \r\n\r\n>ℹ Master Data documents are versioned. This means that, for each change, a new version is generated. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Getversion",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/dataEntityName"
+ },
+ {
+ "$ref": "#/components/parameters/id"
+ },
+ {
+ "$ref": "#/components/parameters/versionId"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "headers": {},
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Getversion"
+ },
+ "example": {
+ "id": "cSIAceEelBEmSOqRkzJYLRQuGgi6.CqF",
+ "author": "1f936e42-79b3-4e5b-91d2-da9a8af0b215",
+ "document": {
+ "id": "cbfc4f67-6ea3-11ee-83ab-0a8d18f9f827",
+ "dataEntityId": "Newsletter",
+ "accountId": "a8b27fb4-6516-4cc0-82b6-a5f2b011e6e2",
+ "accountName": "apiexamples",
+ "followers": [],
+ "schemas": [
+ "testprofile",
+ "testprofile2"
+ ],
+ "email": "clark.kent@examplemail.com"
+ }
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false
+ },
+ "put": {
+ "tags": [
+ "Versions"
+ ],
+ "summary": "Update version",
+ "description": "Updates the document's version value.\r\n\r\n>ℹ Master Data documents are versioned. This means that, for each change, a new version is generated. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+ "operationId": "Putversion",
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/dataEntityName"
+ },
+ {
+ "$ref": "#/components/parameters/id"
+ },
+ {
+ "name": "versionId",
+ "in": "path",
+ "description": "ID of the version to update",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "_8sZcvyj4nng7FgA2RgtVVZmkIxb4Pbfe_"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/documentResponse"
+ },
+ "example": {
+ "Id": "Newsletter-b818cbda-e489-11e6-94f4-0ac138d2d42e",
+ "Href": "http://api.vtex.com/apiexamples/dataentities/Newsletter/documents/b818cbda-e489-11e6-94f4-0ac138d2d42e"
+ }
+ }
+ }
+ },
+ "304": {
+ "description": "Not Modified"
+ }
+ },
+ "deprecated": false
+ }
+ }
+ },
+ "security": [
+ {
+ "appKey": [],
+ "appToken": []
+ },
+ {
+ "VtexIdclientAutCookie": []
+ }
+ ],
+ "components": {
+ "schemas": {
+ "DocumentRequest": {
+ "title": "DocumentRequest",
+ "type": "object",
+ "description": "This can be any pure JSON document. Add new _Key-Value_ pairs to test.",
+ "additionalProperties": true
+ },
+ "Using_fields_all": {
+ "title": "Using_fields=_all",
+ "required": [
+ "id",
+ "accountId",
+ "accountName",
+ "dataEntityId"
+ ],
+ "type": "object",
+ "description": "Document information.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "ID of the document."
+ },
+ "accountId": {
+ "type": "string",
+ "description": "ID of the VTEX account."
+ },
+ "accountName": {
+ "type": "string",
+ "description": "Name of the VTEX account."
+ },
+ "dataEntityId": {
+ "type": "string",
+ "description": "Data entity name."
+ }
+ }
+ },
+ "SaveschemabynameRequest": {
+ "title": "SaveschemabynameRequest",
+ "required": [
+ "properties"
+ ],
+ "type": "object",
+ "description": "Schema.",
+ "properties": {
+ "properties": {
+ "type": "object",
+ "description": "Object containing schema properties.",
+ "properties": {
+ "name": {
+ "type": "object",
+ "description": "Property name.",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "Type of property.",
+ "enum": [
+ "array",
+ "boolean",
+ "integer",
+ "number",
+ "object",
+ "string"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "GetSchemasResponse": {
+ "title": "GetSchemasResponse",
+ "required": [
+ "name",
+ "schema"
+ ],
+ "type": "object",
+ "description": "Schema.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Schema name."
+ },
+ "schema": {
+ "type": "object",
+ "description": "Object with schema properties.",
+ "properties": {
+ "properties": {
+ "type": "object",
+ "description": "Object containing schema properties.",
+ "properties": {
+ "name": {
+ "type": "object",
+ "description": "Property name.",
+ "required": [
+ "type"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "Type of property.",
+ "enum": [
+ "array",
+ "boolean",
+ "integer",
+ "number",
+ "object",
+ "string"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "PutindicesRequest": {
+ "title": "PutindicesRequest",
+ "required": [
+ "name",
+ "multiple",
+ "fields"
+ ],
+ "type": "object",
+ "description": "Request body object.",
+ "properties": {
+ "name": {
+ "description": "Name to identify the index.",
+ "type": "string",
+ "example": "indexName"
+ },
+ "multiple": {
+ "description": "Determines whether the values need to be unique. If false, values must be unique.",
+ "type": "boolean",
+ "example": false
+ },
+ "fields": {
+ "description": "Comma-separated fields of the index.",
+ "type": "string",
+ "example": "fieldName"
+ }
+ }
+ },
+ "Index": {
+ "type": "object",
+ "description": "Index information.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Index name."
+ },
+ "acronym": {
+ "type": "string",
+ "description": "Data entity name."
+ },
+ "isGlobal": {
+ "type": "boolean",
+ "description": "Defines whether the index is global (`true`) or not (`false`).",
+ "deprecated": true
+ },
+ "multiple": {
+ "type": "boolean",
+ "description": "Determines whether the values need to be unique. If `false`, values must be unique."
+ },
+ "fields": {
+ "type": "string",
+ "description": "Comma-separated fields of the index."
+ }
+ }
+ },
+ "Listversion": {
+ "title": "Listversion",
+ "required": [
+ "id",
+ "date"
+ ],
+ "type": "object",
+ "description": "Version information.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Version ID."
+ },
+ "date": {
+ "type": "string",
+ "description": "Date when the version was created in ISO 8601 format."
+ },
+ "document": {
+ "type": "object",
+ "description": "Information about the document.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Document ID."
+ },
+ "dataEntityId": {
+ "type": "string",
+ "description": "Data entity name."
+ },
+ "isNewsletterOptIn": {
+ "type": "boolean",
+ "description": "Indicates whether client otped to receive the store newsletter (`true`) or not (`false`).",
+ "nullable": true
+ },
+ "createdBy": {
+ "type": "string",
+ "description": "ID of the user who created the document."
+ }
+ }
+ }
+ }
+ },
+ "Getversion": {
+ "title": "Getversion",
+ "required": [
+ "id",
+ "author",
+ "document"
+ ],
+ "type": "object",
+ "description": "Request body object.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Version ID."
+ },
+ "author": {
+ "type": "string",
+ "description": "ID of the user who created the version."
+ },
+ "document": {
+ "$ref": "#/components/schemas/Document"
+ }
+ }
+ },
+ "Document": {
+ "title": "Document",
+ "required": [
+ "id",
+ "dataEntityId",
+ "accountId",
+ "accountName",
+ "followers"
+ ],
+ "type": "object",
+ "description": "Document information.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "ID of the document."
+ },
+ "dataEntityId": {
+ "type": "string",
+ "description": "Data entity name."
+ },
+ "accountId": {
+ "type": "string",
+ "description": "ID of the VTEX account."
+ },
+ "accountName": {
+ "type": "string",
+ "description": "Name of the VTEX account."
+ },
+ "followers": {
+ "type": "array",
+ "description": "Followers.",
+ "deprecated": true,
+ "items": {
+ "type": "string",
+ "description": "Follower."
+ }
+ },
+ "schemas": {
+ "type": "array",
+ "description": "Schemas which the document is compliant with.",
+ "items": {
+ "type": "string",
+ "description": "Schema name."
+ }
+ },
+ "email": {
+ "type": "string",
+ "description": "User email."
+ }
+ }
+ },
+ "CreateDocumentResponse": {
+ "required": [
+ "Id",
+ "Href",
+ "DocumentId"
+ ],
+ "type": "object",
+ "description": "Response body object.",
+ "properties": {
+ "Id": {
+ "type": "string",
+ "description": "ID of the document that was created, with data entity prefix."
+ },
+ "Href": {
+ "type": "string",
+ "description": "Document reference URL."
+ },
+ "DocumentId": {
+ "type": "string",
+ "description": "ID of the document that was created."
+ }
+ }
+ },
+ "documentResponse": {
+ "required": [
+ "Id",
+ "Href"
+ ],
+ "type": "object",
+ "description": "Response body object.",
+ "properties": {
+ "Id": {
+ "type": "string",
+ "description": "ID of the document that was created or updated."
+ },
+ "Href": {
+ "type": "string",
+ "description": "Document reference URL."
+ }
+ }
+ }
+ },
+ "parameters": {
+ "dataEntityName": {
+ "name": "dataEntityName",
+ "in": "path",
+ "required": true,
+ "description": "Name of the data entity.",
+ "schema": {
+ "type": "string",
+ "example": "Newsletter"
+ }
+ },
+ "_schema": {
+ "name": "_schema",
+ "in": "query",
+ "description": "Name of the [schema](https://developers.vtex.com/docs/guides/master-data-schema-lifecycle) that the document complies with. This field is required when using `_where` or `_fields` query parameters.",
+ "required": false,
+ "style": "form",
+ "schema": {
+ "type": "string",
+ "example": "schema"
+ }
+ },
+ "id": {
+ "name": "id",
+ "in": "path",
+ "description": "ID of the Document.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "b818cbda-e489-11e6-94f4-0ac138d2d42e"
+ }
+ },
+ "versionId": {
+ "name": "versionId",
+ "in": "path",
+ "description": "ID of the version to update.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "_8sZcvyj4nng7FgA2RgtVVZmkIxb4Pbfe_"
+ }
+ },
+ "_where": {
+ "name": "_where",
+ "in": "query",
+ "description": "Defines a condition the document must comply with. When referring to fields, you can use a nested field up to the first level (e.g. `wishlistProduct.productName`).",
+ "required": false,
+ "style": "form",
+ "schema": {
+ "type": "string",
+ "example": "firstName is not null"
+ }
+ },
+ "index_name": {
+ "name": "index_name",
+ "in": "path",
+ "description": "Name of the index.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "{{index_name}}"
+ }
+ },
+ "schemaName": {
+ "name": "schemaName",
+ "in": "path",
+ "description": "Name of the schema.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "{{schema}}"
+ }
+ },
+ "REST-Range": {
+ "name": "REST-Range",
+ "in": "header",
+ "description": "Specifies the range of documents to be returned in the response. The value should follow the format `resources={x}-{y}`, where:\n* `x`: Index of the first document in the returned array.\n* `y`: Index of the last document in the returned array + 1.\n\nThis field controls pagination by defining the subset of documents to be retrieved. The maximum number of documents returned per query is limited to 100.\nFor example, `resources=0-10` returns the first 10 documents.",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "resources=0-10"
+ }
+ },
+ "_fields": {
+ "name": "_fields",
+ "in": "query",
+ "description": "Fields that should be returned by document. Separate fields' names with commas. For example `_fields=email,firstName,document`. You can also use `_fields=_all` to fetch all fields.",
+ "required": false,
+ "style": "form",
+ "schema": {
+ "type": "string",
+ "example": "email,firstName,document"
+ }
+ },
+ "_sort": {
+ "name": "_sort",
+ "in": "query",
+ "description": "Defines sorting mode in two parts. The first part is the name of the field you want to sort by. It can be a nested field up to the first level (e.g. `wishlistProduct.productName`). In the second part, use `ASC` for ascending order or `DESC` for descending order.",
+ "required": false,
+ "style": "form",
+ "schema": {
+ "type": "string",
+ "example": "firstName ASC"
+ }
+ },
+ "_token": {
+ "name": "_token",
+ "in": "query",
+ "description": "Value of the `X-VTEX-MD-TOKEN` token obtained in the response header of the first request, necessary on subsequent requests to continue scrolling through documents. The token expires after 20 minutes of inactivity, and each request made with the token during this time resets the expiration timer.",
+ "required": false,
+ "style": "form",
+ "schema": {
+ "type": "string",
+ "example": "123456"
+ }
+ },
+ "_size": {
+ "name": "_size",
+ "in": "query",
+ "description": "Inform the number of documents per request. Maximum value of `1000`.",
+ "required": false,
+ "style": "form",
+ "schema": {
+ "type": "integer",
+ "default": 100
+ }
+ }
+ }
+ },
+ "tags": [
+ {
+ "name": "Documents"
+ },
+ {
+ "name": "Search"
+ },
+ {
+ "name": "Scroll"
+ },
+ {
+ "name": "Schemas"
+ },
+ {
+ "name": "Indices"
+ },
+ {
+ "name": "Clusters"
+ },
+ {
+ "name": "Versions"
+ }
+ ]
+}
diff --git a/clients/manitou/output/orders.checkout.json b/clients/manitou/output/orders.checkout.json
new file mode 100644
index 0000000000..cd2f409d80
--- /dev/null
+++ b/clients/manitou/output/orders.checkout.json
@@ -0,0 +1,130 @@
+{
+ "openapi": "3.0.3",
+ "info": {
+ "title": "Orders API (Checkout)",
+ "description": "Each purchase a customer makes in your store generates an [order](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) on VTEX. With the Orders API, you can view orders statuses and manage multiple aspects involved in order fulfillment, such as financial transactions, invoicing, shipping, and subscriptions. You can also [modify orders](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) and make configurations to allow or forbid marketplaces and sellers to change or cancel orders.\r\n\r\n## Order integration\n\r\nTo automate actions related to order processing, you can [integrate orders](https://developers.vtex.com/docs/guides/erp-integration-guide) with systems like ERP (Enterprise Resource Planning) and WMS (Warehouse Management System) using [Feed and Hook](https://developers.vtex.com/docs/guides/orders-feed).\r\n\r\n## Orders API Index\r\n\r\n### Orders\r\n\r\n- `GET` [Get order](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders/-orderId-)\r\n- `GET` [Get orders by order group ID](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders/order-group/-orderGroup-)\r\n- `GET` [List orders](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders)\r\n- `POST` [Start handling order](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/start-handling)\r\n- `POST` [Cancel order](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/cancel)\r\n- `POST` [Register modifications on order](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/changes)\r\n\r\n### Order modifications\r\n\r\n- `PATCH` [Create order modifications](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes)\r\n- `POST` [Preview order modifications](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/order-system/orders/-changeOrderId-/changes/preview)\r\n- `GET`[Get order modifications details](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-)\r\n- `GET`[Get order modifications history](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes)\r\n- `GET` [Get order modifications summary](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/orders/pvt/document/-changeOrderId-/change-summary) \r\n- `POST` [Retry order modifications](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-/retry)\r\n- `POST`[Cancel order modifications](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-/cancel)\r\n- `PUT`[Update Order modifications settings](https://developers.vtex.com/docs/api-reference/orders-api#put-/api/order-system/orders/changes/settings)\r\n- `GET` [Get Order modifications settings](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/changes/settings)\r\n\r\n### Invoice\r\n\r\n- `POST` [Order invoice notification](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/invoice)\r\n- `PATCH` [Update order's partial invoice (send tracking number)](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-)\r\n\r\n### Tracking\r\n\r\n- `PUT` [Update order tracking status](https://developers.vtex.com/docs/api-reference/orders-api#put-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-/tracking)\r\n\r\n### Conversation\r\n\r\n- `GET` [Retrieve order conversation](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders/-orderId-/conversation-message)\r\n\r\n### Payment\r\n\r\n- `GET` [Retrieve payment transaction](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders/-orderId-/payment-transaction)\r\n- `POST` [Send payment notification](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/payments/-paymentId-/payment-notification)\r\n\r\n### Feed v2 (deprecated)\r\n\r\n- `GET` [Get feed order status](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/feed/orders/status)\r\n\r\n### Feed v3\r\n\r\n- `GET` [Get feed configuration](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/orders/feed/config)\r\n- `POST` [Create or update feed configuration](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/feed/config)\r\n- `DELETE` [Delete feed configuration](https://developers.vtex.com/docs/api-reference/orders-api#delete-/api/orders/feed/config)\r\n- `GET` [Retrieve feed items](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/orders/feed)\r\n- `POST` [Commit feed items](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/feed)\r\n- `POST` [Test JSONata expression](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/expressions/jsonata)\r\n\r\n### Order hook\r\n\r\n- `GET` [Get hook configuration](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/orders/hook/config)\r\n- `POST` [Create or update hook configuration](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/hook/config)\r\n- `DELETE` [Delete hook configuration](https://developers.vtex.com/docs/api-reference/orders-api#delete-/api/orders/hook/config)\r\n\r\n### User orders\r\n\r\n- `GET` [Retrieve user's orders](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/user/orders)\r\n- `GET` [Retrieve user order details](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/user/orders/-orderId-)\r\n\r\n### Change seller\r\n\r\n- `GET` [Get window to change seller](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/checkout/pvt/configuration/window-to-change-seller)\r\n- `POST` [Update window to change seller](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/checkout/pvt/configuration/window-to-change-seller)\r\n\r\n## Common parameters\r\n\r\n| **Parameter name** | **Description** | **Type** |\r\n| :---: | :--- | :--- |\r\n| `{{accountName}}` | Name of the VTEX account. Used as part of the URL. | Server variable. |\r\n| `{{environment}}` | Environment to use. Used as part of the URL. The default value is `vtexcommercestable`. | Server variable. |\r\n| `X-VTEX-API-AppKey` | Unique identifier of the [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys). | Authentication header. Must be used together with `X-VTEX-API-AppToken`. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `X-VTEX-API-AppToken` | Secret token of the [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys). | Authentication header. Must be used together with X-VTEX-API-AppKey. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `VtexIdclientAutCookie` | [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours. | Authentication header. Not necessary when using `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken`. |",
+ "contact": {},
+ "version": "1.0"
+ },
+ "servers": [
+ {
+ "url": "https://{accountName}.{environment}.com.br",
+ "description": "VTEX server URL.",
+ "variables": {
+ "accountName": {
+ "description": "Name of the VTEX account. Used as part of the URL.",
+ "default": "apiexamples"
+ },
+ "environment": {
+ "description": "Environment to use. Used as part of the URL.",
+ "enum": [
+ "vtexcommercestable"
+ ],
+ "default": "vtexcommercestable"
+ }
+ }
+ }
+ ],
+ "paths": {
+ "/api/checkout/pvt/configuration/window-to-change-seller": {
+ "get": {
+ "tags": [
+ "Change seller"
+ ],
+ "summary": "Get window to change seller",
+ "description": "Retrieves a marketplace's window to change seller, that is, the period when it is possible to choose another seller to fulfill a given order after the original seller has canceled it.\n\r\n\rThe default period for this window is of 2 days, but it can be configured by the request Update window to change seller.",
+ "operationId": "GetWindowToChangeSeller",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "integer",
+ "description": "Successful requests return the window to change seller value measured in days."
+ },
+ "example": 2
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Change seller"
+ ],
+ "summary": "Update window to change seller",
+ "description": "Updates a marketplace's window to change seller, that is, the period when it is possible to choose another seller to fulfill a given order after the original seller has canceled it.\n\r\n\rIt is possible to check the current window using the request Get window to change seller.\n\n> Requests with a body must be sent with `Content-Type: application/json`.",
+ "operationId": "UpdateWindowToChangeSeller",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "waitingTime"
+ ],
+ "properties": {
+ "waitingTime": {
+ "type": "integer",
+ "description": "Number of days after order cancelation by a seller, during which another seller may be assigned to fulfill the order.",
+ "example": 4
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "Created"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "appKey": [],
+ "appToken": []
+ },
+ {
+ "VtexIdclientAutCookie": []
+ }
+ ],
+ "tags": [
+ {
+ "name": "Orders"
+ },
+ {
+ "name": "Order modifications"
+ },
+ {
+ "name": "Invoice"
+ },
+ {
+ "name": "Tracking"
+ },
+ {
+ "name": "Conversation"
+ },
+ {
+ "name": "Payment"
+ },
+ {
+ "name": "Feed v2 (deprecated)"
+ },
+ {
+ "name": "Feed v3"
+ },
+ {
+ "name": "Order hook"
+ },
+ {
+ "name": "User orders"
+ },
+ {
+ "name": "Change seller"
+ }
+ ]
+}
diff --git a/clients/manitou/output/orders.oms.json b/clients/manitou/output/orders.oms.json
new file mode 100644
index 0000000000..a98e9453b6
--- /dev/null
+++ b/clients/manitou/output/orders.oms.json
@@ -0,0 +1,16342 @@
+{
+ "openapi": "3.0.3",
+ "info": {
+ "title": "Orders API (OMS)",
+ "description": "Each purchase a customer makes in your store generates an [order](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) on VTEX. With the Orders API, you can view orders statuses and manage multiple aspects involved in order fulfillment, such as financial transactions, invoicing, shipping, and subscriptions. You can also [modify orders](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) and make configurations to allow or forbid marketplaces and sellers to change or cancel orders.\r\n\r\n## Order integration\n\r\nTo automate actions related to order processing, you can [integrate orders](https://developers.vtex.com/docs/guides/erp-integration-guide) with systems like ERP (Enterprise Resource Planning) and WMS (Warehouse Management System) using [Feed and Hook](https://developers.vtex.com/docs/guides/orders-feed).\r\n\r\n## Orders API Index\r\n\r\n### Orders\r\n\r\n- `GET` [Get order](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders/-orderId-)\r\n- `GET` [Get orders by order group ID](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders/order-group/-orderGroup-)\r\n- `GET` [List orders](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders)\r\n- `POST` [Start handling order](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/start-handling)\r\n- `POST` [Cancel order](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/cancel)\r\n- `POST` [Register modifications on order](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/changes)\r\n\r\n### Order modifications\r\n\r\n- `PATCH` [Create order modifications](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes)\r\n- `POST` [Preview order modifications](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/order-system/orders/-changeOrderId-/changes/preview)\r\n- `GET`[Get order modifications details](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-)\r\n- `GET`[Get order modifications history](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes)\r\n- `GET` [Get order modifications summary](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/orders/pvt/document/-changeOrderId-/change-summary) \r\n- `POST` [Retry order modifications](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-/retry)\r\n- `POST`[Cancel order modifications](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-/cancel)\r\n- `PUT`[Update Order modifications settings](https://developers.vtex.com/docs/api-reference/orders-api#put-/api/order-system/orders/changes/settings)\r\n- `GET` [Get Order modifications settings](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/changes/settings)\r\n\r\n### Invoice\r\n\r\n- `POST` [Order invoice notification](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/invoice)\r\n- `PATCH` [Update order's partial invoice (send tracking number)](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-)\r\n\r\n### Tracking\r\n\r\n- `PUT` [Update order tracking status](https://developers.vtex.com/docs/api-reference/orders-api#put-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-/tracking)\r\n\r\n### Conversation\r\n\r\n- `GET` [Retrieve order conversation](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders/-orderId-/conversation-message)\r\n\r\n### Payment\r\n\r\n- `GET` [Retrieve payment transaction](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders/-orderId-/payment-transaction)\r\n- `POST` [Send payment notification](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/payments/-paymentId-/payment-notification)\r\n\r\n### Feed v2 (deprecated)\r\n\r\n- `GET` [Get feed order status](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/feed/orders/status)\r\n\r\n### Feed v3\r\n\r\n- `GET` [Get feed configuration](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/orders/feed/config)\r\n- `POST` [Create or update feed configuration](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/feed/config)\r\n- `DELETE` [Delete feed configuration](https://developers.vtex.com/docs/api-reference/orders-api#delete-/api/orders/feed/config)\r\n- `GET` [Retrieve feed items](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/orders/feed)\r\n- `POST` [Commit feed items](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/feed)\r\n- `POST` [Test JSONata expression](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/expressions/jsonata)\r\n\r\n### Order hook\r\n\r\n- `GET` [Get hook configuration](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/orders/hook/config)\r\n- `POST` [Create or update hook configuration](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/hook/config)\r\n- `DELETE` [Delete hook configuration](https://developers.vtex.com/docs/api-reference/orders-api#delete-/api/orders/hook/config)\r\n\r\n### User orders\r\n\r\n- `GET` [Retrieve user's orders](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/user/orders)\r\n- `GET` [Retrieve user order details](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/user/orders/-orderId-)\r\n\r\n### Change seller\r\n\r\n- `GET` [Get window to change seller](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/checkout/pvt/configuration/window-to-change-seller)\r\n- `POST` [Update window to change seller](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/checkout/pvt/configuration/window-to-change-seller)\r\n\r\n## Common parameters\r\n\r\n| **Parameter name** | **Description** | **Type** |\r\n| :---: | :--- | :--- |\r\n| `{{accountName}}` | Name of the VTEX account. Used as part of the URL. | Server variable. |\r\n| `{{environment}}` | Environment to use. Used as part of the URL. The default value is `vtexcommercestable`. | Server variable. |\r\n| `X-VTEX-API-AppKey` | Unique identifier of the [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys). | Authentication header. Must be used together with `X-VTEX-API-AppToken`. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `X-VTEX-API-AppToken` | Secret token of the [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys). | Authentication header. Must be used together with X-VTEX-API-AppKey. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `VtexIdclientAutCookie` | [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours. | Authentication header. Not necessary when using `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken`. |",
+ "contact": {},
+ "version": "1.0"
+ },
+ "servers": [
+ {
+ "url": "https://{accountName}.{environment}.com.br",
+ "description": "VTEX server URL.",
+ "variables": {
+ "accountName": {
+ "description": "Name of the VTEX account. Used as part of the URL.",
+ "default": "apiexamples"
+ },
+ "environment": {
+ "description": "Environment to use. Used as part of the URL.",
+ "enum": [
+ "vtexcommercestable"
+ ],
+ "default": "vtexcommercestable"
+ }
+ }
+ }
+ ],
+ "paths": {
+ "/api/oms/pvt/orders/{orderId}": {
+ "get": {
+ "tags": [
+ "Orders"
+ ],
+ "summary": "Get order",
+ "description": "Retrieves order details by searching by order ID or sequence number.\r\n\r\n>⚠️ Throttling: Each VTEX account can make up to 6000 requests per minute.\r\n\r\n> You can only access information from orders created in the last two years, and that same period is valid for customers through [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh).\r\n\r\n>Check the [Orders onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/orders-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Orders and is organized by focusing on the developer's journey.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **View order** |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | View order |\r\n| Checkout Admin | View order |\r\n| IntegrationProfile - Fulfillment Oms | View order |\r\n| OMS - Full access | Orders Full Access |\r\n| Checkout Admin | Orders Full Access |\r\n| IntegrationProfile - Fulfillment Oms | Orders Full Access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+ "operationId": "GetOrder",
+ "parameters": [
+ {
+ "name": "orderId",
+ "in": "path",
+ "description": "Order ID is a unique code that identifies an order. Instead of using `orderId`, you can also make the request using the sequence, a six-digit string that follows the order ID. For example, in order 1268540501456-01 (501456), the sequence is 501456. To use this parameter, replace the value between `{ }` keys in `seq{sequence-number}` with the sequence. For example: `seq501456`.",
+ "example": "1172452900788-01 or seq501456",
+ "required": true,
+ "style": "simple",
+ "schema": {
+ "type": "string",
+ "example": "1172452900788-01 or seq501456"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "orderId": {
+ "type": "string",
+ "description": "Order ID."
+ },
+ "sequence": {
+ "type": "string",
+ "description": "Sequence number part of the order ID. For example, in order `v70530116str-01`, the sequence is `70530116`."
+ },
+ "marketplaceOrderId": {
+ "type": "string",
+ "description": "Marketplace order ID."
+ },
+ "marketplaceServicesEndpoint": {
+ "type": "string",
+ "description": "Endpoint provided by the marketplace for post purchase communication."
+ },
+ "sellerOrderId": {
+ "type": "string",
+ "description": "Seller order ID."
+ },
+ "origin": {
+ "type": "string",
+ "description": "Order's [origin in the order flow](https://developers.vtex.com/docs/guides/orders-overview#understanding-order-flow-types).",
+ "enum": [
+ "Marketplace",
+ "Fulfillment",
+ "Chain"
+ ]
+ },
+ "affiliateId": {
+ "type": "string",
+ "description": "Three-letter [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) code configured by the seller to identify a marketplace."
+ },
+ "salesChannel": {
+ "type": "string",
+ "description": "Sales channel (or [trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID related to the order."
+ },
+ "merchantName": {
+ "type": "string",
+ "description": "For a VTEX store, the merchant's name will be the same as the account name. An external seller can have a `merchantName`, but it will not be an account name.",
+ "nullable": true
+ },
+ "status": {
+ "type": "string",
+ "description": "[Order status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) in the workflow."
+ },
+ "workflowIsInError": {
+ "type": "boolean",
+ "description": "Indicates if the order processing in the workflow presents an error that cannot be solved by automatic retry (`true`), or if there are no processing errors (`false`)."
+ },
+ "statusDescription": {
+ "type": "string",
+ "description": "Status description displayed on the VTEX Admin. This field is obsolete and may not return any value.",
+ "deprecated": true
+ },
+ "value": {
+ "type": "integer",
+ "description": "Order total value in cents."
+ },
+ "creationDate": {
+ "type": "string",
+ "description": "Order creation date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`."
+ },
+ "lastChange": {
+ "type": "string",
+ "description": "Order last change date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`."
+ },
+ "orderGroup": {
+ "type": "string",
+ "description": "Order group ID, a segment of the order ID that groups all orders related to the same purchase. For example, in the order ID `v71021570str-02`), the order group ID is `v71021570str`."
+ },
+ "followUpEmail": {
+ "type": "string",
+ "description": "Email of the store employee responsible for managing the order."
+ },
+ "lastMessage": {
+ "type": "string",
+ "nullable": true,
+ "description": "Last transactional message sent to the customer."
+ },
+ "hostname": {
+ "type": "string",
+ "description": "Main [account name](https://help.vtex.com/en/tutorial/what-is-an-account-name--i0mIGLcg3QyEy8OCicEoC)."
+ },
+ "isCompleted": {
+ "type": "boolean",
+ "description": "Defines if the order payment has been settled (`true`) or not (`false`)."
+ },
+ "roundingError": {
+ "type": "integer",
+ "description": "Rounding error total value in cents, when applicable. For example, in orders with discounts on non-integer multiplier items, rounding is applied per item, not after the sum of all items, which can result in a difference in the total discount value."
+ },
+ "orderFormId": {
+ "type": "string",
+ "description": "Unique identifier of the [orderForm](https://developers.vtex.com/docs/guides/orderform-fields)."
+ },
+ "allowCancellation": {
+ "type": "boolean",
+ "description": "Defines if order cancellation is allowed (`true`) or not anymore (`false`)."
+ },
+ "allowEdition": {
+ "type": "boolean",
+ "description": "Defines if the order can be edited (`true`) or not anymore (`false`)."
+ },
+ "isCheckedIn": {
+ "type": "boolean",
+ "description": "Defines if the order was placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) (`true`) or not (`false`)."
+ },
+ "authorizedDate": {
+ "type": "string",
+ "description": "Order authorization date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.",
+ "nullable": true
+ },
+ "invoicedDate": {
+ "type": "string",
+ "nullable": true,
+ "description": "Order invoice date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`."
+ },
+ "cancelReason": {
+ "type": "string",
+ "description": "Reason for order cancellation.",
+ "nullable": true
+ },
+ "checkedInPickupPointId": {
+ "type": "string",
+ "description": "When the order is created at a physical store which is configured as a pickup point, this field retrieves the pickup point ID.",
+ "nullable": true
+ },
+ "totals": {
+ "$ref": "#/components/schemas/TotalsUpdated"
+ },
+ "sellers": {
+ "$ref": "#/components/schemas/SellersUpdated"
+ },
+ "clientPreferencesData": {
+ "$ref": "#/components/schemas/ClientPreferencesDataUpdated"
+ },
+ "cancellationData": {
+ "type": "object",
+ "description": "Information about [order cancellation](https://developers.vtex.com/docs/guides/order-canceling-improvements), when applicable.",
+ "properties": {
+ "RequestedByUser": {
+ "type": "boolean",
+ "description": "Indicates if the order cancellation was requested by the customer (`true`) or not (`false`).",
+ "nullable": true
+ },
+ "RequestedBySystem": {
+ "type": "boolean",
+ "description": "Indicates if the order cancellation was made by the system (`true`) or not (`false`). This type of order cancellation happens in [incomplete orders](https://help.vtex.com/en/tutorial/how-incomplete-orders-work--tutorials_294), for example.",
+ "nullable": true
+ },
+ "RequestedBySellerNotification": {
+ "type": "boolean",
+ "description": "Indicates if the order cancellation was requested by the seller (`true`) or not (`false`).",
+ "nullable": true
+ },
+ "RequestedByPaymentNotification": {
+ "type": "boolean",
+ "description": "Indicates if the order cancellation was requested by the payment gateway (`true`) or not (`false`).",
+ "nullable": true
+ },
+ "Reason": {
+ "type": "string",
+ "description": "Reason why the order was canceled.",
+ "nullable": true
+ },
+ "CancellationDate": {
+ "type": "string",
+ "description": "Order cancellation date in [UTC ISO 8601 format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.",
+ "nullable": true
+ }
+ },
+ "nullable": true
+ },
+ "taxData": {
+ "$ref": "#/components/schemas/TaxDataUpdated"
+ },
+ "subscriptionData": {
+ "type": "object",
+ "description": "Information about [subscriptions](https://help.vtex.com/tutorial/how-subscriptions-work--frequentlyAskedQuestions_4453), when applicable.",
+ "nullable": true,
+ "properties": {
+ "SubscriptionGroupId": {
+ "type": "string",
+ "description": "ID of the subscription group. If this field returns `null` and the `ExecutionCount` is `0`, the order is the first creating the subscription.",
+ "nullable": true
+ },
+ "Subscriptions": {
+ "type": "array",
+ "description": "List with subscriptions details.",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "description": "Subscription details.",
+ "properties": {
+ "ExecutionCount": {
+ "type": "integer",
+ "description": "Position of the order in the subscription cycle. The first order will have the value `0`, the second will have the value `1`, and so on."
+ },
+ "PriceAtSubscriptionDate": {
+ "type": "number",
+ "description": "Value of the order when the customer signed up for subscriptions. Subscriptions created via Admin or APIs do not have an original order, so the field returns `0.0`. This field was valid only for Subscriptions v2 and is deprecated in Subscriptions v3.",
+ "nullable": true,
+ "deprecated": true
+ },
+ "ItemIndex": {
+ "type": "integer",
+ "description": "Each item in the subscription order is identified by an index. The position starts in `0`, followed by `1`, `2`, and so on."
+ },
+ "Plan": {
+ "type": "object",
+ "description": "Information about the [subscription plan](https://help.vtex.com/en/tutorial/subscription-plans-beta--5kczKRqHEsrs1tYtRcY8wR).",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "Type of plan."
+ },
+ "frequency": {
+ "type": "object",
+ "description": "Information about the subscription recurrence.",
+ "properties": {
+ "periodicity": {
+ "type": "string",
+ "description": "Defines the subscription recurrence period.",
+ "enum": [
+ "DAY",
+ "WEEK",
+ "MONTH",
+ "YEAR"
+ ]
+ },
+ "interval": {
+ "type": "integer",
+ "description": "Time interval configured between subscription orders, which depends on the `periodicity` field. For a `DAY` periodicity, this value will correspond to days, for `MONTH` to months, and so on."
+ }
+ }
+ },
+ "validity": {
+ "type": "object",
+ "description": "Information about the period during which the subscription will be valid.",
+ "properties": {
+ "begin": {
+ "type": "string",
+ "description": "Subscription beginning date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`."
+ },
+ "end": {
+ "type": "string",
+ "description": "Subscription end date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.",
+ "nullable": true
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "itemMetadata": {
+ "type": "object",
+ "description": "Metadata information about the order's items.",
+ "properties": {
+ "Items": {
+ "type": "array",
+ "description": "List of order items' metadata.",
+ "items": {
+ "type": "object",
+ "description": "Order item metadata.",
+ "properties": {
+ "Id": {
+ "type": "string",
+ "description": "Unique numerical identifier of the SKU."
+ },
+ "Seller": {
+ "type": "string",
+ "description": "Unique identifier of the SKU seller."
+ },
+ "Name": {
+ "type": "string",
+ "description": "Name of the item as displayed to customers in the storefront."
+ },
+ "SkuName": {
+ "type": "string",
+ "description": "Name of the SKU corresponding to the item."
+ },
+ "ProductId": {
+ "type": "string",
+ "description": "ID of the product associated with the item."
+ },
+ "RefId": {
+ "type": "string",
+ "description": "SKU reference ID."
+ },
+ "Ean": {
+ "type": "string",
+ "description": "SKU EAN."
+ },
+ "ImageUrl": {
+ "type": "string",
+ "description": "SKU image URL."
+ },
+ "DetailUrl": {
+ "type": "string",
+ "description": "SKU slug."
+ },
+ "AssemblyOptions": {
+ "type": "array",
+ "description": "[Assembly options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH) information related to the item, if there are any.",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "description": "[Assembly option](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH) details.",
+ "properties": {
+ "Id": {
+ "type": "string",
+ "description": "Assembly option ID."
+ },
+ "Name": {
+ "type": "string",
+ "description": "Assembly option name."
+ },
+ "Required": {
+ "type": "boolean",
+ "description": "If this field is set as `true`, when the customer purchases the item sending the attachment is required, and when set as `false`, sending the attachment is optional."
+ },
+ "InputValues": {
+ "type": "object",
+ "description": "Assembly option content.",
+ "additionalProperties": true,
+ "nullable": true
+ },
+ "Composition": {
+ "type": "object",
+ "description": "Assembly option composition.",
+ "additionalProperties": true,
+ "nullable": true
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "marketplace": {
+ "$ref": "#/components/schemas/MarketplaceUpdated"
+ },
+ "storePreferencesData": {
+ "$ref": "#/components/schemas/StorePreferencesDataUpdated"
+ },
+ "customData": {
+ "type": "object",
+ "description": "[Customizable fields](https://developers.vtex.com/docs/guides/add-and-handle-custom-information-in-the-order) created by the store for the shopping cart. This field is useful for storing data not included in other fields. For example, a message for a gift or a name to be printed in a shirt.",
+ "nullable": true,
+ "properties": {
+ "customApps": {
+ "type": "array",
+ "description": "Customizable apps created by the store.",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "description": "Customizable apps details.",
+ "nullable": true,
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Integration marketplace identifier."
+ },
+ "major": {
+ "type": "integer",
+ "description": "Major version of the app."
+ },
+ "fields": {
+ "type": "object",
+ "description": "Fields related to the marketplace payment.",
+ "properties": {
+ "marketplacePaymentCnpjAcquirers": {
+ "type": "string",
+ "description": "CNPJ of the marketplace payment acquirers."
+ },
+ "marketplacePaymentAuthorizationCodes": {
+ "type": "string",
+ "description": "Authorization codes for marketplace payment."
+ },
+ "marketplacePaymentCreditCardBrands": {
+ "type": "string",
+ "description": "Credit card brands for marketplace payment."
+ },
+ "marketplacePaymentMethods": {
+ "type": "string",
+ "description": "Payment methods for marketplace payment."
+ }
+ }
+ }
+ }
+ }
+ },
+ "customFields": {
+ "type": "array",
+ "description": "Array with information about the custom fields.",
+ "items": {
+ "type": "object",
+ "description": "Object with information about the custom fields.",
+ "properties": {
+ "linkedEntity": {
+ "type": "object",
+ "description": "Linked entity information.",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "Type of the linked entity such as `cart`, `item`, `address`."
+ },
+ "id": {
+ "type": "string",
+ "description": "ID of the linked entity."
+ }
+ }
+ },
+ "fields": {
+ "type": "array",
+ "description": "Array with information about the custom field's name and value.",
+ "items": {
+ "type": "object",
+ "description": "Custom field's name and value.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Name of the custom field."
+ },
+ "value": {
+ "type": "string",
+ "description": "Value of the custom field."
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "commercialConditionData": {
+ "type": "string",
+ "nullable": true,
+ "description": "Information about commercial conditions."
+ },
+ "openTextField": {
+ "type": "object",
+ "description": "Optional field for additional information.",
+ "nullable": true,
+ "additionalProperties": {
+ "type": "string",
+ "description": "Additional information."
+ }
+ },
+ "invoiceData": {
+ "$ref": "#/components/schemas/InvoiceDataUpdated"
+ },
+ "changesAttachment": {
+ "$ref": "#/components/schemas/ChangesAttachmentUpdated"
+ },
+ "callCenterOperatorData": {
+ "$ref": "#/components/schemas/CallCenterOperatorDataUpdated"
+ },
+ "packageAttachment": {
+ "type": "object",
+ "description": "Information about shipping packages, created after order invoicing.",
+ "nullable": true,
+ "properties": {
+ "packages": {
+ "type": "array",
+ "description": "List with packages' information.",
+ "items": {
+ "type": "object",
+ "description": "Package details.",
+ "properties": {
+ "items": {
+ "type": "array",
+ "description": "Information about package items.",
+ "items": {
+ "type": "object",
+ "description": "Package item details.",
+ "properties": {
+ "itemIndex": {
+ "type": "integer",
+ "description": "Package item index nunmber."
+ },
+ "quantity": {
+ "type": "integer",
+ "description": "Package item quantity."
+ },
+ "price": {
+ "type": "integer",
+ "description": "Package item price in cents."
+ },
+ "description": {
+ "type": "string",
+ "description": "Package item description.",
+ "nullable": true
+ },
+ "unitMultiplier": {
+ "type": "number",
+ "description": "Package item unit multiplier.",
+ "nullable": true
+ }
+ }
+ }
+ },
+ "courier": {
+ "type": "string",
+ "description": "Name of the [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) responsible for the package shipping.",
+ "nullable": true
+ },
+ "invoiceNumber": {
+ "type": "string",
+ "description": "Unique identification code of the package invoice."
+ },
+ "invoiceValue": {
+ "type": "integer",
+ "description": "Package invoice value in cents."
+ },
+ "invoiceUrl": {
+ "type": "string",
+ "description": "Package invoice URL.",
+ "nullable": true
+ },
+ "issuanceDate": {
+ "type": "string",
+ "description": "Package invoice issuance date in [ISO 8601 time zone offset format](https://learn.microsoft.com/pt-br/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DD hh:mm:ss[.nnnnnnn]+hh:mm`."
+ },
+ "trackingNumber": {
+ "type": "string",
+ "description": "Package [tracking number](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-).",
+ "nullable": true
+ },
+ "invoiceKey": {
+ "type": "string",
+ "description": "Package invoice key.",
+ "nullable": true
+ },
+ "trackingUrl": {
+ "type": "string",
+ "description": "Package tracking URL.",
+ "nullable": true
+ },
+ "embeddedInvoice": {
+ "type": "string",
+ "description": "Package invoice text in [xml format](https://help.vtex.com/en/tutorial/configuring-xml--tutorials_242). This field is important for stores integrated with [external marketplaces](https://developers.vtex.com/docs/guides/external-marketplace-integration-guide)."
+ },
+ "type": {
+ "type": "string",
+ "description": "Package invoice type, which can be:\r\n- `Output`: Selling order invoice.\r\n- `Input`: Returning items invoice.",
+ "enum": [
+ "Output",
+ "Input"
+ ]
+ },
+ "courierStatus": {
+ "type": "object",
+ "description": "[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) package shipping information.",
+ "nullable": true,
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "Defines if a carrier was assigned for order shipping (`ok`) or not (`null`).",
+ "nullable": true
+ },
+ "finished": {
+ "type": "boolean",
+ "description": "Defines if the carrier has already delivered the package (`true`) or not (`false`)."
+ },
+ "deliveredDate": {
+ "type": "string",
+ "description": "Package delivery date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DD hh:mm:ss[.nnnnnnn]+hh:mm`."
+ },
+ "data": {
+ "type": "array",
+ "description": "Package tracking information.",
+ "items": {
+ "type": "object",
+ "description": "Package tracking details.",
+ "properties": {
+ "lastChange": {
+ "type": "string",
+ "description": "Package tracking date since last update in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DD hh:mm:ss[.nnnnnnn]+hh:mm`."
+ },
+ "city": {
+ "type": "string",
+ "description": "Package current tracking city."
+ },
+ "state": {
+ "type": "string",
+ "description": "Package current tracking state in two-digit code format."
+ },
+ "description": {
+ "type": "string",
+ "description": "Package tracking description."
+ },
+ "createDate": {
+ "type": "string",
+ "description": "Package tracking creation date in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DD hh:mm:ss[.nnnnnnn]+hh:mm`."
+ }
+ }
+ }
+ }
+ }
+ },
+ "cfop": {
+ "type": "string",
+ "description": "[CFOP](https://www.gov.br/receitafederal/pt-br/acesso-a-informacao/acoes-e-programas/facilitacao/anexo-ecf-cfop) (_Código Fiscal de Operação e Prestação_) is a Brazilian fiscal code of operations and services that classifies business transactions types.",
+ "nullable": true
+ },
+ "restitutions": {
+ "type": "object",
+ "description": "Information about a value being returned to the customer. This field applies only to invoices with the `Input` type because it relates to returning items.",
+ "properties": {
+ "Refund": {
+ "type": "object",
+ "description": "Customer refund details.",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "description": "Refund value in cents."
+ },
+ "giftCardData": {
+ "type": "string",
+ "description": "Refund involving [Gift Card](https://developers.vtex.com/docs/guides/gift-card-integration-guide).",
+ "nullable": true
+ },
+ "items": {
+ "type": "array",
+ "description": "Information about the items being returned.",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "description": "Returned item details.",
+ "properties": {
+ "useFreight": {
+ "type": "boolean",
+ "description": "Defines if the refund includes freight values (`true`) or not (`false`).",
+ "nullable": true
+ },
+ "isCompensation": {
+ "type": "boolean",
+ "description": "Defines if there are compensated unit tags in the package (`true`) or not (`false`)."
+ },
+ "compensationValue": {
+ "type": "integer",
+ "description": "Compensational refund value in cents."
+ },
+ "id": {
+ "type": "string",
+ "description": "SKU unique identification code of the returned item."
+ },
+ "quantity": {
+ "type": "integer",
+ "description": "Number of items being returned."
+ },
+ "price": {
+ "type": "integer",
+ "description": "Returned item price in cents."
+ },
+ "description": {
+ "type": "string",
+ "description": "Customer reason for returning the item."
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "volumes": {
+ "type": "integer",
+ "description": "Indicates the number of boxes (volumes) needed to contain the package items. For example, two refrigerators do not fit in a single volume, so this field would have value `2`."
+ },
+ "EnableInferItems": {
+ "type": "boolean",
+ "description": "Defines if the package items' value should be inferred by the invoice value (`true`) or not (`false`).",
+ "nullable": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "paymentData": {
+ "$ref": "#/components/schemas/PaymentDataUpdated"
+ },
+ "shippingData": {
+ "type": "object",
+ "description": "Shipping information.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Object ID, the expected value is `shippingData`."
+ },
+ "address": {
+ "type": "object",
+ "description": "Shipping address details.",
+ "properties": {
+ "addressType": {
+ "type": "string",
+ "description": "Type of address. For example, `residential` or `pickup`."
+ },
+ "receiverName": {
+ "type": "string",
+ "description": "Full name of the order receiver."
+ },
+ "addressId": {
+ "type": "string",
+ "description": "Shipping address ID."
+ },
+ "versionId": {
+ "type": "string",
+ "description": "Shipping address version ID.",
+ "nullable": true
+ },
+ "entityId": {
+ "type": "string",
+ "description": "Shipping address entity ID.",
+ "nullable": true
+ },
+ "postalCode": {
+ "type": "string",
+ "description": "Shipping address postal code."
+ },
+ "city": {
+ "type": "string",
+ "description": "Shipping address city."
+ },
+ "state": {
+ "type": "string",
+ "description": "Shipping address state/province."
+ },
+ "country": {
+ "type": "string",
+ "description": "Shipping address three-digit country code in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format."
+ },
+ "street": {
+ "type": "string",
+ "description": "Shipping address street."
+ },
+ "number": {
+ "type": "string",
+ "description": "Shipping address number."
+ },
+ "neighborhood": {
+ "type": "string",
+ "description": "Shipping address neighborhood."
+ },
+ "complement": {
+ "type": "string",
+ "description": "Shipping address complement."
+ },
+ "reference": {
+ "type": "string",
+ "nullable": true,
+ "description": "Shipping address additional information."
+ },
+ "geoCoordinates": {
+ "type": "array",
+ "description": "Pair of geocoordinates, first longitude then latitude.",
+ "items": {
+ "type": "number",
+ "description": "Longitude and latitude."
+ }
+ }
+ }
+ },
+ "logisticsInfo": {
+ "type": "array",
+ "description": "Array of objects containing item's logistics information.",
+ "items": {
+ "type": "object",
+ "description": "Logistics information.",
+ "properties": {
+ "itemIndex": {
+ "type": "integer",
+ "description": "Index of the item starting from 0."
+ },
+ "selectedSla": {
+ "type": "string",
+ "description": "Selected shipping option."
+ },
+ "lockTTL": {
+ "type": "string",
+ "description": "Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time."
+ },
+ "price": {
+ "type": "integer",
+ "description": "Shipping price for the item in cents. Does not account for the whole order's shipping price."
+ },
+ "listPrice": {
+ "type": "integer",
+ "description": "Original shipping price for the item in cents."
+ },
+ "sellingPrice": {
+ "type": "integer",
+ "description": "Item's selling price."
+ },
+ "deliveryWindow": {
+ "type": "string",
+ "nullable": true,
+ "description": "[Scheduled delivery](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) window information, if it applies to the item."
+ },
+ "deliveryCompany": {
+ "type": "string",
+ "description": "[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) company's name."
+ },
+ "shippingEstimate": {
+ "type": "string",
+ "description": "Total shipping estimate time in days. For instance, three business days is represented `3bd`."
+ },
+ "shippingEstimateDate": {
+ "type": "string",
+ "description": "Shipping estimate date, defined after the confirmation of the order."
+ },
+ "slas": {
+ "type": "array",
+ "description": "Service Level Agreement (SLA) corresponding to [shipping policies](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).",
+ "items": {
+ "type": "object",
+ "description": "Order shipping SLA details.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "ID of the shipping method used in the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140)."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the shipping policy."
+ },
+ "shippingEstimate": {
+ "type": "string",
+ "description": "Total shipping estimate time in days. For instance, three business days is represented `3bd`."
+ },
+ "deliveryWindow": {
+ "type": "string",
+ "nullable": true,
+ "description": "[Scheduled delivery window](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, if it applies to the item."
+ },
+ "price": {
+ "type": "integer",
+ "description": "Shipping price for the item in cents. Does not account for the whole order's shipping price."
+ },
+ "selectedDeliveryChannel": {
+ "type": "string",
+ "description": "Defines if the delivery channel is `delivery` or `pickup-in-point`."
+ },
+ "pickupStoreInfo": {
+ "type": "object",
+ "description": "Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).",
+ "properties": {
+ "additionalInfo": {
+ "type": "string",
+ "nullable": true,
+ "description": "Additional information about the pickup point."
+ },
+ "address": {
+ "type": "object",
+ "nullable": true,
+ "description": "Pickup point address details.",
+ "properties": {
+ "addressType": {
+ "type": "string",
+ "description": "Type of address. For example, `residential` or `pickup`.",
+ "nullable": true
+ },
+ "receiverName": {
+ "type": "string",
+ "description": "Full name of the order receiver.",
+ "nullable": true
+ },
+ "addressId": {
+ "type": "string",
+ "description": "Pickup point address ID.",
+ "nullable": true
+ },
+ "versionId": {
+ "type": "string",
+ "description": "Pickup point address version ID.",
+ "nullable": true
+ },
+ "entityId": {
+ "type": "string",
+ "description": "Pickup point address entity ID.",
+ "nullable": true
+ },
+ "postalCode": {
+ "type": "string",
+ "description": " Pickup point postal code.",
+ "nullable": true
+ },
+ "city": {
+ "type": "string",
+ "description": "Pickup point address city.",
+ "nullable": true
+ },
+ "state": {
+ "type": "string",
+ "description": "Pickup point address state/province.",
+ "nullable": true
+ },
+ "country": {
+ "type": "string",
+ "description": "Pickup point address three-digit country code in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.",
+ "nullable": true
+ },
+ "street": {
+ "type": "string",
+ "description": "Pickup point address street.",
+ "nullable": true
+ },
+ "number": {
+ "type": "string",
+ "description": "Pickup point address number.",
+ "nullable": true
+ },
+ "neighborhood": {
+ "type": "string",
+ "description": "Pickup point address neighborhood.",
+ "nullable": true
+ },
+ "complement": {
+ "type": "string",
+ "description": "Pickup point address complement.",
+ "nullable": true
+ },
+ "reference": {
+ "type": "string",
+ "description": "Pickup point address additional information.",
+ "nullable": true
+ },
+ "geoCoordinates": {
+ "type": "array",
+ "description": "Pair of geocoordinates, first longitude then latitude.",
+ "nullable": true,
+ "items": {
+ "type": "number",
+ "description": "Longitude and latitude.",
+ "nullable": true
+ }
+ }
+ }
+ },
+ "dockId": {
+ "type": "string",
+ "nullable": true,
+ "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID related to the delivery or the pickup point."
+ },
+ "friendlyName": {
+ "type": "string",
+ "nullable": true,
+ "description": "Name of the pickup point displayed at checkout."
+ },
+ "isPickupStore": {
+ "type": "boolean",
+ "description": "Defines if the type of shipping is pickup (`true`) or not (`false`)."
+ }
+ }
+ },
+ "polygonName": {
+ "type": "string",
+ "nullable": true,
+ "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy."
+ },
+ "lockTTL": {
+ "type": "string",
+ "description": "Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA."
+ },
+ "pickupPointId": {
+ "type": "string",
+ "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID related to the SLA."
+ },
+ "transitTime": {
+ "type": "string",
+ "description": "Duration in business days of the time the carrier takes in transit to fulfill the order. For example, three business days is represented `3bd`."
+ },
+ "pickupDistance": {
+ "type": "number",
+ "description": "Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line."
+ }
+ }
+ }
+ },
+ "shipsTo": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "description": "Three-digit country code of the shipping address in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format."
+ },
+ "description": "List of countries of the shipping address."
+ },
+ "deliveryIds": {
+ "type": "array",
+ "description": "Information about delivery IDs.",
+ "items": {
+ "type": "object",
+ "description": "Delivery IDs.",
+ "properties": {
+ "courierId": {
+ "type": "string",
+ "description": "[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE)'s ID."
+ },
+ "courierName": {
+ "type": "string",
+ "description": "Carrier's name."
+ },
+ "dockId": {
+ "type": "string",
+ "description": "ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj)."
+ },
+ "quantity": {
+ "type": "integer",
+ "description": "Quantity of items."
+ },
+ "warehouseId": {
+ "type": "string",
+ "description": "ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb)."
+ },
+ "accountCarrierName": {
+ "type": "string",
+ "description": "Name of the account's [carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE)."
+ },
+ "kitItemDetails": {
+ "type": "array",
+ "description": "Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), if there are any.",
+ "nullable": true,
+ "items": {
+ "type": "string",
+ "description": "Kits information."
+ }
+ }
+ }
+ }
+ },
+ "deliveryChannels": {
+ "type": "array",
+ "description": "List of delivery channels associated with the trade policy.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Delivery channel's shipping type, which can be `delivery` or `pickup-in-point`."
+ },
+ "stockBalance": {
+ "type": "integer",
+ "description": "Stock check for an SKU availability."
+ }
+ },
+ "description": "Delivery channels information."
+ }
+ },
+ "selectedDeliveryChannel": {
+ "type": "string",
+ "description": "Defines if the delivery channel is `delivery` or `pickup-in-point`."
+ },
+ "pickupStoreInfo": {
+ "type": "object",
+ "description": "Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).",
+ "properties": {
+ "additionalInfo": {
+ "type": "string",
+ "nullable": true,
+ "description": "Additional information about the pickup point."
+ },
+ "address": {
+ "type": "string",
+ "nullable": true,
+ "description": "Pickup point's address."
+ },
+ "dockId": {
+ "type": "string",
+ "nullable": true,
+ "description": "ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj) related to the delivery or the pickup point."
+ },
+ "friendlyName": {
+ "type": "string",
+ "nullable": true,
+ "description": "Name of the pickup point displayed at checkout."
+ },
+ "isPickupStore": {
+ "type": "boolean",
+ "description": "Defines if the type of shipping is pickup (`true`) or not (`false`)."
+ }
+ },
+ "nullable": true
+ },
+ "addressId": {
+ "type": "string",
+ "description": "Address ID.",
+ "nullable": true
+ },
+ "versionId": {
+ "type": "string",
+ "description": "Shipping address version ID.",
+ "nullable": true
+ },
+ "entityId": {
+ "type": "string",
+ "description": "Shipping address entity ID.",
+ "nullable": true
+ },
+ "polygonName": {
+ "type": "string",
+ "nullable": true,
+ "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy."
+ },
+ "pickupPointId": {
+ "type": "string",
+ "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R)'s ID.",
+ "nullable": true
+ },
+ "transitTime": {
+ "type": "string",
+ "description": "Duration in business days of the time the carrier takes in transit to fulfill the order. For example, three business days is represented `3bd`.",
+ "nullable": true
+ }
+ }
+ }
+ },
+ "trackingHints": {
+ "type": "array",
+ "description": "List containing order shipping label information.",
+ "items": {
+ "type": "object",
+ "description": "Shipping label information.",
+ "properties": {
+ "trackingId": {
+ "type": "string",
+ "description": "Tracking ID."
+ },
+ "courierName": {
+ "type": "string",
+ "description": "[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) name."
+ },
+ "trackingUrl": {
+ "type": "string",
+ "description": "Tracking URL."
+ },
+ "trackingLabel": {
+ "type": "string",
+ "description": "Tracking label."
+ }
+ }
+ },
+ "nullable": true
+ },
+ "selectedAddresses": {
+ "type": "array",
+ "description": "Information about selected adresses.",
+ "items": {
+ "type": "object",
+ "description": "Selected adresses.",
+ "properties": {
+ "addressId": {
+ "type": "string",
+ "description": "Selected address ID."
+ },
+ "versionId": {
+ "type": "string",
+ "description": "Shipping address version ID of the selected address.",
+ "nullable": true
+ },
+ "entityId": {
+ "type": "string",
+ "description": "Shipping address entity ID of the selected address.",
+ "nullable": true
+ },
+ "addressType": {
+ "type": "string",
+ "description": "Selected adress's shipping type, which can be `pickup`, `residential`, `invoice`, `search`, `inStore`, `commercial` or `giftRegistry`."
+ },
+ "receiverName": {
+ "type": "string",
+ "description": "Full name of the person who is going to receive the order in the selected address."
+ },
+ "street": {
+ "type": "string",
+ "description": "Street of the selected address."
+ },
+ "number": {
+ "type": "string",
+ "description": "Number of the building, house or apartment of the selected address."
+ },
+ "complement": {
+ "type": "string",
+ "description": "Complement to the selected address if it applies."
+ },
+ "neighborhood": {
+ "type": "string",
+ "description": "Neighborhood of the selected address."
+ },
+ "postalCode": {
+ "type": "string",
+ "description": "Postal code of the selected address."
+ },
+ "city": {
+ "type": "string",
+ "description": "City of the selected address."
+ },
+ "state": {
+ "type": "string",
+ "description": "State of the selected address."
+ },
+ "country": {
+ "type": "string",
+ "description": "Three-digit country code of the selected address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format."
+ },
+ "reference": {
+ "type": "string",
+ "nullable": true,
+ "description": "Complement to help locate the selected address."
+ },
+ "geoCoordinates": {
+ "type": "array",
+ "items": {
+ "type": "number",
+ "description": "Longitude and latitude geocoordinates."
+ },
+ "description": "List with the selected address's geocoordinates, first longitude then latitude."
+ }
+ }
+ }
+ },
+ "contactInformation": {
+ "type": "array",
+ "description": "Array with customer contact information.",
+ "items": {
+ "type": "object",
+ "description": "Contact information.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Customer contact ID."
+ },
+ "email": {
+ "type": "string",
+ "description": "Customer contact email."
+ },
+ "firstName": {
+ "type": "string",
+ "description": "Customer contact first name."
+ },
+ "lastName": {
+ "type": "string",
+ "description": "Customer contact last name."
+ },
+ "phone": {
+ "type": "string",
+ "description": "Customer contact phone number."
+ },
+ "document": {
+ "type": "string",
+ "description": "Customer contact document ID."
+ },
+ "documentType": {
+ "type": "string",
+ "description": "Customer contact document type."
+ },
+ "entityId": {
+ "type": "string",
+ "description": "Entity identification code."
+ },
+ "versionId": {
+ "type": "string",
+ "description": "Version identification code."
+ }
+ }
+ }
+ }
+ }
+ },
+ "ratesAndBenefitsData": {
+ "type": "object",
+ "description": "Information on promotions and taxes that apply to the order.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "ID of the rate or benefit."
+ },
+ "rateAndBenefitsIdentifiers": {
+ "type": "array",
+ "description": "Information about order's promotions and taxes identifiers.",
+ "items": {
+ "type": "object",
+ "description": "Promotions or tax information.",
+ "properties": {
+ "description": {
+ "type": "string",
+ "description": "Promotion or tax description.",
+ "nullable": true
+ },
+ "featured": {
+ "type": "boolean",
+ "description": "Defines if the promotion or tax is cumulative (`true`) or not (`false`)."
+ },
+ "id": {
+ "type": "string",
+ "description": "Promotion or tax ID."
+ },
+ "name": {
+ "type": "string",
+ "description": "Promotion or tax name."
+ },
+ "matchedParameters": {
+ "type": "object",
+ "description": "Informs the criteria and conditions fulfilled so the promotion became valid.",
+ "additionalProperties": true
+ },
+ "additionalInfo": {
+ "type": "object",
+ "description": "Object containing promotion or tax additional information. For example { Free shipping: 100,00 }.",
+ "nullable": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "marketingData": {
+ "type": "object",
+ "description": "Information about promotions and marketing. For example, coupon tracking information and internal or external UTMs.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Object ID. The expected value is `marketingData`."
+ },
+ "utmSource": {
+ "type": "string",
+ "description": "Value of the `utm_source` parameter of the URL that led to the request."
+ },
+ "utmPartner": {
+ "type": "string",
+ "description": "UTM Source Parameters."
+ },
+ "utmMedium": {
+ "type": "string",
+ "description": "Value of the `utm_medium` parameter of the URL that led to the request."
+ },
+ "utmCampaign": {
+ "type": "string",
+ "description": "Value of the `utm_campaign` parameter of the URL that led to the request."
+ },
+ "coupon": {
+ "type": "string",
+ "description": "Coupon code."
+ },
+ "utmiCampaign": {
+ "type": "string",
+ "description": "Internal UTM value `utmi_cp`."
+ },
+ "utmipage": {
+ "type": "string",
+ "description": "Internal UTM value `utmi_p`."
+ },
+ "utmiPart": {
+ "type": "string",
+ "description": "Internal UTM value `utmi_pc`."
+ },
+ "marketingTags": {
+ "type": "array",
+ "description": "Marketing tags information. This field can be used to register campaign data or informative tags regarding promotions.",
+ "items": {
+ "type": "string",
+ "description": "Marketing tag."
+ }
+ }
+ },
+ "nullable": true
+ },
+ "giftRegistryData": {
+ "type": "object",
+ "description": "Information about [gift list](https://developers.vtex.com/docs/guides/creating-gift-lists).",
+ "nullable": true,
+ "properties": {
+ "giftRegistryId": {
+ "type": "string",
+ "description": "Gift list ID."
+ },
+ "giftRegistryType": {
+ "type": "string",
+ "description": "[Gift list type](https://help.vtex.com/en/tutorial/creating-a-type-of-list)."
+ },
+ "giftRegistryTypeName": {
+ "type": "string",
+ "description": "Gift list type name."
+ },
+ "addressId": {
+ "type": "string",
+ "description": "Gift list shipping address ID."
+ },
+ "description": {
+ "type": "string",
+ "description": "Gift list description."
+ }
+ }
+ },
+ "clientProfileData": {
+ "type": "object",
+ "description": "Object with information on the client's profile.",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Object ID, the expected value is `clientProfileData`."
+ },
+ "email": {
+ "type": "string",
+ "description": "Customer email."
+ },
+ "firstName": {
+ "type": "string",
+ "description": "Customer first name."
+ },
+ "lastName": {
+ "type": "string",
+ "description": "Customer last name."
+ },
+ "documentType": {
+ "type": "string",
+ "description": "Type of the document informed by the customer."
+ },
+ "document": {
+ "type": "string",
+ "description": "Document identification code informed by the customer."
+ },
+ "phone": {
+ "type": "string",
+ "description": "Customer phone number."
+ },
+ "corporateName": {
+ "type": "string",
+ "nullable": true,
+ "description": "If the customer is a legal entity, this field includes the corporate name."
+ },
+ "tradeName": {
+ "type": "string",
+ "nullable": true,
+ "description": "If the customer is a legal entity, this field includes the trade name."
+ },
+ "corporateDocument": {
+ "type": "string",
+ "nullable": true,
+ "description": "If the customer is a legal entity, this field includes the corporate document."
+ },
+ "stateInscription": {
+ "type": "string",
+ "nullable": true,
+ "description": "If the customer is a legal entity, this field includes the state inscription."
+ },
+ "corporatePhone": {
+ "type": "string",
+ "nullable": true,
+ "description": "If the customer is a legal entity, this field includes the company's phone number."
+ },
+ "isCorporate": {
+ "type": "boolean",
+ "description": "Defines if the customer is a legal entity (`true`) or not (`false`)."
+ },
+ "userProfileId": {
+ "type": "string",
+ "description": "Customer user profile ID."
+ },
+ "userProfileVersion": {
+ "type": "string",
+ "nullable": true,
+ "description": "Customer user profile version."
+ },
+ "customerClass": {
+ "type": "string",
+ "nullable": true,
+ "description": "Customer class identification."
+ },
+ "customerCode": {
+ "type": "string",
+ "nullable": true,
+ "description": "Customer code."
+ }
+ }
+ },
+ "items": {
+ "type": "array",
+ "description": "Information about order's items.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "uniqueId": {
+ "type": "string",
+ "description": "Alphanumeric sequence that identifies an SKU in a given order."
+ },
+ "id": {
+ "type": "string",
+ "description": "Unique SKU identifier."
+ },
+ "productId": {
+ "type": "string",
+ "description": "ID of the product associated with the item."
+ },
+ "ean": {
+ "type": "string",
+ "nullable": true,
+ "description": "EAN of the SKU."
+ },
+ "lockId": {
+ "type": "string",
+ "description": "Reservation ID."
+ },
+ "itemAttachment": {
+ "type": "object",
+ "description": "Item attachment information.",
+ "properties": {
+ "content": {
+ "type": "object",
+ "description": "Item attachment custom field for content."
+ },
+ "name": {
+ "type": "string",
+ "nullable": true,
+ "description": "Item attachment name."
+ }
+ }
+ },
+ "attachments": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "description": "Attachments information."
+ },
+ "description": "Array containing information on attachments."
+ },
+ "quantity": {
+ "type": "integer",
+ "description": "Quantity of items."
+ },
+ "seller": {
+ "type": "string",
+ "description": "Seller related to the order."
+ },
+ "name": {
+ "type": "string",
+ "description": "Item's name."
+ },
+ "refId": {
+ "type": "string",
+ "description": "Product referencial code associated with the item."
+ },
+ "price": {
+ "type": "integer",
+ "description": "Item's price."
+ },
+ "listPrice": {
+ "type": "integer",
+ "description": "Item's [list price](https://help.vtex.com/en/tracks/prices-101--6f8pwCns3PJHqMvQSugNfP/3XcXp0r5WrJvogB8KIX4Kx#list-price)."
+ },
+ "manualPrice": {
+ "type": "string",
+ "nullable": true,
+ "description": "Item's [manual price](https://help.vtex.com/en/tutorial/change-the-price-of-an-item-in-the-shopping-cart--7Cd37aCAmtL1qmoZJJvjNf)."
+ },
+ "priceTags": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "description": "Price modifiers."
+ },
+ "description": "List of objects with item's price modifiers."
+ },
+ "imageUrl": {
+ "type": "string",
+ "description": "SKU image URL."
+ },
+ "detailUrl": {
+ "type": "string",
+ "description": "SKU slug."
+ },
+ "components": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "description": "Components."
+ },
+ "description": "Item's components."
+ },
+ "bundleItems": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "description": "Item's offering details.",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "Offering ID."
+ },
+ "quantity": {
+ "type": "integer",
+ "description": "Offering quantity."
+ }
+ }
+ },
+ "description": "This field groups offerings (services) related to the item and displays their ID and quantity. A gift package is an example of an offering."
+ },
+ "params": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "description": "Information about params."
+ },
+ "description": "Array with information about params."
+ },
+ "offerings": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "description": "Service name related to the item."
+ },
+ "description": "Item's offerings, which are services related to the item. For example, guarantee or installation."
+ },
+ "attachmentOfferings": {
+ "type": "array",
+ "description": "Array containing attachments details.",
+ "nullable": true,
+ "items": {
+ "type": "object",
+ "description": "Attachment details.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Name of the attachment.",
+ "nullable": true
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Defines if the attachment is required (`true`) or not (`false`).",
+ "nullable": true
+ },
+ "schema": {
+ "type": "object",
+ "description": "Schema of the content declared in the field `attachmentOfferings`.",
+ "nullable": true
+ }
+ }
+ }
+ },
+ "sellerSku": {
+ "type": "string",
+ "description": "SKU ID from the seller perspective."
+ },
+ "priceValidUntil": {
+ "type": "string",
+ "nullable": true,
+ "description": "Date until when the price is going to be valid if there is a promotion."
+ },
+ "commission": {
+ "type": "integer",
+ "description": "Commission value registered for the seller."
+ },
+ "tax": {
+ "type": "integer",
+ "description": "Item's tax."
+ },
+ "preSaleDate": {
+ "type": "string",
+ "nullable": true,
+ "description": "Item's pre sale date."
+ },
+ "additionalInfo": {
+ "type": "object",
+ "description": "Additional information about the item.",
+ "properties": {
+ "brandName": {
+ "type": "string",
+ "description": "Item's brand name."
+ },
+ "brandId": {
+ "type": "string",
+ "description": "Item's brand ID."
+ },
+ "categoriesIds": {
+ "type": "string",
+ "description": "Item's category ID."
+ },
+ "categories": {
+ "type": "array",
+ "description": "Items categories information.",
+ "items": {
+ "type": "object",
+ "description": "Category information.",
+ "properties": {
+ "id": {
+ "type": "number",
+ "description": "Category ID."
+ },
+ "name": {
+ "type": "string",
+ "description": "Category name."
+ }
+ }
+ }
+ },
+ "productClusterId": {
+ "type": "string",
+ "description": "All product clusters related to the item."
+ },
+ "commercialConditionId": {
+ "type": "string",
+ "description": "Commercial conditions ID."
+ },
+ "dimension": {
+ "type": "object",
+ "description": "Item's dimensions.",
+ "properties": {
+ "cubicweight": {
+ "type": "number",
+ "description": "Item's cubic weight."
+ },
+ "height": {
+ "type": "integer",
+ "description": "Item's height."
+ },
+ "length": {
+ "type": "integer",
+ "description": "Item's length."
+ },
+ "weight": {
+ "type": "integer",
+ "description": "Item's weight."
+ },
+ "width": {
+ "type": "integer",
+ "description": "Item's width."
+ }
+ }
+ },
+ "offeringInfo": {
+ "type": "string",
+ "nullable": true,
+ "description": "Information about services related to the item. For example: guarantee or installation."
+ },
+ "offeringType": {
+ "type": "string",
+ "nullable": true,
+ "description": "Offering type."
+ },
+ "offeringTypeId": {
+ "type": "string",
+ "nullable": true,
+ "description": "Offering type ID."
+ }
+ }
+ },
+ "measurementUnit": {
+ "type": "string",
+ "description": "Item's measurement unit."
+ },
+ "unitMultiplier": {
+ "type": "integer",
+ "description": "Item's unit multiplier."
+ },
+ "sellingPrice": {
+ "type": "integer",
+ "description": "Item's selling price."
+ },
+ "isGift": {
+ "type": "boolean",
+ "description": "This field is `true` when the item is a gift in order context and `false` when it is not."
+ },
+ "shippingPrice": {
+ "type": "string",
+ "nullable": true,
+ "description": "Item's shipping price."
+ },
+ "rewardValue": {
+ "type": "integer",
+ "description": "Item's reward value."
+ },
+ "freightCommission": {
+ "type": "integer",
+ "description": "Value of the freight commission."
+ },
+ "priceDefinitions": {
+ "type": "object",
+ "description": "Item's price information.",
+ "properties": {
+ "sellingPrices": {
+ "type": "array",
+ "description": "Details on item's selling price.",
+ "items": {
+ "type": "object",
+ "description": "Selling price.",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "description": "Total value of items in cents."
+ },
+ "quantity": {
+ "type": "integer",
+ "description": "Quantity of items."
+ }
+ }
+ }
+ },
+ "calculatedSellingPrice": {
+ "type": "integer",
+ "description": "Item's calculated unitary selling price in cents."
+ },
+ "total": {
+ "type": "integer",
+ "description": "Total value of all item's units in cents."
+ }
+ }
+ },
+ "taxCode": {
+ "type": "string",
+ "nullable": true,
+ "description": "Item's tax code."
+ },
+ "parentItemIndex": {
+ "type": "integer",
+ "nullable": true,
+ "description": "Ranking number that shows how related items are indexed in between each other. It starts at `0` as the primary item reference and counts up to `1`, `2`, and so on. For example, a customer bought sunglasses and hired a warranty service. Since the sunglasses are index `0`, the warranty service (the [assembly option](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH)) is index `1` and has the `parentItemIndex` value `0`. This response is `null` for items that are not assembly options."
+ },
+ "parentAssemblyBinding": {
+ "type": "string",
+ "nullable": true,
+ "description": "When items are indexed in between each other, this field returns the assembly option ID. This response is `null` for items that are not [assembly options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH)."
+ },
+ "callCenterOperator": {
+ "type": "string",
+ "description": "Identification code of the call center operator responsible for the order.",
+ "nullable": true
+ },
+ "serialNumbers": {
+ "type": "string",
+ "description": "This field identifies the order in the `handling` status in the workflow, and it was used for VTEX internal control.",
+ "deprecated": true,
+ "nullable": true
+ },
+ "assemblies": {
+ "type": "array",
+ "description": "Information about items customization.",
+ "nullable": true,
+ "items": {
+ "type": "string",
+ "description": "Customization information."
+ }
+ },
+ "costPrice": {
+ "type": "integer",
+ "description": "Item's cost price."
+ }
+ },
+ "description": "Items information."
+ }
+ },
+ "marketplaceItems": {
+ "type": "array",
+ "description": "Array with marketplace items information.",
+ "items": {
+ "type": "string",
+ "description": "Marketplace items."
+ }
+ },
+ "authorizationPolicyData": {
+ "$ref": "#/components/schemas/AuthorizationPolicyData"
+ }
+ }
+ },
+ "example": {
+ "orderId": "1172452900788-01",
+ "sequence": "502556",
+ "marketplaceOrderId": "1172452900788-01",
+ "marketplaceServicesEndpoint": "http://oms.vtexinternal.com.br/api/oms?an=luxstore",
+ "sellerOrderId": "00-v502556llux-01",
+ "origin": "Marketplace",
+ "affiliateId": "GHB",
+ "salesChannel": "1",
+ "merchantName": "luxstore",
+ "status": "handling",
+ "workflowIsInError": false,
+ "statusDescription": "Preparando Entrega",
+ "value": 1160,
+ "creationDate": "2024-02-04T20:09:43.899958+00:00",
+ "lastChange": "2024-02-06T20:46:11.7010747+00:00",
+ "orderGroup": "1415461749731",
+ "followUpEmail": "david@luxstore.com",
+ "lastMessage": "Your payment was approved",
+ "hostname": "luxstore",
+ "isCompleted": true,
+ "roundingError": 0,
+ "orderFormId": "33c887b2-bf49-4a18-8a0a-acc6b0d724bf",
+ "allowCancellation": true,
+ "allowEdition": false,
+ "isCheckedIn": false,
+ "authorizedDate": "2024-02-04T20:46:11.7010747+00:00",
+ "invoicedDate": "2024-02-09T10:17:40.5322681+00:00",
+ "cancelReason": "Item size was too large.",
+ "checkedInPickupPointId": "storeNameExample_901",
+ "totals": [
+ {
+ "id": "Items",
+ "name": "Total dos Itens",
+ "value": 99
+ },
+ {
+ "id": "Discounts",
+ "name": "Total dos Descontos",
+ "value": 0
+ },
+ {
+ "id": "Shipping",
+ "name": "Total do Frete",
+ "value": 300
+ },
+ {
+ "id": "Tax",
+ "name": "Total da Taxa",
+ "value": 0
+ }
+ ],
+ "sellers": [
+ {
+ "id": "1",
+ "name": "Lux Store",
+ "logo": "https://sellersLogo/images.png",
+ "fulfillmentEndpoint": "http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=accountName"
+ }
+ ],
+ "clientPreferencesData": {
+ "locale": "en-US",
+ "optinNewsLetter": true
+ },
+ "cancellationData": {
+ "RequestedByUser": true,
+ "RequestedBySystem": false,
+ "RequestedBySellerNotification": false,
+ "RequestedByPaymentNotification": false,
+ "Reason": "Item size was too large.",
+ "CancellationDate": "2024-02-11T09:14:41.3695207Z"
+ },
+ "taxData": {
+ "areTaxesDesignatedByMarketplace": true,
+ "taxInfoCollection": [
+ {
+ "itemIndex": 0,
+ "sku": "18",
+ "priceTags": [
+ {
+ "identifier": "0a9df101-330c-41ad-a4c7-5a0bd521bc9u",
+ "isPercentual": false,
+ "name": "Taxes (Magazine Luisa)",
+ "value": 193,
+ "rawValue": 1.93
+ }
+ ]
+ }
+ ]
+ },
+ "subscriptionData": {
+ "SubscriptionGroupId": "A64AC73C0FB8693A7ADB4AC69CA4FD5F",
+ "Subscriptions": [
+ {
+ "ExecutionCount": 724,
+ "PriceAtSubscriptionDate": 100,
+ "ItemIndex": 0,
+ "Plan": {
+ "type": "RECURRING_PAYMENT",
+ "frequency": {
+ "periodicity": "MONTH",
+ "interval": 1
+ },
+ "validity": {
+ "begin": "2024-02-09T09:14:41.3695207Z",
+ "end": "2026-02-11T09:14:41.3695207Z"
+ }
+ }
+ }
+ ]
+ },
+ "itemMetadata": {
+ "Items": [
+ {
+ "Id": "18",
+ "Seller": "1",
+ "Name": "Cat food",
+ "SkuName": "Cat food",
+ "ProductId": "6",
+ "RefId": "105",
+ "Ean": "43673557",
+ "ImageUrl": "http://store.vteximg.com.br/ids/155392-55-55/AlconKOI.jpg?v=635918402228600000",
+ "DetailUrl": "/catfood/p",
+ "AssemblyOptions": [
+ {
+ "Id": "vtex.subscription.plan-ana",
+ "Name": "vtex.subscription.plan-ana",
+ "Required": false,
+ "InputValues": {
+ "vtex.subscription.key.frequency": {
+ "MaximumNumberOfCharacters": 8,
+ "Domain": [
+ "4 month",
+ "1 month"
+ ]
+ }
+ },
+ "Composition": {}
+ },
+ {
+ "Id": "vtex.subscription.daily",
+ "Name": "vtex.subscription.daily",
+ "Required": false,
+ "InputValues": {
+ "vtex.subscription.key.frequency": {
+ "MaximumNumberOfCharacters": 5,
+ "Domain": [
+ "1 day"
+ ]
+ }
+ },
+ "Composition": null
+ },
+ {
+ "Id": "vtex.subscription.weekly",
+ "Name": "vtex.subscription.weekly",
+ "Required": false,
+ "InputValues": {
+ "vtex.subscription.key.frequency": {
+ "MaximumNumberOfCharacters": 7,
+ "Domain": [
+ "1 week",
+ "2 week",
+ "3 week",
+ "4 week"
+ ]
+ }
+ },
+ "Composition": null
+ }
+ ]
+ }
+ ]
+ },
+ "marketplace": {
+ "baseURL": "http://oms.vtexinternal.com.br/api/oms?an=luxstore",
+ "isCertified": true,
+ "name": "luxstore"
+ },
+ "storePreferencesData": {
+ "countryCode": "BRA",
+ "currencyCode": "BRL",
+ "currencyFormatInfo": {
+ "CurrencyDecimalDigits": 2,
+ "CurrencyDecimalSeparator": ",",
+ "CurrencyGroupSeparator": ".",
+ "CurrencyGroupSize": 3,
+ "StartsWithCurrencySymbol": true
+ },
+ "currencyLocale": 1046,
+ "currencySymbol": "R$",
+ "timeZone": "E. South America Standard Time"
+ },
+ "customData": {
+ "customApps": [
+ {
+ "id": "integration-marketplace-example",
+ "major": 1,
+ "fields": {
+ "marketplacePaymentCnpjAcquirers": "11.222.333/0001-44",
+ "marketplacePaymentAuthorizationCodes": "XYZ",
+ "marketplacePaymentCreditCardBrands": "Visa",
+ "marketplacePaymentMethods": "CreditCard"
+ }
+ }
+ ],
+ "customFields": [
+ {
+ "linkedEntity": {
+ "type": "item",
+ "id": "B2949D0A45244825B177D2F9F96DC711"
+ },
+ "fields": [
+ {
+ "name": "Cost Center",
+ "value": "CC3"
+ }
+ ]
+ }
+ ]
+ },
+ "commercialConditionData": "Commercial conditions information.",
+ "openTextField": null,
+ "invoiceData": {
+ "userPaymentInfo": null,
+ "address": null,
+ "invoiceSubject": null
+ },
+ "changesAttachment": {
+ "id": "changeAttachment",
+ "changesData": [
+ {
+ "reason": "The customer wanted to change.",
+ "discountValue": 3290,
+ "incrementValue": 0,
+ "itemsAdded": [],
+ "itemsRemoved": [
+ {
+ "id": "1234568358",
+ "name": "Bay Max L",
+ "quantity": 1,
+ "price": 3290,
+ "unitMultiplier": null
+ }
+ ],
+ "receipt": {
+ "date": "2019-02-06T20:46:04.4003606+00:00",
+ "orderId": "v502556llux-01",
+ "receipt": "029f9ab8-751a-4b1e-bf81-7dd25d14b49b"
+ }
+ }
+ ]
+ },
+ "callCenterOperatorData": {
+ "id": "CallCenterOperatorAttachment",
+ "email": "sandra.daves@luxstore.com",
+ "userName": "sandraDaves"
+ },
+ "packageAttachment": {
+ "packages": [
+ {
+ "items": [
+ {
+ "itemIndex": 0,
+ "quantity": 1,
+ "price": 0,
+ "description": "001",
+ "unitMultiplier": 0
+ }
+ ],
+ "courier": "PAC Correios",
+ "invoiceNumber": "24382",
+ "invoiceValue": 1015,
+ "invoiceUrl": "https://luxstore.com/invoices/24382.pdf",
+ "issuanceDate": "2024-02-09T10:10:20.5322681+00:00",
+ "trackingNumber": "TRK-48960684",
+ "invoiceKey": "CFe35201100063960001504590006629690333214542150",
+ "trackingUrl": "https://tracking.fastdelivery.com/track/146/TRK-48960684-01/24382",
+ "embeddedInvoice": "Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Oms |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |Cancel order
Change order
|\r\n| inStore Sales Person |Cancel order
Change order
|\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "operationId": "RegisterChange", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "ID that identifies the order in the seller.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "1172452900788-01" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "requestId", + "reason", + "discountValue", + "incrementValue" + ], + "properties": { + "requestId": { + "type": "string", + "description": "Request identification of the modification. Only the first modification made with each `requestId` will be effective on a given order. Use different IDs for different modifications to the same order." + }, + "reason": { + "type": "string", + "description": "Reason for order modification. This may be shown to the shopper in the UI or transactional emails." + }, + "discountValue": { + "type": "integer", + "description": "This field can be used to apply a discount to the total value of the order. Value in cents." + }, + "incrementValue": { + "type": "integer", + "description": "This field can be used to increment the total value of the order. Value in cents." + }, + "itemsRemoved": { + "type": "array", + "description": "List of items that should be removed from the order.", + "items": { + "type": "object", + "description": "Removed items' details.", + "required": [ + "id", + "price", + "quantity" + ], + "properties": { + "id": { + "type": "string", + "description": "SKU ID of the item being removed." + }, + "price": { + "type": "integer", + "description": "Price of the item being removed in cents." + }, + "quantity": { + "type": "integer", + "description": "Amount of items to be removed." + } + } + } + }, + "itemsAdded": { + "type": "array", + "description": "List of items that should be added to the order.", + "items": { + "type": "object", + "description": "Added items' details.", + "required": [ + "id", + "price", + "quantity" + ], + "properties": { + "id": { + "type": "string", + "description": "SKU ID of the item being added." + }, + "price": { + "type": "integer", + "description": "Price of the item being added in cents." + }, + "quantity": { + "type": "integer", + "description": "Amount of items to be added." + } + } + } + } + } + }, + "example": { + "requestId": "change-request-0123", + "reason": "Stock shortage", + "discountValue": 100, + "incrementValue": 100, + "itemsRemoved": [ + { + "id": "0", + "price": 2499, + "quantity": 1 + } + ], + "itemsAdded": [ + { + "id": "0", + "price": 2499, + "quantity": 1 + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date of order modification." + }, + "orderId": { + "type": "string", + "description": "ID of the order." + }, + "receipt": { + "type": "string", + "description": "Receipt identification." + } + } + }, + "example": { + "date": "2024-02-08T13:54:33.6868469+00:00", + "orderId": "v502538llux-01", + "receipt": "535d4581-a2a2-4fd2-a206-1c61eae91b1e" + } + } + } + } + } + } + }, + "/api/oms/pvt/orders/{orderId}/interactions": { + "post": { + "tags": [ + "Orders" + ], + "summary": "Add log in orders", + "description": "Add a Log in Interactions Order Array. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "operationId": "AddLog", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "Unique code that identifies an order.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "1172452900788-01" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "source", + "message" + ], + "properties": { + "source": { + "type": "string", + "description": "Source information." + }, + "message": { + "type": "string", + "description": "Interactions message." + } + } + }, + "example": { + "source": "Postman", + "message": "Add interactions" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/api/oms/pvt/orders/{orderId}/invoice": { + "post": { + "tags": [ + "Invoice" + ], + "summary": "Order invoice notification", + "description": "This request is used for [invoicing an order](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/2WgQrlHTyVo4hLjhUs1LMT). Entering the order's invoice means it was successfully completed, and the order status can be changed to `invoiced` in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). Once an order is `invoiced`, its status cannot be changed. \r\n\r\nAfter the insertion of the invoice, the order's total value will be updated, even in [partial invoice](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) scenarios. \r\n\r\n>❗ To avoid rounding errors, we recommend always sending the object of items being invoiced. \r\n\r\n## Partial invoices \r\n\r\nAfter adding a [partial invoice](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe), the order's value will be updated, corresponding to a partial settled value in the VTEX payment gateway. \r\n\r\nPartially invoiced orders cannot be canceled, and cancellation attempts will result in a `400` status code error. If the customer wants to replace or remove items, it is possible to [change the order](https://developers.vtex.com/docs/guides/change-order). \r\n\r\n> The partial invoices feature is available for all VTEX stores. The partial settlement in the gateway is in Beta, and requires a connector with the Payment Provider Protocol. \r\n\r\n## Returning items \r\n\r\nBesides using this endpoint for generating invoices for sold items, you can use it for generating invoices for returned items. You determine this in the request body `type` field by choosing one of the following values: \r\n\r\n- `Output`: selling order invoice. \r\n\r\n- `Input`: returning items invoice. \r\n\r\nBe aware of generating return invoices only after the full order amount was invoiced, otherwise, no refund will occur. \r\n\r\n >⚠️ Generating a return `(type: Input)` invoice with this endpoint will automatically create a refund without the need of additional API requests. \r\n\r\n## Changing the receipt code \r\n\r\nEvery time this endpoint is called using the same `invoiceNumber`, a new `receipt` code is generated, and it overrides the previous one. By doing this, you cannot change other information, only the `receipt` code.\r\n\r\n## Integration with marketplaces \r\n\r\nThe invoice should be pushed to the fulfillment account, not to the marketplace account. Once the order is invoiced, the seller should use this request to send the invoice information to the marketplace. \r\n\r\nThis endpoint is also used by the seller to send the order tracking information. However, this only should be done after the seller has the tracking information. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **Notify invoice** |\r\n| OMS | OMS access | **Notify refund** | \r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | Cancel order |\r\n| IntegrationProfile - Fulfillment Oms | Cancel order |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). \r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "operationId": "InvoiceNotification", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "Unique code that identifies the order whose invoice is being sent.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "1172452900788-01" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "type", + "issuanceDate", + "invoiceNumber", + "invoiceValue", + "items" + ], + "properties": { + "type": { + "type": "string", + "description": "The type of invoice. There are two possible values: **Output** and **Input**. The Output type should be used when the invoice you are sending is a selling invoice. The Input type should be used when you send a return invoice.", + "enum": [ + "Output", + "Input" + ] + }, + "issuanceDate": { + "type": "string", + "description": "The invoice date is when the order was [invoiced](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/2WgQrlHTyVo4hLjhUs1LMT) in the VTEX platform, and the `IssuanceDate` is the date when the merchant registers the order's invoice in the store's system. The `IssuanceDate` can be different from the invoice date, because the merchant can register the invoice days or even months after order invoicing. You must add date and time in this field." + }, + "invoiceNumber": { + "type": "string", + "description": "Unique code that identifies the invoice. When you call this endpoint using the same invoice number, you generate a new `receipt` code.", + "nullable": true + }, + "invoiceValue": { + "type": "string", + "description": "Total amount being invoiced in cents. Must be greater than 0. Do not use any decimal separator. For instance, `$24.99` should be represented as `2499`." + }, + "invoiceKey": { + "type": "string", + "nullable": true, + "description": "Information about invoice key." + }, + "invoiceUrl": { + "type": "string", + "description": "URL of the invoice. Can be used to send the URL of an XML file, for example, which is useful for some integrations.", + "nullable": true + }, + "embeddedInvoice": { + "type": "string", + "nullable": true, + "description": "XML text of the invoice, not the URL. This field is very important for external marketplace integrations such as Mercado Libre." + }, + "courier": { + "type": "string", + "nullable": false, + "description": "The name of the carrier responsible for delivering the order." + }, + "trackingNumber": { + "type": "string", + "nullable": true, + "description": "The number code that identifies the order tracking. *This field should only be used when sending the **tracking** information. When the request is used for sending the invoice, this field should be left empty (`\"\"`)*." + }, + "trackingUrl": { + "type": "string", + "nullable": true, + "description": "The URL used to track the order. *This field should only be used when sending the **tracking** information. When the request is used for sending the invoice, this field should be left empty (`\"\"`)*." + }, + "dispatchedDate": { + "type": "string", + "nullable": true, + "description": "Order dispatch date. May be `null`." + }, + "items": { + "type": "array", + "description": "Array containing the SKUs that are being invoiced.", + "items": { + "type": "object", + "description": "Information about a SKU being invoiced.", + "required": [ + "id", + "price", + "quantity" + ], + "properties": { + "id": { + "type": "string", + "description": "ID of the SKU being invoiced." + }, + "price": { + "type": "integer", + "description": "Price in cents of the SKU being invoiced. Do not use a decimal separator, for example, the price $24.99 corresponds to `2499`. You must insert the SKU unitary price because the VTEX system will multiply the price over the quantity." + }, + "description": { + "type": "string", + "description": "You can use this field for additional information about the SKU being invoiced." + }, + "quantity": { + "type": "integer", + "description": "Quantity currently in inventory of the SKU being invoiced." + } + } + } + } + } + }, + "example": { + "type": "Output", + "issuanceDate": "2024-01-31T18:25:43-05:00", + "invoiceNumber": "DFG-v7731485plzv-01", + "invoiceValue": "2499", + "invoiceKey": "CFe35201100063960001504590006629690333214542150", + "invoiceUrl": "https://luxstore.com/invoices/24382.pdf", + "embeddedInvoice": "
|
|
|
Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Oms |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |Cancel order
Change order
|\r\n| inStore Sales Person |Cancel order
Change order
|\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "parameters": [ + { + "name": "accountName", + "in": "query", + "description": "Name of the VTEX account that created the order.", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "storeName" + } + }, + { + "name": "changeOrderId", + "in": "path", + "description": "Order ID of the order you wish to modify.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "v12772213qst-02" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Createchange" + } + } + } + }, + "responses": { + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/response202" + }, + "example": { + "requestId": "e8532a32-7f7e-434a-88ec-29609f0ede46", + "workflowId": "74f40e7a-68c6-4699-b874-a8a297fb3f6a", + "reason": "The client did not like the size.", + "manualDiscountValue": 0, + "manualIncrementValue": 0, + "totalChangeValue": 0, + "totals": [], + "add": null, + "remove": null, + "replace": [ + { + "from": { + "paymentData": { + "transactions": [] + }, + "items": [ + { + "id": "31", + "quantity": 1, + "price": null, + "measurementUnit": null, + "unitMultiplier": 0, + "sellingPrice": null, + "name": null, + "detailUrl": null, + "imageUrl": null + } + ], + "shippingData": { + "logisticsInfo": [] + } + }, + "to": { + "items": [ + { + "uniqueId": "40E763F4378E4F40AD1FE915FE1078E1", + "id": "1", + "productId": null, + "productRefId": null, + "refId": null, + "ean": null, + "name": null, + "skuName": null, + "modalType": null, + "parentItemIndex": null, + "parentAssemblyBinding": null, + "assemblies": [], + "priceValidUntil": null, + "tax": 0, + "price": null, + "listPrice": null, + "manualPrice": null, + "manualPriceAppliedBy": null, + "sellingPrice": null, + "rewardValue": 0, + "isGift": false, + "additionalInfo": { + "dimension": null, + "brandName": null, + "brandId": null, + "offeringInfo": null, + "offeringType": null, + "offeringTypeId": null, + "categoriesIds": null, + "productClusterId": null, + "commercialConditionId": null + }, + "preSaleDate": null, + "productCategoryIds": null, + "productCategories": {}, + "quantity": 1, + "seller": null, + "sellerChain": [ + null + ], + "imageUrl": null, + "detailUrl": null, + "components": [], + "bundleItems": [], + "attachments": [], + "attachmentOfferings": [], + "offerings": [], + "priceTags": [], + "availability": null, + "measurementUnit": "un", + "unitMultiplier": 1, + "manufacturerCode": null, + "priceDefinition": null + } + ], + "paymentData": { + "transactions": [] + }, + "receiptData": null, + "shippingData": { + "logisticsInfo": [ + { + "itemIndex": 0, + "selectedSla": "Lenta", + "selectedDeliveryChannel": "delivery", + "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", + "slas": [ + { + "id": "Lenta", + "deliveryChannel": "delivery", + "name": "Lenta", + "deliveryIds": [], + "shippingEstimate": null, + "shippingEstimateDate": null, + "lockTTL": null, + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 600, + "listPrice": 600, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": null, + "transitTime": null + } + ], + "shipsTo": [], + "itemId": "1", + "deliveryChannels": [], + "price": 600, + "listPrice": 600, + "shippingEstimate": null, + "dockEstimate": null, + "shippingEstimateDate": null, + "lockTTL": null, + "deliveryCompany": null, + "polygonName": null, + "transitTime": null, + "sellingPrice": 600, + "deliveryIds": [], + "deliveryWindow": null, + "pickupPointId": null, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupDistance": null + } + ] + } + } + } + ], + "date": "2023-07-27T17:52:18.6483116Z", + "origin": { + "account": "qastore", + "orderId": "v12772213qst-02", + "component": "MarketplaceComponent" + }, + "settings": { + "customPaymentSystemsAllowed": [ + "201" + ] + } + } + } + } + } + } + }, + "get": { + "tags": [ + "Order modifications" + ], + "summary": "Get order modifications history", + "operationId": "GetChangeHistory", + "description": "This endpoint retrieves a history of every successful [Create order modifications request](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) made to an order and provides detailed information about each request.\r\n\r\nYou can access an order's history using the `changeOrderId`, which corresponds to its `orderId`.\r\n\r\n> If you want detailed information about a single modification request, you can use the endpoint [Get order modifications details](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https:/developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https:/help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Oms |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |Cancel order
Change order
|\r\n| inStore Sales Person |Cancel order
Change order
|\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).", + "parameters": [ + { + "name": "an", + "in": "query", + "description": "Name of the VTEX account that created the order.", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "storeName" + } + }, + { + "name": "changeOrderId", + "in": "path", + "description": "Order ID of the order you wish to get the modifications history.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "v12772213qst-02" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "requests", + "actions" + ], + "properties": { + "requests": { + "type": "array", + "description": "Array with order modifications requests details.", + "items": { + "required": [ + "requestId", + "workflowId", + "reason", + "manualDiscountValue", + "manualIncrementValue", + "totalChangeValue", + "totals", + "add", + "remove", + "replace", + "date", + "origin", + "settings" + ], + "type": "object", + "description": "Information about each order modification request.", + "properties": { + "requestId": { + "type": "string", + "description": "Unique code that identifies an order modification." + }, + "workflowId": { + "type": "string", + "description": "Code that identifies the transaction of modifying the orders in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196)." + }, + "reason": { + "type": "string", + "description": "Reason that motivated the order modifications." + }, + "manualDiscountValue": { + "type": "integer", + "description": "This field shows if it was applied a manual price for the total order amount. The value is in cents." + }, + "manualIncrementValue": { + "type": "integer", + "description": "This field shows if an increment value was applied to the total order amount. The value is in cents." + }, + "totalChangeValue": { + "type": "integer", + "description": "This field shows how much the order total price is, considering that price modifications might have been made. The value is in cents." + }, + "totals": { + "type": "array", + "description": "Array containing total costs information.", + "items": { + "type": "object", + "description": "Total changing price details for a given type of cost.", + "properties": { + "id": { + "type": "string", + "description": "Changing price type, for example the item price or shipping costs." + }, + "name": { + "type": "string", + "description": "Changing price name." + }, + "value": { + "type": "number", + "description": "Changing price value in cents." + } + } + } + }, + "add": { + "type": "object", + "nullable": true, + "description": "Information about an `add` operation, when there was one. It will have the same schema of `request.replace.to`." + }, + "remove": { + "type": "object", + "nullable": true, + "description": "Information about a `remove` operation, when there was one. It will have the same schema of `request.replace.from`." + }, + "replace": { + "type": "array", + "description": "Array with information about the replacement operation performed.", + "items": { + "type": "object", + "description": "Replacing operation object.", + "required": [ + "from", + "to" + ], + "properties": { + "from": { + "$ref": "#/components/schemas/From2" + }, + "to": { + "$ref": "#/components/schemas/To2" + } + } + } + }, + "date": { + "type": "string", + "description": "Date and time of the request. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`." + }, + "origin": { + "$ref": "#/components/schemas/OriginV2" + }, + "settings": { + "$ref": "#/components/schemas/Settings" + } + } + } + }, + "actions": { + "type": "array", + "description": "Array containing previous changing order actions history.", + "items": { + "type": "object", + "description": "Changing order action details, with a schema like the `requests` property.", + "nullable": true + } + } + } + }, + "example": { + "requests": [ + { + "requestId": "e8532a32-7f7e-434a-88ec-29609f0ede46", + "workflowId": "74f40e7a-68c6-4699-b874-a8a297fb3f6a", + "reason": "The client did not like the size.", + "manualDiscountValue": 0, + "manualIncrementValue": 0, + "totalChangeValue": 0, + "totals": [ + { + "id": "ManualValues", + "name": "Manual Values Total", + "value": -1000 + } + ], + "add": null, + "remove": null, + "replace": [ + { + "from": { + "paymentData": { + "transactions": [] + }, + "items": [ + { + "id": "31", + "quantity": 1, + "price": 5000, + "measurementUnit": "un", + "unitMultiplier": 1, + "sellingPrice": 5000, + "name": "Small toy", + "detailUrl": "/small-toy-24/p", + "imageUrl": "http://storename.com/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000" + } + ], + "shippingData": { + "logisticsInfo": [ + { + "itemIndex": 0, + "selectedSla": "Economic", + "selectedDeliveryChannel": "delivery", + "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", + "slas": [ + { + "id": "Economic", + "deliveryChannel": "delivery", + "name": "Economic", + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "DeliverClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 180, + "listPrice": 180, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + }, + { + "id": "Normal", + "deliveryChannel": "delivery", + "name": "Normal", + "deliveryIds": [ + { + "courierId": "1", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "3bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 500, + "listPrice": 500, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "3bd" + }, + { + "id": "Pickup", + "deliveryChannel": "delivery", + "name": "Pickup", + "deliveryIds": [ + { + "courierId": "ech018654", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Pickup", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 700, + "listPrice": 700, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + } + ], + "shipsTo": [ + "BRA" + ], + "itemId": "31", + "deliveryChannels": [ + { + "id": "delivery" + } + ], + "price": 180, + "listPrice": 180, + "shippingEstimate": "25bd", + "dockEstimate": null, + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "deliveryCompany": null, + "polygonName": "", + "transitTime": "25bd", + "sellingPrice": 180, + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": null, + "accountCarrierName": "qastoreecho" + } + ], + "deliveryWindow": null, + "pickupPointId": null, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupDistance": null + } + ] + } + }, + "to": { + "items": [ + { + "uniqueId": "40E763F4378E4F40AD1FE915FE1078E1", + "id": "1", + "productId": "1", + "productRefId": "", + "refId": "codrefxicaraazul", + "ean": "8745121641", + "name": "Blue cup", + "skuName": "cup", + "modalType": null, + "parentItemIndex": null, + "parentAssemblyBinding": null, + "assemblies": [], + "priceValidUntil": null, + "tax": 0, + "price": 5000, + "listPrice": null, + "manualPrice": null, + "manualPriceAppliedBy": null, + "sellingPrice": 5000, + "rewardValue": 0, + "isGift": false, + "additionalInfo": { + "dimension": null, + "brandName": null, + "brandId": null, + "offeringInfo": null, + "offeringType": null, + "offeringTypeId": null, + "categoriesIds": null, + "productClusterId": null, + "commercialConditionId": null + }, + "preSaleDate": null, + "productCategoryIds": "/1/", + "productCategories": { + "1": "Category" + }, + "quantity": 1, + "seller": "1", + "sellerChain": [ + "1" + ], + "imageUrl": "http://storename.com/arquivos/ids/155394-55-55/cup.jpg?v=636565506415770000", + "detailUrl": "/xicara/p", + "components": [], + "bundleItems": [], + "attachments": [], + "attachmentOfferings": [], + "offerings": [], + "priceTags": [], + "availability": null, + "measurementUnit": "un", + "unitMultiplier": 1, + "manufacturerCode": null, + "priceDefinition": { + "calculatedSellingPrice": 5000, + "total": 5000, + "sellingPrices": [ + { + "value": 5000, + "quantity": 1 + } + ] + } + } + ], + "paymentData": { + "transactions": [] + }, + "receiptData": null, + "shippingData": { + "logisticsInfo": [ + { + "itemIndex": 0, + "selectedSla": "Economic", + "selectedDeliveryChannel": "delivery", + "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", + "slas": [ + { + "id": "Economic", + "deliveryChannel": "delivery", + "name": "Economic", + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 600, + "listPrice": 180, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + }, + { + "id": "Normal", + "deliveryChannel": "delivery", + "name": "Normal", + "deliveryIds": [ + { + "courierId": "1", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "3bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 500, + "listPrice": 500, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "3bd" + }, + { + "id": "Pickup", + "deliveryChannel": "delivery", + "name": "Pickup", + "deliveryIds": [ + { + "courierId": "ech018654", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Pickup", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 700, + "listPrice": 700, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + } + ], + "shipsTo": [ + "BRA" + ], + "itemId": "1", + "deliveryChannels": [ + { + "id": "delivery" + } + ], + "price": 600, + "listPrice": 180, + "shippingEstimate": "25bd", + "dockEstimate": null, + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "deliveryCompany": null, + "polygonName": "", + "transitTime": "25bd", + "sellingPrice": 600, + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Donkey", + "quantity": 1, + "kitItemDetails": null, + "accountCarrierName": "qastoreecho" + } + ], + "deliveryWindow": null, + "pickupPointId": null, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupDistance": null + } + ] + } + } + } + ], + "date": "2024-07-27T17:52:18.6483116Z", + "origin": { + "account": "qastore", + "orderId": "v12772213qst-02", + "component": "MarketplaceComponent" + }, + "settings": { + "customPaymentSystemsAllowed": [ + "201" + ] + } + } + ], + "actions": [] + } + } + } + } + } + } + }, + "/api/order-system/orders/{changeOrderId}/changes/{changeRequestId}": { + "get": { + "tags": [ + "Order modifications" + ], + "summary": "Get order modifications details", + "description": "This endpoint retrieves detailed information about a specific order modification. So after creating multiple modifications, you can get information on each one of them by its `changeRequestId`, the unique identification code generated by the [Create order modifications](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint.\r\n\r\nThe successful status code is `200 OK`, and its response body schema is very similar to the [Create order modifications](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint, with some additional fields:\r\n\r\n- `status`: The modification request status in the workflow, which progresses in the following order:\r\n - `waiting-acknowledgement`\r\n - `waiting-confirmation`\r\n - `done`\r\n - `canceled`\r\n\r\n- `inProgress`: When set as `true`, the order is still progressing in the order flow, when set as `false`, it is complete, whether by cancellation or because the customer received it.\r\n\r\n- `logs`: Lists the workflow processing logs.\r\n\r\n> If you want information about all the modifications made to an order, use the [Get order modifications history](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes) endpoint.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Oms |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |Cancel order
Change order
|\r\n| inStore Sales Person |Cancel order
Change order
|\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).", + "operationId": "GetChangeDetail", + "parameters": [ + { + "name": "an", + "in": "query", + "description": "Name of the VTEX account that created the order.", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "storeName" + } + }, + { + "name": "changeOrderId", + "in": "path", + "description": "Order ID of the order you wish to get the modification detail.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "v12772213qst-02" + } + }, + { + "name": "changeRequestId", + "in": "path", + "description": "Once you make an order modification, you generate a `requestId` code that identifies the modifications made to that order. This field should be filled with that code. There are no limits to modifications you can perform using the same `changeRequestId`, and we recommend keeping all modifications of a given order grouped by the same `changeRequestId`, so you will have a unified modification history.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "e8532a32-7f7e-434a-88ec-29609f0ede46" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "required": [ + "requestId", + "workflowId", + "status", + "inProgress", + "reason", + "manualDiscountValue", + "manualIncrementValue", + "totalChangeValue", + "totals", + "add", + "remove", + "replace", + "date", + "origin", + "settings" + ], + "type": "object", + "properties": { + "requestId": { + "type": "string", + "description": "Unique code that identifies an order modification request." + }, + "workflowId": { + "type": "string", + "description": "Code that identifies the transaction of changing the orders in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196)." + }, + "status": { + "type": "string", + "description": "Order status in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196)." + }, + "inProgress": { + "type": "boolean", + "description": "When set as `true`, the order is still progressing in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196), when set as `false`, it is complete, whether by cancellation or because the customer received it." + }, + "reason": { + "type": "string", + "description": "Reason that motivated the order modifications." + }, + "manualDiscountValue": { + "type": "integer", + "description": "This field shows if a manual price was applied to the total order amount. The value is in cents." + }, + "manualIncrementValue": { + "type": "integer", + "description": "This field shows if an increment value was applied to the total order amount. The value is in cents." + }, + "totalChangeValue": { + "type": "integer", + "description": "This field shows how much is the order total price considering that price modifications might have been made. The value is in cents." + }, + "totals": { + "type": "array", + "description": "Array containing total costs information.", + "items": { + "type": "object", + "description": "Total changing price details for a given type of cost.", + "properties": { + "id": { + "type": "string", + "description": "Changing price type, for example the item price or shipping costs." + }, + "name": { + "type": "string", + "description": "Changing price name." + }, + "value": { + "type": "number", + "description": "Changing price value in cents." + } + } + } + }, + "add": { + "type": "array", + "description": "Array with information about the `add` operation, when applicable. The schema will correspond to the object `to` inside the `replace` array.", + "nullable": true, + "items": { + "type": "string", + "description": "Adding operation information, when applicable." + } + }, + "remove": { + "type": "array", + "description": "Array with information about the `remove` operation, when applicable. The schema will correspond to the object `from` inside the `replace` array.", + "nullable": true, + "items": { + "type": "string", + "description": "Removing operation information, when applicable." + } + }, + "replace": { + "type": "array", + "description": "Array with information about the `replace` operation, when applicable.", + "items": { + "$ref": "#/components/schemas/Replace1" + } + }, + "date": { + "type": "string", + "description": "Date and time of the request in UTC ISO 8601 format, as in `yyyy-mm-ddThh:mm:ss.sssZ`." + }, + "origin": { + "$ref": "#/components/schemas/OriginV2" + }, + "settings": { + "$ref": "#/components/schemas/Settings" + } + } + }, + "example": { + "requestId": "e8532a32-7f7e-434a-88ec-29609f0ede46", + "workflowId": "74f40e7a-68c6-4699-b874-a8a297fb3f6a", + "status": "done", + "inProgress": false, + "reason": "The client did not like the size.", + "manualDiscountValue": 0, + "manualIncrementValue": 0, + "totalChangeValue": 0, + "totals": [ + { + "id": "ManualValues", + "name": "Manual Values Total", + "value": -1000 + } + ], + "add": null, + "remove": null, + "replace": [ + { + "from": { + "paymentData": { + "transactions": [] + }, + "items": [ + { + "id": "31", + "quantity": 1, + "price": 5000, + "measurementUnit": "un", + "unitMultiplier": 1, + "sellingPrice": 5000, + "name": "Small toy", + "detailUrl": "/small-toy-24/p", + "imageUrl": "http://storename.com/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000" + } + ], + "shippingData": { + "logisticsInfo": [ + { + "itemIndex": 0, + "selectedSla": "Economic", + "selectedDeliveryChannel": "delivery", + "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", + "slas": [ + { + "id": "Economic", + "deliveryChannel": "delivery", + "name": "Economic", + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "DeliverClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 180, + "listPrice": 180, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + }, + { + "id": "Normal", + "deliveryChannel": "delivery", + "name": "Normal", + "deliveryIds": [ + { + "courierId": "1", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "3bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 500, + "listPrice": 500, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "3bd" + }, + { + "id": "Pickup", + "deliveryChannel": "delivery", + "name": "Pickup", + "deliveryIds": [ + { + "courierId": "ech018654", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Pickup", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 700, + "listPrice": 700, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + } + ], + "shipsTo": [ + "BRA" + ], + "itemId": "31", + "deliveryChannels": [ + { + "id": "delivery" + } + ], + "price": 180, + "listPrice": 180, + "shippingEstimate": "25bd", + "dockEstimate": null, + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "deliveryCompany": null, + "polygonName": "", + "transitTime": "25bd", + "sellingPrice": 180, + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": null, + "accountCarrierName": "qastoreecho" + } + ], + "deliveryWindow": null, + "pickupPointId": null, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupDistance": null + } + ] + } + }, + "to": { + "items": [ + { + "uniqueId": "40E763F4378E4F40AD1FE915FE1078E1", + "id": "1", + "productId": "1", + "productRefId": "", + "refId": "codrefxicaraazul", + "ean": "8745121641", + "name": "Blue cup", + "skuName": "cup", + "modalType": null, + "parentItemIndex": null, + "parentAssemblyBinding": null, + "assemblies": [], + "priceValidUntil": null, + "tax": 0, + "price": 5000, + "listPrice": null, + "manualPrice": null, + "manualPriceAppliedBy": null, + "sellingPrice": 5000, + "rewardValue": 0, + "isGift": false, + "additionalInfo": { + "dimension": null, + "brandName": null, + "brandId": null, + "offeringInfo": null, + "offeringType": null, + "offeringTypeId": null, + "categoriesIds": null, + "productClusterId": null, + "commercialConditionId": null + }, + "preSaleDate": null, + "productCategoryIds": "/1/", + "productCategories": { + "1": "Category" + }, + "quantity": 1, + "seller": "1", + "sellerChain": [ + "1" + ], + "imageUrl": "http://storename.com/arquivos/ids/155394-55-55/cup.jpg?v=636565506415770000", + "detailUrl": "/xicara/p", + "components": [], + "bundleItems": [], + "attachments": [], + "attachmentOfferings": [], + "offerings": [], + "priceTags": [], + "availability": null, + "measurementUnit": "un", + "unitMultiplier": 1, + "manufacturerCode": null, + "firstName": "first-name", + "lastName": "last-name", + "documentType": "cpf", + "document": "123456789", + "phone": "+55110988887777", + "corporateName": null, + "tradeName": null, + "corporateDocument": null, + "stateInscription": null, + "corporatePhone": null, + "isCorporate": false, + "priceDefinition": { + "calculatedSellingPrice": 5000, + "total": 5000, + "sellingPrices": [ + { + "value": 5000, + "quantity": 1 + } + ] + } + } + ], + "paymentData": { + "transactions": [] + }, + "receiptData": null, + "shippingData": { + "logisticsInfo": [ + { + "itemIndex": 0, + "selectedSla": "Economic", + "selectedDeliveryChannel": "delivery", + "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", + "slas": [ + { + "id": "Economic", + "deliveryChannel": "delivery", + "name": "Economic", + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 600, + "listPrice": 180, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + }, + { + "id": "Normal", + "deliveryChannel": "delivery", + "name": "Normal", + "deliveryIds": [ + { + "courierId": "1", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "3bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 500, + "listPrice": 500, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "3bd" + }, + { + "id": "Pickup", + "deliveryChannel": "delivery", + "name": "Pickup", + "deliveryIds": [ + { + "courierId": "ech018654", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Pickup", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 700, + "listPrice": 700, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + } + ], + "shipsTo": [ + "BRA" + ], + "itemId": "1", + "deliveryChannels": [ + { + "id": "delivery" + } + ], + "price": 600, + "listPrice": 180, + "shippingEstimate": "25bd", + "dockEstimate": null, + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "deliveryCompany": null, + "polygonName": "", + "transitTime": "25bd", + "sellingPrice": 600, + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Donkey", + "quantity": 1, + "kitItemDetails": null, + "accountCarrierName": "qastoreecho" + } + ], + "deliveryWindow": null, + "pickupPointId": null, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupDistance": null + } + ] + } + } + } + ], + "date": "2024-07-27T17:52:18.6483116Z", + "origin": { + "account": "qastore", + "orderId": "v12772213qst-02", + "component": "MarketplaceComponent" + }, + "settings": { + "customPaymentSystemsAllowed": [ + "201" + ] + } + } + } + } + } + } + } + }, + "/api/order-system/orders/{changeOrderId}/changes/preview": { + "post": { + "tags": [ + "Order modifications" + ], + "summary": "Preview order modifications", + "operationId": "PreviewChange", + "description": "This endpoint allows you to simulate an order modification and preview what the real modification will look like if you use the [Create order modifications](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint. A preview is especially useful for more complex scenarios, such as orders with multiple items and combinations of change operations — add, remove, and replace. Ensuring you get the desired results before making the actual modification helps prevent mistakes.\r\n\r\nThe request body is the same one to be used in the [Create order modifications](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint, and the response body of a successful request provides a preview of the order modifications effect.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Oms |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |Cancel order
Change order
|\r\n| inStore Sales Person |Cancel order
Change order
|\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "parameters": [ + { + "name": "an", + "in": "query", + "description": "Name of the VTEX account that created the order.", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "storeName" + } + }, + { + "name": "changeOrderId", + "in": "path", + "description": "Order ID of the order you wish to preview modification.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "v12772213qst-02" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "required": [ + "reason", + "replace" + ], + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "Reason why you wish to modify the order. Since you can make several modifications to an order, filling this field with a clear explanation helps organize the order modifications history. The shopper can view this field value in [transactional emails](https://help.vtex.com/en/tutorial/order-transactional-email-templates--3g2S2kqBOoSGcCaqMYK2my) and [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh).", + "example": "The client wants to change a weighable product." + }, + "replace": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Replace" + }, + "description": "Name of the change operation you are performing, which can be `replace`, `add` or `remove`. If you want, you can combine all change operations in a single request." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "reason", + "manualDiscountValue", + "manualIncrementValue", + "totalChangeValue", + "totals", + "add", + "remove", + "replace", + "date", + "origin", + "settings" + ], + "properties": { + "reason": { + "type": "string", + "description": "Reason why you wish to modify the order. Since you can make several modifications to an order, filling this field with a clear explanation helps organize the order modifications history. The shopper can view this field value in [transactional emails](https://help.vtex.com/en/tutorial/order-transactional-email-templates--3g2S2kqBOoSGcCaqMYK2my) and [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh)." + }, + "manualDiscountValue": { + "type": "integer", + "description": "This field shows if a manual price was applied to the total order amount. The value is in cents." + }, + "manualIncrementValue": { + "type": "integer", + "description": "This field shows if an increment value was applied to the total order amount. The value is in cents." + }, + "totalChangeValue": { + "type": "integer", + "description": "This field shows how much is the order total price considering that price modifications might have been made. The value is in cents." + }, + "totals": { + "type": "array", + "description": "Array containing total costs information.", + "items": { + "type": "object", + "description": "Total changing price details for a given type of cost.", + "properties": { + "id": { + "type": "string", + "description": "Changing price type, for example the item price or shipping costs." + }, + "name": { + "type": "string", + "description": "Changing price name." + }, + "value": { + "type": "number", + "description": "Changing price value in cents." + } + } + } + }, + "add": { + "type": "array", + "description": "Array with information about the `add` operation, when applicable. The schema will correspond to the object `to` inside the `replace` array.", + "nullable": true, + "items": { + "type": "string", + "description": "Adding operation information, when applicable." + } + }, + "remove": { + "type": "array", + "description": "Array with information about the `remove` operation, when applicable. The schema will correspond to the object `from` inside the `replace` array.", + "nullable": true, + "items": { + "type": "string", + "description": "Removing operation information, when applicable." + } + }, + "replace": { + "type": "array", + "description": "Array with information about the `replace` operation, when applicable.", + "items": { + "type": "object", + "description": "Replacing operation object.", + "required": [ + "from", + "to" + ], + "properties": { + "from": { + "$ref": "#/components/schemas/From2" + }, + "to": { + "$ref": "#/components/schemas/To2" + } + } + } + }, + "date": { + "type": "string", + "description": "Date and time of the request in UTC ISO 8601 format, as in `yyyy-mm-ddThh:mm:ss.sssZ`." + }, + "origin": { + "$ref": "#/components/schemas/OriginV2" + }, + "settings": { + "$ref": "#/components/schemas/Settings" + } + } + }, + "example": { + "reason": "I would like to receive a preview.", + "manualDiscountValue": 0, + "manualIncrementValue": 0, + "totalChangeValue": 420, + "totals": [ + { + "id": "ManualValues", + "name": "Manual Values Total", + "value": 0 + }, + { + "id": "Shipping", + "name": "Shipping Total", + "value": 420 + } + ], + "add": null, + "remove": null, + "replace": [ + { + "from": { + "paymentData": { + "transactions": [] + }, + "items": [ + { + "id": "31", + "quantity": 1, + "price": 5000, + "measurementUnit": "un", + "unitMultiplier": 1, + "sellingPrice": 5000, + "name": "Small toy", + "detailUrl": "/small-toy-24/p", + "imageUrl": "http://storename.com/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000" + } + ], + "shippingData": { + "logisticsInfo": [ + { + "itemIndex": 0, + "selectedSla": "Economic", + "selectedDeliveryChannel": "delivery", + "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", + "slas": [ + { + "id": "Economic", + "deliveryChannel": "delivery", + "name": "Economic", + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "DeliverClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 180, + "listPrice": 180, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + }, + { + "id": "Normal", + "deliveryChannel": "delivery", + "name": "Normal", + "deliveryIds": [ + { + "courierId": "1", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "3bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 500, + "listPrice": 500, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "3bd" + }, + { + "id": "Pickup", + "deliveryChannel": "delivery", + "name": "Pickup", + "deliveryIds": [ + { + "courierId": "ech018654", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Pickup", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 700, + "listPrice": 700, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + } + ], + "shipsTo": [ + "BRA" + ], + "itemId": "31", + "deliveryChannels": [ + { + "id": "delivery" + } + ], + "price": 180, + "listPrice": 180, + "shippingEstimate": "25bd", + "dockEstimate": null, + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "deliveryCompany": null, + "polygonName": "", + "transitTime": "25bd", + "sellingPrice": 180, + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": null, + "accountCarrierName": "qastoreecho" + } + ], + "deliveryWindow": null, + "pickupPointId": null, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupDistance": null + } + ] + } + }, + "to": { + "items": [ + { + "uniqueId": "40E763F4378E4F40AD1FE915FE1078E1", + "id": "1", + "productId": "1", + "productRefId": "", + "refId": "codrefxicaraazul", + "ean": "8745121641", + "name": "Blue cup", + "skuName": "cup", + "modalType": null, + "parentItemIndex": null, + "parentAssemblyBinding": null, + "assemblies": [], + "priceValidUntil": null, + "tax": 0, + "price": 5000, + "listPrice": null, + "manualPrice": null, + "manualPriceAppliedBy": null, + "sellingPrice": 5000, + "rewardValue": 0, + "isGift": false, + "additionalInfo": { + "dimension": null, + "brandName": null, + "brandId": null, + "offeringInfo": null, + "offeringType": null, + "offeringTypeId": null, + "categoriesIds": null, + "productClusterId": null, + "commercialConditionId": null + }, + "preSaleDate": null, + "productCategoryIds": "/1/", + "productCategories": { + "1": "Category" + }, + "quantity": 1, + "seller": "1", + "sellerChain": [ + "1" + ], + "imageUrl": "http://storename.com/arquivos/ids/155394-55-55/cup.jpg?v=636565506415770000", + "detailUrl": "/xicara/p", + "components": [], + "bundleItems": [], + "attachments": [], + "attachmentOfferings": [], + "offerings": [], + "priceTags": [], + "availability": null, + "measurementUnit": "un", + "unitMultiplier": 1, + "manufacturerCode": null, + "priceDefinition": { + "calculatedSellingPrice": 5000, + "total": 5000, + "sellingPrices": [ + { + "value": 5000, + "quantity": 1 + } + ] + } + } + ], + "paymentData": { + "transactions": [] + }, + "receiptData": null, + "shippingData": { + "logisticsInfo": [ + { + "itemIndex": 0, + "selectedSla": "Economic", + "selectedDeliveryChannel": "delivery", + "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", + "slas": [ + { + "id": "Economic", + "deliveryChannel": "delivery", + "name": "Economic", + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 600, + "listPrice": 180, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + }, + { + "id": "Normal", + "deliveryChannel": "delivery", + "name": "Normal", + "deliveryIds": [ + { + "courierId": "1", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "CourierClass", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "3bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 500, + "listPrice": 500, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "3bd" + }, + { + "id": "Pickup", + "deliveryChannel": "delivery", + "name": "Pickup", + "deliveryIds": [ + { + "courierId": "ech018654", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Pickup", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 700, + "listPrice": 700, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + } + ], + "shipsTo": [ + "BRA" + ], + "itemId": "1", + "deliveryChannels": [ + { + "id": "delivery" + } + ], + "price": 600, + "listPrice": 180, + "shippingEstimate": "25bd", + "dockEstimate": null, + "shippingEstimateDate": "2024-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "deliveryCompany": null, + "polygonName": "", + "transitTime": "25bd", + "sellingPrice": 600, + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Donkey", + "quantity": 1, + "kitItemDetails": null, + "accountCarrierName": "qastoreecho" + } + ], + "deliveryWindow": null, + "pickupPointId": null, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupDistance": null + } + ] + } + } + } + ], + "date": "2024-07-27T17:52:18.6483116Z", + "origin": { + "account": "qastore", + "orderId": "v12772213qst-02", + "component": "MarketplaceComponent" + }, + "settings": { + "customPaymentSystemsAllowed": [ + "201" + ] + } + } + } + } + } + } + } + }, + "/api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/retry": { + "post": { + "tags": [ + "Order modifications" + ], + "summary": "Retry order modifications", + "operationId": "RetryChange", + "description": "This endpoint makes a new attempt to perform an order modification previously made using the [Create order modifications](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint that, for some reason, was not completely processed.\r\n\r\nTo make this request, you need the `changeRequestId`, a unique change identification code that you get when you make a [Create order modifications](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) request. When you retry to modify an order using the `changeRequestId`, instead of creating a new modification, you avoid duplications.\r\n\r\nThis endpoint's successful response status code is `204 No Content`, therefore with no response body.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Oms |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |Cancel order
Change order
|\r\n| inStore Sales Person |Cancel order
Change order
|\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "parameters": [ + { + "name": "an", + "in": "query", + "description": "Name of the VTEX account that created the order.", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "storeName" + } + }, + { + "name": "changeOrderId", + "in": "path", + "description": "Order ID of the order you wish to retry modification.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "v12772213qst-02" + } + }, + { + "name": "changeRequestId", + "in": "path", + "description": "Once you make an order modification, you generate a `requestId` code that identifies the modifications made to that order. This field should be filled with that code.\r\n\r\nThere are no limits to modifications you can perform using the same `changeRequestId`, and we recommend keeping all modifications of a given order grouped by the same `changeRequestId`, so you will have a unified modification history.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "e8532a32-7f7e-434a-88ec-29609f0ede46" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Createchange" + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/cancel": { + "post": { + "tags": [ + "Order modifications" + ], + "summary": "Cancel order modifications", + "operationId": "CancelChangeStoppedonError", + "description": "This endpoint cancels an [order modification](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes). It is meant for when, due to an error, a modification was not completely processed, and you do not wish to [retry](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-/retry) it. For this request, you need the order's `changeRequestId`, the unique identification code generated by the [Create order modifications](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) endpoint.\r\n\r\n>⚠️ Once an order modification has been successfully processed, canceling it is no longer possible. If you wish to revert the modifications made to an order, you will have to [create a new order modification](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Oms |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |Cancel order
Change order
|\r\n| inStore Sales Person |Cancel order
Change order
|\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "parameters": [ + { + "name": "an", + "in": "query", + "description": "Name of the VTEX account that created the order.", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "storeName" + } + }, + { + "name": "changeOrderId", + "in": "path", + "description": "Order ID of the order with the modifications you wish to cancel.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "v12772213qst-02" + } + }, + { + "name": "changeRequestId", + "in": "path", + "description": "Once you make an order modification, you generate a `requestId` code that identifies the modifications made to that order. This field should be filled with that code. After cancelling an order modification, the `changeRequestId` will no longer be valid.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "e8532a32-7f7e-434a-88ec-29609f0ede46" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "reason" + ], + "properties": { + "reason": { + "type": "string", + "description": "Reason why you wish to cancel the order modification. The customer will not view the value inserted in this field.", + "example": "I want to cancel this order modification request because it's stopped on a blocking error." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/api/order-system/orders/changes/settings": { + "put": { + "tags": [ + "Order modifications" + ], + "summary": "Update Order modifications settings", + "description": "Updates the [Order modifications](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) settings from a store.\r\n\r\n>ℹ️ To know more about **Order modifications**, see [How Order modifications works](https://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n| OMS | OMS access | **Cancel order** |\r\n| OMS | OMS access | **Change order** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Orders Full Access |\r\n| OMS - Full access |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Oms |Cancel order
Change order
|\r\n| IntegrationProfile - Fulfillment Gateway | Cancel order |\r\n| IntegrationProfile - Fulfillment Gateway Oms |Cancel order
Change order
|\r\n| inStore Sales Person |Cancel order
Change order
|\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "parameters": [ + { + "name": "an", + "in": "query", + "description": "VTEX [account name](https://help.vtex.com/en/tutorial/what-is-an-account-name--i0mIGLcg3QyEy8OCicEoC).", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "storename" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "paymentConfiguration": { + "type": "object", + "description": "[Order modifications](https://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ) payment configurations.", + "properties": { + "customPaymentSystemsAllowed": { + "type": "array", + "description": "List of custom payment system IDs configured for the VTEX account.", + "items": { + "type": "string", + "description": "Payment system ID.", + "example": "201" + } + } + } + }, + "rolloutConfiguration": { + "type": "object", + "description": "**Order modifications** settings regarding VTEX Admin, [Orders API](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes?endpoint=patch-/api/order-system/orders/-changeOrderId-/changes) and **My Account** feature.", + "properties": { + "enableApi": { + "type": "boolean", + "description": "Defines if the account enabled the [Order modifications API](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) (`true`) or not (`false`). The account can only use the [Order modifications via VTEX Admin](https://help.vtex.com/en/tutorial/how-to-change-orders-beta--7btlG91rb6sHpW1dkd2kBw) or [via API](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) if this field is set to `true`.", + "default": false, + "example": true + }, + "enableAdminOrders": { + "type": "object", + "description": "Object about enabling the [Order modifications feature via VTEX Admin](https://help.vtex.com/en/tutorial/how-to-change-orders-beta--7btlG91rb6sHpW1dkd2kBw).", + "properties": { + "enabledWorkspaces": { + "type": "array", + "description": "List with the workspaces' names that have the **Order modifications** feature enabled via VTEX Admin.", + "items": { + "type": "string", + "description": "Name of the workspace with **Order modifications** enabled via VTEX Admin. The asterisk `*` value includes all of the account's workspaces.", + "example": "*" + } + } + } + }, + "enableMyOrders": { + "type": "object", + "description": "Object about enabling the **Order modifications** feature via [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh).", + "properties": { + "enabledWorkspaces": { + "type": "array", + "description": "List with the workspaces' names that have the **Order modifications** feature enabled via **My Account**.", + "items": { + "type": "string", + "description": "Name of the workspace with **Order modifications** enabled via **My Account**. The asterisk `*` value includes all of the account's workspaces.", + "example": "storename" + } + } + } + } + } + }, + "pipelineConfiguration": { + "type": "object", + "description": "**Order modifications** settings related to taxes and shipping calculation.", + "properties": { + "enableTaxHubRecalculation": { + "type": "boolean", + "description": "Defines if the tax calculation is enabled for **Order modifications** (`true`) or not (`false`).", + "default": false, + "example": false + }, + "compensateShippingChanges": { + "type": "boolean", + "description": "Defines if the orders modified will have zero shipping cost (`true`) or not (`false`). Merchants can enable this configuration to modify only items and prices, without impacting the orders' original freight costs.", + "default": false, + "example": true + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChangeOrderSettingsResponse" + }, + "example": { + "paymentConfiguration": { + "customPaymentSystemsAllowed": [ + "201", + "125" + ] + }, + "rolloutConfiguration": { + "usingDefaultBehavior": false, + "enableApi": true, + "enableAdminOrders": { + "enabledWorkspaces": [ + "*" + ] + }, + "enableMyOrders": { + "enabledWorkspaces": [ + "*" + ] + } + }, + "pipelineConfiguration": { + "enableTaxHubRecalculation": false, + "compensateShippingChanges": true + } + } + } + } + } + }, + "operationId": "put_api_orderSystem_orders_changes_settings" + }, + "get": { + "tags": [ + "Order modifications" + ], + "summary": "Get Order modifications settings", + "description": "Retrieves the [Order modifications settings](https://developers.vtex.com/docs/api-reference/orders-api#put-/api/order-system/orders/changes/settings) from a store.\r\n\r\n>ℹ️ To know more about **Order modifications**, see [How Order modifications works](https://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **View order** |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | View order |\r\n| Checkout Admin | View order |\r\n| IntegrationProfile - Fulfillment Oms | View order |\r\n| OMS - Full access | Orders Full Access |\r\n| Checkout Admin | Orders Full Access |\r\n| IntegrationProfile - Fulfillment Oms | Orders Full Access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", + "parameters": [ + { + "name": "an", + "in": "query", + "description": "VTEX [account name](https://help.vtex.com/en/tutorial/what-is-an-account-name--i0mIGLcg3QyEy8OCicEoC).", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "mystore" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChangeOrderSettingsResponse" + }, + "example": { + "paymentConfiguration": { + "customPaymentSystemsAllowed": [ + "201", + "125" + ] + }, + "rolloutConfiguration": { + "usingDefaultBehavior": false, + "enableApi": true, + "enableAdminOrders": { + "enabledWorkspaces": [ + "*" + ] + }, + "enableMyOrders": { + "enabledWorkspaces": [ + "*" + ] + } + }, + "pipelineConfiguration": { + "enableTaxHubRecalculation": false, + "compensateShippingChanges": true + } + } + } + } + } + }, + "operationId": "get_api_orderSystem_orders_changes_settings" + } + } + }, + "security": [ + { + "appKey": [], + "appToken": [] + }, + { + "VtexIdclientAutCookie": [] + } + ], + "components": { + "schemas": { + "Createchange": { + "required": [ + "reason" + ], + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "Reason why you wish to modify order. Since you can make several modifications to an order, filling this field with a clear explanation helps organize the order modifications history. The shopper can view this field value in [transactional emails](https://help.vtex.com/en/tutorial/order-transactional-email-templates--3g2S2kqBOoSGcCaqMYK2my) and [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh).", + "example": "The client wants to change a weighable product." + }, + "replace": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Replace" + }, + "description": "Array containing `replace` change information. Besides `replace`, you can `add` or `remove` items from an order.\r\n\r\n- `add`: the schema will correspond to the object `to` inside the `replace` array.\r\n\r\n- `remove`: the schema will correspond to the object `from` inside the `replace` array.\r\n\r\nYou will find request body examples of both cases in the endpoint description on the top of the page. The successful response `202 - Accepted` schema is the same for all three operations, whether they are used separately or combined in the same request." + } + } + }, + "Replace": { + "required": [ + "from", + "to" + ], + "type": "object", + "description": "Replacing operation object.", + "properties": { + "from": { + "required": [ + "items" + ], + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "required": [ + "id", + "quantity" + ], + "type": "object", + "description": "Information about item being modified.", + "properties": { + "id": { + "type": "string", + "description": "SKU ID of the item that will be modified.", + "example": "1" + }, + "uniqueId": { + "type": "string", + "description": "Unique ID of the item being modified. This field is mandatory when modifying an order that contains items with the same `id`.", + "example": "1D6A12BD177140B2BAF0C042D2FAEE54" + }, + "quantity": { + "type": "integer", + "description": "Quantity of the item being modified. Must be greater than 0.", + "example": 1 + }, + "price": { + "type": "integer", + "description": "Price of the item being changed in cents. Must be 0 or greater.", + "example": 2499 + } + } + }, + "description": "Array with information about the item to be replaced." + }, + "customData": { + "type": "object", + "description": "Object with information about the custom data.", + "properties": { + "customFields": { + "type": "array", + "description": "Array with information about the custom fields.", + "items": { + "type": "object", + "description": "Object with information about the custom fields.", + "properties": { + "linkedEntity": { + "type": "object", + "description": "Object with information about the linked entity. If you wish to modify the linked entity `type` and `id`, you must first use this endpoint to `remove` the old `type` and `id`, then you call this same endpoint to `add` the new `type` and `id`.", + "properties": { + "type": { + "type": "string", + "description": "Type of the linked entity such as `cart`, `item`, `address`.", + "example": "item" + }, + "id": { + "type": "string", + "description": "ID of the linked entity.", + "example": "B2949D0A45244825B177D2F9F96DC711" + } + } + }, + "fields": { + "type": "array", + "description": "Array with information about the custom field's name and value.", + "items": { + "type": "object", + "description": "Object with information about the custom field's name and value. If you wish to modify the custom field's `name` and `value`, you must use the original `name` and `value` on the object `to` inside the `replace` array and use the updated `name` and `value` on the object `from` inside the `replace` array.", + "properties": { + "name": { + "type": "string", + "description": "Name of the custom field.", + "example": "desktop" + }, + "value": { + "type": "string", + "description": "Value of the custom field.", + "example": "DSK-OLD" + } + } + } + } + } + } + } + } + } + }, + "description": "Object with information about the items been replaced. If instead of an order `replace` you wish to `remove` items, you will use the same schema naming the object `remove` instead of `from`. For a complete example, see the description at the top of the page." + }, + "to": { + "required": [ + "items" + ], + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "required": [ + "id", + "quantity" + ], + "type": "object", + "description": "Replacing item details.", + "properties": { + "id": { + "type": "string", + "description": "SKU ID of the item that will replace the previous one. If you only wish to replace the product weight, you will repeat the SKU ID used in `from`.", + "example": "1" + }, + "uniqueId": { + "type": "string", + "description": "Unique ID of the item being modified. This field is mandatory when modifying an order that contains items with the same `id`.", + "example": "1D6A12BD177140B2BAF0C042D2FAEE54" + }, + "quantity": { + "type": "integer", + "description": "Updated quantity of the item being modified. Must be greater than 0.", + "example": 1 + }, + "measurementUnit": { + "type": "string", + "description": "Measurement unit of the new item. The values accepted are the measurement units registered in the store's catalog. For example, `kg` for kilograms or `un` for unitary items. When you don't specify a value, the request gets the information from the Catalog.", + "example": "kg" + }, + "unitMultiplier": { + "type": "number", + "description": "Unit multiplier for item update. For example, if you wish to increase an order with three times more items than a single one, you would fill in with `3.0`.", + "example": 3 + }, + "manualDiscountValue": { + "type": "integer", + "description": "This field shows if a manual price was applied to the total order amount. The value is in cents. Must be 0 or greater.", + "example": 0 + }, + "manualIncrementValue": { + "type": "integer", + "description": "This field shows if an increment value was applied to the total order amount. The value is in cents. Must be 0 or greater.", + "example": 0 + }, + "clientProfileData": { + "type": "array", + "items": { + "type": "object", + "description": "Object with information on the client's profile.", + "properties": { + "firstName": { + "type": "string", + "description": "Customer's first name.", + "example": "first-name" + }, + "lastName": { + "type": "string", + "description": "Customer's last name.", + "example": "last-name" + }, + "documentType": { + "type": "string", + "description": "Type of the document informed by the customer.", + "example": "cpf" + }, + "document": { + "type": "string", + "description": "Document number informed by the customer.", + "example": "123456789" + }, + "phone": { + "type": "string", + "description": "Customer's phone number.", + "example": "55110988887777" + }, + "corporateName": { + "type": "string", + "description": "If it's a legal entity, here goes the company name.", + "example": null + }, + "tradeName": { + "type": "string", + "description": "If it's a legal entity, here goes the trade name.", + "example": null + }, + "corporateDocument": { + "type": "string", + "description": "If it's a legal entity, here goes the corporate document.", + "example": null + }, + "stateInscription": { + "type": "string", + "description": "If it's a legal entity, here goes the state inscription.", + "example": null + }, + "corporatePhone": { + "type": "string", + "description": "If it's a legal entity, here goes the company phone.", + "example": null + }, + "isCorporate": { + "type": "boolean", + "description": "It has the value `true` if it's a legal entity.", + "example": false + } + } + } + } + } + }, + "description": "Array with information about the replacing items." + }, + "customData": { + "type": "object", + "description": "Object with information about the custom data.", + "properties": { + "customFields": { + "type": "array", + "description": "Array with information about the custom fields.", + "items": { + "type": "object", + "description": "Object with information about the custom fields.", + "properties": { + "linkedEntity": { + "type": "object", + "description": "Object with information about the linked entity. If you wish to modify the linked entity `type` and `id`, you must first use this endpoint to `remove` the old `type` and `id`, then you call this same endpoint to `add` the new `type` and `id`.", + "properties": { + "type": { + "type": "string", + "description": "Type of the linked entity such as `cart`, `item`, `address`.", + "example": "item" + }, + "id": { + "type": "string", + "description": "ID of the linked entity.", + "example": "B2949D0A45244825B177D2F9F96DC711" + } + } + }, + "fields": { + "type": "array", + "description": "Array with information about the custom field's name and value.", + "items": { + "type": "object", + "description": "Object with information about the custom field's name and value. If you wish to modify the custom field's `name` and `value`, you must use the original `name` and `value` on the object `to` inside the `replace` array and use the updated `name` and `value` on the object `from` inside the `replace` array.", + "properties": { + "name": { + "type": "string", + "description": "Name of the custom field.", + "example": "desktop" + }, + "value": { + "type": "string", + "description": "Value of the custom field.", + "example": "DSK-NEW" + } + } + } + } + } + } + } + } + }, + "shippingData": { + "required": [ + "logisticsInfo" + ], + "type": "object", + "description": "Shipping data object.", + "properties": { + "logisticsInfo": { + "type": "array", + "items": { + "required": [ + "itemIndex", + "selectedSla", + "selectedDeliveryChannel", + "addressId", + "price" + ], + "type": "object", + "description": "Shipping details of the modified order.", + "properties": { + "itemIndex": { + "type": "integer", + "description": "Index that identifies the position of this item in the original array, starting from `0`.", + "example": 0 + }, + "selectedSla": { + "type": "string", + "description": "Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the order.", + "example": "Normal" + }, + "selectedDeliveryChannel": { + "type": "string", + "description": "Order shipping type, which can be `pickup-in-point` for [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R), and `delivery` for delivery.", + "enum": [ + "delivery", + "pickup-in-point" + ], + "example": "delivery" + }, + "addressId": { + "type": "string", + "description": "Shipping address ID.", + "example": "9ec276fd3a604eb1aa151b5333ca5db7" + }, + "price": { + "type": "integer", + "description": "Shipping price for the item in cents. Does not account for the whole order's shipping price.", + "example": 1000 + } + } + }, + "description": "Array containing information about the shipping address of the modified order. This field is optional, when you don't send it the request body, the system assumes there were no modifications in shipping." + } + } + } + }, + "description": "Object with information about the new replacing items. If instead of an order `replace` you wish to `add` items, you will use the same schema naming the object `add` instead of `to`. For a complete example, see the description at the top of the page." + } + } + }, + "response202": { + "required": [ + "requestId", + "workflowId", + "reason", + "manualDiscountValue", + "manualIncrementValue", + "totalChangeValue", + "totals", + "add", + "remove", + "replace", + "date", + "origin", + "settings" + ], + "type": "object", + "properties": { + "requestId": { + "type": "string", + "description": "Unique code that identifies an order modification request." + }, + "workflowId": { + "type": "string", + "description": "Code that identifies the transaction of modifying the orders in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196)." + }, + "reason": { + "type": "string", + "description": "Reason that motivated the order modifications." + }, + "manualDiscountValue": { + "type": "integer", + "description": "This field shows if a manual price was applied to the total order amount. The value is in cents." + }, + "manualIncrementValue": { + "type": "integer", + "description": "This field shows if an increment value was applied to the total order amount. The value is in cents." + }, + "totalChangeValue": { + "type": "integer", + "description": "This field shows how much the order total price is considering that price modifications might have been made. The value is in cents." + }, + "totals": { + "type": "array", + "items": { + "type": "string", + "description": "Item changing price details." + }, + "description": "Array containing information about change prices per item." + }, + "add": { + "type": "array", + "description": "Array with information about the `add` operation, when applicable. The schema will correspond to the object `to` inside the `replace` array.", + "nullable": true, + "items": { + "type": "string", + "description": "Adding details." + } + }, + "remove": { + "type": "array", + "description": "Array with information about the `remove` operation, when applicable. The schema will correspond to the object `from` inside the `replace` array.", + "nullable": true, + "items": { + "type": "string", + "description": "Removal details." + } + }, + "replace": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Replace1" + }, + "description": "Array with information about the `replace` operation, when applicable.", + "nullable": true + }, + "date": { + "type": "string", + "description": "Date and time of the request. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`." + }, + "origin": { + "$ref": "#/components/schemas/OriginV2" + }, + "settings": { + "$ref": "#/components/schemas/Settings" + } + } + }, + "Replace1": { + "required": [ + "from", + "to" + ], + "type": "object", + "description": "Details about what will be replaced.", + "properties": { + "from": { + "required": [ + "paymentData", + "items", + "shippingData" + ], + "type": "object", + "properties": { + "paymentData": { + "$ref": "#/components/schemas/PaymentDataV2" + }, + "items": { + "type": "array", + "description": "Array with items information.", + "items": { + "required": [ + "id", + "quantity", + "price", + "measurementUnit", + "unitMultiplier", + "sellingPrice", + "name", + "detailUrl", + "imageUrl" + ], + "type": "object", + "description": "Details about a given item.", + "properties": { + "id": { + "type": "string", + "description": "SKU ID of the item being replaced." + }, + "quantity": { + "type": "integer", + "description": "Quantity of items been replaced." + }, + "price": { + "type": "integer", + "nullable": true, + "description": "Shipping price for the replaced item, in cents. It does not account for the whole order's shipping price." + }, + "measurementUnit": { + "type": "string", + "nullable": true, + "description": "Measurement unit of the item being replaced. For example, `kg` for kilograms or `un` for unitary items." + }, + "unitMultiplier": { + "type": "integer", + "description": "Unit multiplier for item being updated." + }, + "sellingPrice": { + "type": "string", + "description": "Selling price of the item being replaced.", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true, + "description": "Name of the item being replaced." + }, + "detailUrl": { + "type": "string", + "nullable": true, + "description": "URL slug of the item being replaced." + }, + "imageUrl": { + "type": "string", + "nullable": true, + "description": "Image URL slug of the item being replaced." + } + } + } + }, + "shippingData": { + "$ref": "#/components/schemas/ShippingData1" + } + }, + "description": "Information about what items were replaced." + }, + "to": { + "required": [ + "items", + "paymentData", + "receiptData", + "shippingData" + ], + "type": "object", + "description": "Information about items that replaced the previous one.", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Item3" + }, + "description": "Array containing information about the item replacing the previous one." + }, + "paymentData": { + "$ref": "#/components/schemas/PaymentDataV2" + }, + "receiptData": { + "type": "object", + "nullable": true, + "description": "Information about the receipt after order modifications." + }, + "shippingData": { + "type": "object", + "description": "Shipping data object.", + "required": [ + "logisticsInfo" + ], + "properties": { + "logisticsInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LogisticsInfo1" + }, + "description": "Array with shipping information." + } + } + }, + "clientProfileData": { + "type": "array", + "items": { + "type": "object", + "description": "Object with information on the client's profile.", + "properties": { + "firstName": { + "type": "string", + "description": "Customer's first name." + }, + "lastName": { + "type": "string", + "description": "Customer's last name." + }, + "documentType": { + "type": "string", + "description": "Type of the document informed by the customer." + }, + "document": { + "type": "string", + "description": "Document number informed by the customer." + }, + "phone": { + "type": "string", + "description": "Customer's phone number." + }, + "corporateName": { + "type": "string", + "description": "If it's a legal entity, here goes the company name." + }, + "tradeName": { + "type": "string", + "description": "If it's a legal entity, here goes the trade name." + }, + "corporateDocument": { + "type": "string", + "description": "If it's a legal entity, here goes the corporate document." + }, + "stateInscription": { + "type": "string", + "description": "If it's a legal entity, here goes the state inscription." + }, + "corporatePhone": { + "type": "string", + "description": "If it's a legal entity, here goes the company phone." + }, + "isCorporate": { + "type": "boolean", + "description": "It has the value `true` if it's a legal entity." + } + } + } + } + } + } + } + }, + "PaymentDataV2": { + "type": "object", + "description": "Payment data object.", + "required": [ + "transactions" + ], + "properties": { + "transactions": { + "type": "array", + "description": "Information about financial transactions.", + "items": { + "type": "string", + "description": "Array containing financial information. This is an optional field.", + "example": "creditcard" + } + } + } + }, + "ShippingData1": { + "description": "Shipping data object.", + "required": [ + "logisticsInfo" + ], + "type": "object", + "properties": { + "logisticsInfo": { + "type": "array", + "description": "Array with logistics information about the order been replaced. If not sent in the original request, it will be an empty array in the response.", + "items": { + "type": "string", + "description": "Logistics details." + } + } + } + }, + "Item3": { + "type": "object", + "description": "Object with item details.", + "required": [ + "uniqueId", + "id", + "productId", + "productRefId", + "refId", + "ean", + "name", + "skuName", + "modalType", + "parentItemIndex", + "parentAssemblyBinding", + "assemblies", + "priceValidUntil", + "tax", + "price", + "listPrice", + "manualPrice", + "manualPriceAppliedBy", + "sellingPrice", + "rewardValue", + "isGift", + "additionalInfo", + "preSaleDate", + "productCategoryIds", + "productCategories", + "quantity", + "seller", + "sellerChain", + "imageUrl", + "detailUrl", + "components", + "bundleItems", + "attachments", + "attachmentOfferings", + "offerings", + "priceTags", + "availability", + "measurementUnit", + "unitMultiplier", + "manufacturerCode", + "priceDefinition" + ], + "properties": { + "uniqueId": { + "type": "string", + "description": "Item's unique ID in the order modifications request.", + "example": "40E763F4378E4F40AD1FE915FE1078E1" + }, + "id": { + "type": "string", + "description": "SKU ID of the item replacing the previous one.", + "example": "3" + }, + "productId": { + "type": "string", + "nullable": true, + "description": "Product ID of the item replacing the previous one.", + "example": "7" + }, + "productRefId": { + "type": "string", + "nullable": true, + "description": "Product Ref ID of the item replacing the previous one.", + "example": "smallcup" + }, + "refId": { + "type": "string", + "nullable": true, + "description": "Reference ID of the item replacing the previous one.", + "example": "356" + }, + "ean": { + "type": "string", + "nullable": true, + "description": "European Article Number (EAN) of the item replacing the previous one.", + "example": "8745121641680" + }, + "name": { + "type": "string", + "nullable": true, + "description": "Name of the Product associated with the item replacing the previous one.", + "example": "Small cup of coffee with pink logo" + }, + "skuName": { + "type": "string", + "nullable": true, + "description": "Name of the SKU replacing the previous one.", + "example": "Small blue cup" + }, + "modalType": { + "type": "string", + "nullable": true, + "description": "A [modal](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125) attaches an unusual product, such as meat or glass, to a carrier specialized in shipping it.", + "example": "GLASS" + }, + "parentItemIndex": { + "type": "integer", + "nullable": true, + "description": "Parent item index of the item replacing the previous one.", + "example": 0 + }, + "parentAssemblyBinding": { + "type": "string", + "nullable": true, + "description": "Parent assembly binding of the item replacing the previous one.", + "example": null + }, + "assemblies": { + "type": "array", + "description": "Array with information about services that may be offered for the item replacing the previous one. For example, the assembly of a piece of furniture or warranty.", + "nullable": true, + "items": { + "type": "string", + "description": "Customization information." + } + }, + "priceValidUntil": { + "type": "string", + "nullable": true, + "description": "Price expiration date of item replacing the previous one. The value is in the format `yyyy-mm-ddThh:mm:ss.sss`.", + "example": "2023-03-01T22:58:28.143" + }, + "tax": { + "type": "integer", + "description": "Tax in cents of the item replacing the previous one, when applicable.", + "example": 0 + }, + "price": { + "type": "integer", + "nullable": true, + "description": "Final price of the item replacing the previous one, calculated in cents.", + "example": 600 + }, + "listPrice": { + "type": "integer", + "nullable": true, + "description": "Item's price list for the item replacing the previous one.", + "example": 600 + }, + "manualPrice": { + "type": "integer", + "nullable": true, + "description": "Manual price of the item replacing the previous one. It is calculated in cents.", + "example": 6500 + }, + "manualPriceAppliedBy": { + "type": "string", + "nullable": true, + "description": "User ID or appKey that made the manual price modification of the item replacing the previous one.", + "example": "4cc81d44-e42e-464b-8199-1e883bf4ab6b" + }, + "sellingPrice": { + "type": "integer", + "nullable": true, + "description": "Selling price of the item replacing the previous one. It is calculated in cents.", + "example": 600 + }, + "rewardValue": { + "type": "integer", + "description": "Reward value of the item replacing the previous one. It is calculated in cents.", + "example": 50 + }, + "isGift": { + "type": "boolean", + "description": "This field is `true` when the replacing item is a gift in the order context and `false` when it is not.", + "example": false + }, + "additionalInfo": { + "$ref": "#/components/schemas/AdditionalInfoV2" + }, + "preSaleDate": { + "type": "string", + "nullable": true, + "description": "Pre sale date of the item replacing the previous one.", + "example": "2023-01-01T00:00:00.0000000+00:00" + }, + "productCategoryIds": { + "type": "string", + "nullable": true, + "description": "Replacing item's category path composed of category IDs separated by `/`. For example: `/3/15/`.", + "example": "/2/" + }, + "productCategories": { + "type": "object", + "description": "Object containing product categories of the replacing item. Structure: `{CategoryID}: {CategoryName}`. Both the key and the value are strings.", + "example": { + "2": "Clothes" + } + }, + "quantity": { + "type": "integer", + "description": "Quantity of replacing items.", + "example": 1 + }, + "seller": { + "type": "string", + "nullable": true, + "description": "Seller ID that identifies the seller the replacing item belongs to.", + "example": "1" + }, + "sellerChain": { + "type": "array", + "description": "Array containing information about sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory) order.", + "nullable": true, + "items": { + "type": "string", + "description": "Seller identification.", + "nullable": true + } + }, + "imageUrl": { + "type": "string", + "nullable": true, + "description": "Image URL slug of the replacing item.", + "example": "http://store.com.br/ids/155419-55-55//cupcoffee.png?v=6368858582363" + }, + "detailUrl": { + "type": "string", + "nullable": true, + "description": "URL slug of the replacing item.", + "example": "/cup-coffee/p" + }, + "components": { + "type": "array", + "items": { + "type": "string", + "description": "Replacing item's component." + }, + "description": "Array with information about replacing item's components." + }, + "bundleItems": { + "type": "array", + "items": { + "type": "string", + "description": "Service sold with the replacing item." + }, + "description": "Array with information about services sold along with the replacing item, such as a gift package." + }, + "attachments": { + "type": "array", + "items": { + "type": "string", + "description": "Information about a given attachment." + }, + "description": "Array containing information on attachments." + }, + "attachmentOfferings": { + "type": "array", + "items": { + "type": "string", + "description": "Information about a given offering." + }, + "description": "Array with the properties of the content declared in the field `attachments`." + }, + "offerings": { + "type": "array", + "items": { + "type": "string", + "description": "Item's offering." + }, + "description": "Array with replacing items Item's offerings." + }, + "priceTags": { + "type": "array", + "items": { + "type": "string", + "description": "Item modifier." + }, + "description": "Array containing objects with replacing item's price modifiers." + }, + "availability": { + "type": "string", + "nullable": true, + "description": "Availability to fulfill the order with the item.", + "example": "available" + }, + "measurementUnit": { + "type": "string", + "description": "Replacing item's measurement unit.", + "example": "un" + }, + "unitMultiplier": { + "type": "integer", + "description": "Replacing item's unit multiplier.", + "example": 1 + }, + "manufacturerCode": { + "type": "string", + "nullable": true, + "description": "Provided by the manufacturers to identify their product. This field must be completed if the replacing item has a manufacturer's code.", + "example": "manf-00005" + }, + "priceDefinition": { + "type": "string", + "nullable": true, + "description": "Replacing item's price information.", + "example": null + } + } + }, + "AdditionalInfoV2": { + "type": "object", + "description": "Additional information object.", + "required": [ + "dimension", + "brandName", + "brandId", + "offeringInfo", + "offeringType", + "offeringTypeId", + "categoriesIds", + "productClusterId", + "commercialConditionId" + ], + "properties": { + "dimension": { + "type": "string", + "nullable": true, + "description": "Replacing item's dimensions in the measure unit configured in the catalog.", + "example": null + }, + "brandName": { + "type": "string", + "nullable": true, + "description": "Replacing item's brand name.", + "example": "Special coffee cup" + }, + "brandId": { + "type": "string", + "nullable": true, + "description": "Replacing item's brand ID.", + "example": "2000001" + }, + "offeringInfo": { + "type": "string", + "nullable": true, + "description": "Offering information.", + "example": null + }, + "offeringType": { + "type": "string", + "nullable": true, + "description": "Offering type.", + "example": null + }, + "offeringTypeId": { + "type": "string", + "nullable": true, + "description": "Offering type ID.", + "example": null + }, + "categoriesIds": { + "type": "string", + "nullable": true, + "description": "ID of the replacing item product category.", + "example": null + }, + "productClusterId": { + "type": "string", + "nullable": true, + "description": "All product clusters related to the replacing item.", + "example": "135,137,143,518,1272" + }, + "commercialConditionId": { + "type": "string", + "nullable": true, + "description": "Replacing item commercial conditions ID.", + "example": "5" + } + } + }, + "LogisticsInfo1": { + "type": "object", + "description": "Logistics information object.", + "required": [ + "itemIndex", + "selectedSla", + "addressId", + "slas", + "shipsTo", + "itemId", + "deliveryChannels", + "price", + "listPrice", + "shippingEstimate", + "dockEstimate", + "shippingEstimateDate", + "lockTTL", + "deliveryCompany", + "polygonName", + "transitTime", + "sellingPrice", + "deliveryIds", + "deliveryWindow", + "pickupPointId", + "pickupStoreInfo", + "pickupDistance" + ], + "properties": { + "itemIndex": { + "type": "integer", + "description": "Index that identifies the position of the replacing item in the array, starting from `0`.", + "example": 0 + }, + "selectedSla": { + "type": "string", + "description": "Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the replacing order.", + "example": "Normal" + }, + "addressId": { + "type": "string", + "description": "Shipping address ID of the replacing item.", + "example": "9ec276fd3a604eb1aa151b5333ca5db7" + }, + "slas": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SlaV2" + }, + "description": "Information on Service Level Agreement (SLA) of the order modifications shipping policy." + }, + "shipsTo": { + "type": "array", + "items": { + "type": "string", + "description": "Country name represented in a three letters code ISO 3166 ALPHA-3.", + "example": "BRA" + }, + "description": "List of countries of the order modification shipping address." + }, + "itemId": { + "type": "string", + "description": "Replacing item's SKU ID, which is a unique numerical identifier.", + "example": "3" + }, + "deliveryChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryChannel" + }, + "description": "Array with the delivery channels associated with the trade policy." + }, + "price": { + "type": "integer", + "description": "Replacing item's final price, calculated in cents.", + "example": 600 + }, + "listPrice": { + "type": "integer", + "description": "Replacing item's price list, calculated in cents.", + "example": 600 + }, + "shippingEstimate": { + "type": "string", + "nullable": true, + "description": "Replacing item's shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.", + "example": "2023-07-29T17:52:18.6483116Z" + }, + "dockEstimate": { + "type": "string", + "nullable": true, + "description": "Replacing item's estimate duration of the [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) time. For instance, one business day is represented as `1bd`.", + "example": "1bd" + }, + "shippingEstimateDate": { + "type": "string", + "nullable": true, + "description": "Replacing item's total shipping duration estimated in days. For instance, three business days are represented as `3bd`.", + "example": "3bd" + }, + "lockTTL": { + "type": "string", + "nullable": true, + "description": "Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA. For instance, one business day is represented as `1bd`.", + "example": "1bd" + }, + "deliveryCompany": { + "type": "string", + "nullable": true, + "description": "[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) company's name.", + "example": "Correios" + }, + "polygonName": { + "type": "string", + "nullable": true, + "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.", + "example": "114 - Polanco _ H-05" + }, + "transitTime": { + "type": "string", + "nullable": true, + "description": "Duration in business days of the time the [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) takes in transit to fulfill the order. For example, three business days are represented as `3bd`.", + "example": "3bd" + }, + "sellingPrice": { + "type": "integer", + "description": "Change item's selling price.", + "example": 600 + }, + "deliveryIds": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryIdV2" + }, + "description": "Array with delivery information." + }, + "deliveryWindow": { + "type": "string", + "nullable": true, + "description": "Order modification [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.", + "example": null + }, + "pickupPointId": { + "type": "string", + "nullable": true, + "description": "ID of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).", + "example": "pup215rkw" + }, + "pickupStoreInfo": { + "$ref": "#/components/schemas/PickupStoreInfoV2" + }, + "pickupDistance": { + "type": "number", + "nullable": true, + "description": "Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.", + "example": "1.0" + } + } + }, + "SlaV2": { + "description": "Service Level Agreement (SLA) object.", + "required": [ + "id", + "deliveryChannel", + "name", + "deliveryIds", + "shippingEstimate", + "shippingEstimateDate", + "lockTTL", + "availableDeliveryWindows", + "deliveryWindow", + "price", + "listPrice", + "tax", + "pickupStoreInfo", + "pickupPointId", + "pickupDistance", + "polygonName", + "transitTime" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the order delivery or pickup.", + "example": "Normal" + }, + "deliveryChannel": { + "type": "string", + "description": "Order shipping type, which can be `pickup-in-point` for [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R), and `delivery` for delivery.", + "example": "delivery" + }, + "name": { + "type": "string", + "description": "Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the order delivery or pickup. It corresponds to the `id` value.", + "example": "Normal" + }, + "deliveryIds": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryIdV2" + }, + "description": "Information about delivery IDs." + }, + "shippingEstimate": { + "type": "string", + "nullable": true, + "description": "Total shipping duration estimated in days. For instance, three business days is represented as `3bd`.", + "example": "3bd" + }, + "shippingEstimateDate": { + "type": "string", + "nullable": true, + "description": "Shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.", + "example": "2023-07-27T17:52:18.6483116Z" + }, + "lockTTL": { + "type": "string", + "nullable": true, + "description": "Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA. For instance, one business day is represented as `1bd`.", + "example": "1bd" + }, + "availableDeliveryWindows": { + "type": "array", + "items": { + "type": "string", + "description": "Delivery window." + }, + "description": "Available [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, for when the shipping policy has shipping windows configurations." + }, + "deliveryWindow": { + "type": "object", + "nullable": true, + "description": "[Scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.", + "properties": { + "startDateUtc": { + "type": "string", + "description": "Delivery window starting date and time in [UTC ISO 8601 format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", + "example": "2024-03-14T00:00:00+00:00" + }, + "endDateUtc": { + "type": "string", + "description": "Delivery window ending date and time in [UTC ISO 8601 format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", + "example": "2024-03-14T23:59:59+00:00" + } + } + }, + "price": { + "type": "integer", + "description": "Shipping price for the item in cents. Does not account for the whole order's shipping price.", + "example": 600 + }, + "listPrice": { + "type": "integer", + "description": "Item's price list for a specific trade policy.", + "example": 600 + }, + "tax": { + "type": "integer", + "description": "Tax in cents, when applicable.", + "example": 0 + }, + "pickupStoreInfo": { + "$ref": "#/components/schemas/PickupStoreInfoV2" + }, + "pickupPointId": { + "type": "string", + "nullable": true, + "description": "Pickup point ID is the unique identifier of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) related to the SLA.", + "example": "pup215rkw" + }, + "pickupDistance": { + "type": "number", + "nullable": true, + "description": "Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.", + "example": 1 + }, + "polygonName": { + "type": "string", + "nullable": true, + "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.", + "example": "114 - Polanco _ H-05" + }, + "transitTime": { + "type": "string", + "nullable": true, + "description": "Duration in business days of the time the [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) takes in transit to fulfill the order. For example, three business days is represented as `3bd`.", + "example": "3bd" + } + } + }, + "PickupStoreInfoV2": { + "type": "object", + "description": "Information about a loading dock that was transformed into a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).", + "required": [ + "isPickupStore", + "friendlyName", + "address", + "additionalInfo", + "dockId" + ], + "deprecated": true, + "properties": { + "isPickupStore": { + "type": "boolean", + "description": "This field is related to converting a loading dock into a pickup point. It should always correspond to `false` because it has been deprecated.", + "example": false, + "nullable": true, + "deprecated": true + }, + "friendlyName": { + "type": "string", + "description": "Name of the loading dock converted to pickup point to be displayed at checkout. This field has been deprecated.", + "example": null, + "nullable": true, + "deprecated": true + }, + "address": { + "type": "string", + "nullable": true, + "description": "Address of the loading dock converted to pickup point. This field has been deprecated.", + "example": null, + "deprecated": true + }, + "additionalInfo": { + "type": "string", + "nullable": true, + "description": "Additional information about the loading dock converted to pickup point. This field has been deprecated.", + "example": null, + "deprecated": true + }, + "dockId": { + "type": "string", + "nullable": true, + "description": "ID of the loading dock converted to pickup point. This field has been deprecated.", + "example": "dockAjs28", + "deprecated": true + } + } + }, + "OriginV2": { + "required": [ + "account", + "orderId", + "component" + ], + "type": "object", + "properties": { + "account": { + "type": "string", + "description": "Name of the account where the order was made." + }, + "orderId": { + "type": "string", + "description": "Order ID is a unique code that identifies an order." + }, + "component": { + "type": "string", + "description": "Component information." + } + }, + "description": "Object containing information about the order origin." + }, + "Settings": { + "required": [ + "customPaymentSystemsAllowed" + ], + "type": "object", + "description": "Object with account settings information, such as custom payment.", + "properties": { + "customPaymentSystemsAllowed": { + "type": "array", + "description": "Store's [custom payment](https://help.vtex.com/tutorial/how-to-configure-a-custom-payment--tutorials_451) information. Applicable only for stores that configured custom payment options.", + "items": { + "type": "string", + "description": "Custom payment code." + } + } + } + }, + "From2": { + "type": "object", + "description": "What the order is changing from.", + "required": [ + "paymentData", + "items", + "shippingData" + ], + "properties": { + "paymentData": { + "$ref": "#/components/schemas/PaymentDataV2" + }, + "items": { + "type": "array", + "description": "Items information from before the order change.", + "items": { + "$ref": "#/components/schemas/Item4" + } + }, + "shippingData": { + "$ref": "#/components/schemas/ShippingData3" + } + } + }, + "Item4": { + "title": "Item4", + "required": [ + "id", + "quantity", + "price", + "measurementUnit", + "unitMultiplier", + "sellingPrice", + "name", + "detailUrl", + "imageUrl" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "SKU ID of the item.", + "example": "1" + }, + "quantity": { + "type": "integer", + "description": "Quantity of items been replaced.", + "example": 1 + }, + "price": { + "type": "string", + "nullable": true, + "description": "Item's shipping price. It does not account for the whole order's shipping price and is presented in cents.", + "example": 1000 + }, + "measurementUnit": { + "type": "string", + "nullable": true, + "description": "Item's measurement unit. For example, `kg` for kilograms or `un` for unitary items.", + "example": "kg" + }, + "unitMultiplier": { + "type": "integer", + "description": "Item's unit multiplier.", + "example": 3 + }, + "sellingPrice": { + "type": "string", + "description": "Item's selling price.", + "example": 100 + }, + "name": { + "type": "string", + "nullable": true, + "description": "Item's name.", + "example": "T-shirt with logo" + }, + "detailUrl": { + "type": "string", + "nullable": true, + "description": "Item's URL slug.", + "example": "/tshirt-logo/p" + }, + "imageUrl": { + "type": "string", + "nullable": true, + "description": "Item's image URL slug.", + "example": "http://store.com.br/ids/155419-55-55//tshirt-logo.png?v=6378858562367" + } + }, + "example": { + "id": "31", + "quantity": 1, + "price": 5000, + "measurementUnit": "un", + "unitMultiplier": 1, + "sellingPrice": 5000, + "name": "Fusca miniatura Fusca preto", + "detailUrl": "/fusca-miniatura-24/p", + "imageUrl": "http://qastore.vteximg.com.br/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000" + } + }, + "ShippingData3": { + "title": "ShippingData3", + "required": [ + "logisticsInfo" + ], + "type": "object", + "properties": { + "logisticsInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LogisticsInfo2" + }, + "description": "Array with shipping information." + } + }, + "example": { + "logisticsInfo": [ + { + "itemIndex": 0, + "selectedSla": "Lenta", + "selectedDeliveryChannel": "delivery", + "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", + "slas": [ + { + "id": "Lenta", + "deliveryChannel": "delivery", + "name": "Lenta", + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Donkey", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": "2023-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 180, + "listPrice": 180, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + }, + { + "id": "Normal", + "deliveryChannel": "delivery", + "name": "Normal", + "deliveryIds": [ + { + "courierId": "1", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Transportadora", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "3bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 500, + "listPrice": 500, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "3bd" + }, + { + "id": "Pickup", + "deliveryChannel": "delivery", + "name": "Pickup", + "deliveryIds": [ + { + "courierId": "ech018654", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Retirada", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 700, + "listPrice": 700, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + } + ], + "shipsTo": [ + "BRA" + ], + "itemId": "31", + "deliveryChannels": [ + { + "id": "delivery" + } + ], + "price": 180, + "listPrice": 180, + "shippingEstimate": "25bd", + "dockEstimate": null, + "shippingEstimateDate": "2023-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "deliveryCompany": null, + "polygonName": "", + "transitTime": "25bd", + "sellingPrice": 180, + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Donkey", + "quantity": 1, + "kitItemDetails": null, + "accountCarrierName": "qastoreecho" + } + ], + "deliveryWindow": null, + "pickupPointId": null, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupDistance": null + } + ] + } + }, + "LogisticsInfo2": { + "title": "LogisticsInfo2", + "required": [ + "itemIndex", + "selectedSla", + "addressId", + "slas", + "shipsTo", + "itemId", + "deliveryChannels", + "price", + "listPrice", + "shippingEstimate", + "dockEstimate", + "shippingEstimateDate", + "lockTTL", + "deliveryCompany", + "polygonName", + "transitTime", + "sellingPrice", + "deliveryIds", + "deliveryWindow", + "pickupPointId", + "pickupStoreInfo", + "pickupDistance" + ], + "type": "object", + "properties": { + "itemIndex": { + "type": "integer", + "description": "Index that identifies the position of the replacing item in the array, starting from `0`.", + "example": 0 + }, + "selectedSla": { + "type": "string", + "description": "Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the replacing order.", + "example": "Normal" + }, + "addressId": { + "type": "string", + "description": "Shipping address ID.", + "example": "9ec276fd3a604eb1aa151b5333ca5db7" + }, + "slas": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SlaV2" + }, + "description": "Information on Service Level Agreement (SLA) of the order modifications." + }, + "shipsTo": { + "type": "array", + "items": { + "type": "string", + "description": "Country name represented in a three letters code ISO 3166 ALPHA-3.", + "example": "BRA" + }, + "description": "List of countries of the order modifications shipping address." + }, + "itemId": { + "type": "string", + "description": "Replacing item's SKU ID, which is a unique numerical identifier.", + "example": "3" + }, + "deliveryChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryChannel" + }, + "description": "Array with the delivery channels associated with the trade policy." + }, + "price": { + "type": "integer", + "description": "Item's final price, calculated in cents.", + "example": 600 + }, + "listPrice": { + "type": "integer", + "description": "Item's price list, calculated in cents.", + "example": 600 + }, + "shippingEstimate": { + "type": "string", + "nullable": true, + "description": "Item's shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.", + "example": "2023-07-29T17:52:18.6483116Z" + }, + "dockEstimate": { + "type": "string", + "nullable": true, + "description": "Item's estimate duration of the [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) time. For instance, one business day is represented as `1bd`.", + "example": "1bd" + }, + "shippingEstimateDate": { + "type": "string", + "nullable": true, + "description": "Replacing item's total shipping duration estimated in days. For instance, three business days are represented as `3bd`.", + "example": "3bd" + }, + "lockTTL": { + "type": "string", + "nullable": true, + "description": "Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA. For instance, one business day is represented as `1bd`.", + "example": "1bd" + }, + "deliveryCompany": { + "type": "string", + "nullable": true, + "description": "[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) company's name.", + "example": "Correios" + }, + "polygonName": { + "type": "string", + "nullable": true, + "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.", + "example": "114 - Polanco _ H-05" + }, + "transitTime": { + "type": "string", + "nullable": true, + "description": "Duration in business days of the time the [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) takes in transit to fulfill the order. For example, three business days are represented as `3bd`.", + "example": "3bd" + }, + "sellingPrice": { + "type": "integer", + "description": "Item's selling price.", + "example": 600 + }, + "deliveryIds": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryIdV2" + }, + "description": "Array with delivery information." + }, + "deliveryWindow": { + "type": "string", + "nullable": true, + "description": "Order modifications [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.", + "example": null + }, + "pickupPointId": { + "type": "string", + "nullable": true, + "description": "ID of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).", + "example": "pup215rkw" + }, + "pickupStoreInfo": { + "$ref": "#/components/schemas/PickupStoreInfoV2" + }, + "pickupDistance": { + "type": "number", + "nullable": true, + "description": "Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.", + "example": 1 + } + }, + "example": { + "itemIndex": 0, + "selectedSla": "Lenta", + "selectedDeliveryChannel": "delivery", + "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", + "slas": [ + { + "id": "Lenta", + "deliveryChannel": "delivery", + "name": "Lenta", + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Donkey", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": "2023-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 180, + "listPrice": 180, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + }, + { + "id": "Normal", + "deliveryChannel": "delivery", + "name": "Normal", + "deliveryIds": [ + { + "courierId": "1", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Transportadora", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "3bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 500, + "listPrice": 500, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "3bd" + }, + { + "id": "Pickup", + "deliveryChannel": "delivery", + "name": "Pickup", + "deliveryIds": [ + { + "courierId": "ech018654", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Retirada", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 700, + "listPrice": 700, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + } + ], + "shipsTo": [ + "BRA" + ], + "itemId": "31", + "deliveryChannels": [ + { + "id": "delivery" + } + ], + "price": 180, + "listPrice": 180, + "shippingEstimate": "25bd", + "dockEstimate": null, + "shippingEstimateDate": "2023-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "deliveryCompany": null, + "polygonName": "", + "transitTime": "25bd", + "sellingPrice": 180, + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Donkey", + "quantity": 1, + "kitItemDetails": null, + "accountCarrierName": "qastoreecho" + } + ], + "deliveryWindow": null, + "pickupPointId": null, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupDistance": null + } + }, + "DeliveryIdV2": { + "title": "DeliveryIdV2", + "required": [ + "courierId", + "warehouseId", + "dockId", + "courierName", + "quantity", + "kitItemDetails", + "accountCarrierName" + ], + "type": "object", + "properties": { + "courierId": { + "type": "string", + "description": "ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).", + "example": "136769c" + }, + "warehouseId": { + "type": "string", + "description": "ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).", + "example": "w_156" + }, + "dockId": { + "type": "string", + "description": "ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).", + "example": "ld931" + }, + "courierName": { + "type": "string", + "description": "Name of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).", + "example": "Crossborder" + }, + "quantity": { + "type": "integer", + "description": "Quantity of items.", + "example": 1 + }, + "kitItemDetails": { + "type": "array", + "items": { + "type": "string", + "description": "Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), when applicable to the order.", + "example": null, + "nullable": true + } + }, + "accountCarrierName": { + "type": "string", + "nullable": true, + "description": "Name of the account's [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE).", + "example": "vtexlog" + } + }, + "example": { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Donkey", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + }, + "DeliveryChannel": { + "title": "DeliveryChannel", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Order modifications shipping type, which can be `pickup-in-point` for [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R), and `delivery` for delivery.", + "example": "delivery" + } + }, + "example": { + "id": "delivery" + } + }, + "To2": { + "title": "To2", + "required": [ + "items", + "paymentData", + "receiptData", + "shippingData" + ], + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Item3" + }, + "description": "Array containing information about the item replacing the previous one." + }, + "paymentData": { + "$ref": "#/components/schemas/PaymentDataV2" + }, + "receiptData": { + "type": "object", + "nullable": true, + "description": "Information about the receipt after order modifications.", + "example": null + }, + "shippingData": { + "$ref": "#/components/schemas/ShippingData3" + } + }, + "example": { + "items": [ + { + "uniqueId": "40E763F4378E4F40AD1FE915FE1078E1", + "id": "1", + "productId": "1", + "productRefId": "", + "refId": "codrefxicaraazul", + "ean": "8745121641", + "name": "xícara azul", + "skuName": "azul", + "modalType": null, + "parentItemIndex": null, + "parentAssemblyBinding": null, + "assemblies": [], + "priceValidUntil": null, + "tax": 0, + "price": 5000, + "listPrice": null, + "manualPrice": null, + "manualPriceAppliedBy": null, + "sellingPrice": 5000, + "rewardValue": 0, + "isGift": false, + "additionalInfo": { + "dimension": null, + "brandName": null, + "brandId": null, + "offeringInfo": null, + "offeringType": null, + "offeringTypeId": null, + "categoriesIds": null, + "productClusterId": null, + "commercialConditionId": null + }, + "preSaleDate": null, + "productCategoryIds": "/1/", + "productCategories": { + "1": "Category" + }, + "quantity": 1, + "seller": "1", + "sellerChain": [ + "1" + ], + "imageUrl": "http://qastore.vteximg.com.br/arquivos/ids/155394-55-55/xicara.jpg?v=636565506415770000", + "detailUrl": "/xicara/p", + "components": [], + "bundleItems": [], + "attachments": [], + "attachmentOfferings": [], + "offerings": [], + "priceTags": [], + "availability": null, + "measurementUnit": "un", + "unitMultiplier": 1, + "manufacturerCode": null, + "priceDefinition": { + "calculatedSellingPrice": 5000, + "total": 5000, + "sellingPrices": [ + { + "value": 5000, + "quantity": 1 + } + ] + } + } + ], + "paymentData": { + "transactions": [] + }, + "receiptData": null, + "shippingData": { + "logisticsInfo": [ + { + "itemIndex": 0, + "selectedSla": "Lenta", + "selectedDeliveryChannel": "delivery", + "addressId": "9ec276fd3a604eb1aa151b5333ca5db6", + "slas": [ + { + "id": "Lenta", + "deliveryChannel": "delivery", + "name": "Lenta", + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Donkey", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": "2023-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 600, + "listPrice": 180, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + }, + { + "id": "Normal", + "deliveryChannel": "delivery", + "name": "Normal", + "deliveryIds": [ + { + "courierId": "1", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Transportadora", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "3bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 500, + "listPrice": 500, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "3bd" + }, + { + "id": "Pickup", + "deliveryChannel": "delivery", + "name": "Pickup", + "deliveryIds": [ + { + "courierId": "ech018654", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Retirada", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + ], + "shippingEstimate": "25bd", + "shippingEstimateDate": null, + "lockTTL": "12d", + "availableDeliveryWindows": [], + "deliveryWindow": null, + "price": 700, + "listPrice": 700, + "tax": 0, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupPointId": null, + "pickupDistance": null, + "polygonName": "", + "transitTime": "25bd" + } + ], + "shipsTo": [ + "BRA" + ], + "itemId": "1", + "deliveryChannels": [ + { + "id": "delivery" + } + ], + "price": 600, + "listPrice": 180, + "shippingEstimate": "25bd", + "dockEstimate": null, + "shippingEstimateDate": "2023-08-30T10:17:24.6436519Z", + "lockTTL": "12d", + "deliveryCompany": null, + "polygonName": "", + "transitTime": "25bd", + "sellingPrice": 600, + "deliveryIds": [ + { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Donkey", + "quantity": 1, + "kitItemDetails": null, + "accountCarrierName": "qastoreecho" + } + ], + "deliveryWindow": null, + "pickupPointId": null, + "pickupStoreInfo": { + "isPickupStore": false, + "friendlyName": null, + "address": null, + "additionalInfo": null, + "dockId": null + }, + "pickupDistance": null + } + ] + } + } + }, + "ChangeOrderSettingsResponse": { + "type": "object", + "description": "Object with all VTEX account settings related to the **Order modifications** feature.", + "properties": { + "paymentConfiguration": { + "type": "object", + "description": "[Order modifications](https://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ) payment configurations.", + "properties": { + "customPaymentSystemsAllowed": { + "type": "array", + "description": "List of custom payment system IDs configured for the VTEX account.", + "items": { + "type": "string", + "description": "Payment system ID." + } + } + } + }, + "rolloutConfiguration": { + "type": "object", + "description": "**Order modifications** settings regarding VTEX Admin, [Orders API](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes?endpoint=patch-/api/order-system/orders/-changeOrderId-/changes) and **My Account** feature.", + "properties": { + "usingDefaultBehavior": { + "type": "boolean", + "description": "Defines if the **Order modifications** configurations are the default behaviour (`true`) or if the account made customizations to it (`false`). Subaccounts will have the same configurations as the main account.", + "default": false + }, + "enableApi": { + "type": "boolean", + "description": "Defines if the account enabled the [Order modifications API](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) (`true`) or not (`false`). The account can only use the [Order modifications via VTEX Admin](https://help.vtex.com/en/tutorial/how-to-change-orders-beta--7btlG91rb6sHpW1dkd2kBw) or [via API](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) if this field is set to `true`.", + "default": false + }, + "enableAdminOrders": { + "type": "object", + "description": "Object about enabling the [Order modifications feature via VTEX Admin](https://help.vtex.com/en/tutorial/how-to-change-orders-beta--7btlG91rb6sHpW1dkd2kBw).", + "properties": { + "enabledWorkspaces": { + "type": "array", + "description": "List with the workspaces' names that have the **Order modifications** feature enabled via VTEX Admin.", + "items": { + "type": "string", + "description": "Name of the workspace with **Order modifications** enabled via VTEX Admin. The asterisk `*` value includes all of the account's workspaces." + } + } + } + }, + "enableMyOrders": { + "type": "object", + "description": "Object about enabling the **Order modifications** feature via [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh).", + "properties": { + "enabledWorkspaces": { + "type": "array", + "description": "List with the workspace names that have the **Order modifications** feature enabled via **My Account**.", + "items": { + "type": "string", + "description": "Name of the workspace with **Order modifications** enabled via **My Account**. The asterisk `*` value includes all of the account's workspaces." + } + } + } + } + } + }, + "pipelineConfiguration": { + "type": "object", + "description": "**Order modifications** settings related to taxes and shipping calculation.", + "properties": { + "enableTaxHubRecalculation": { + "type": "boolean", + "description": "Defines if the tax calculation is enabled for **Order modifications** (`true`) or not (`false`).", + "default": false + }, + "compensateShippingChanges": { + "type": "boolean", + "description": "Defines if orders changed will have zero shipping cost (`true`) or not (`false`). Merchants usually enable this configuration to change only items and prices, without impacting the orders original freight costs.", + "default": false + } + } + } + } + } + } + }, + "tags": [ + { + "name": "Orders" + }, + { + "name": "Order modifications" + }, + { + "name": "Invoice" + }, + { + "name": "Tracking" + }, + { + "name": "Conversation" + }, + { + "name": "Payment" + }, + { + "name": "Feed v2 (deprecated)" + }, + { + "name": "Feed v3" + }, + { + "name": "Order hook" + }, + { + "name": "User orders" + }, + { + "name": "Change seller" + } + ] +} diff --git a/clients/manitou/output/orders.orders.json b/clients/manitou/output/orders.orders.json new file mode 100644 index 0000000000..7c7307a646 --- /dev/null +++ b/clients/manitou/output/orders.orders.json @@ -0,0 +1,2433 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "Orders API (Orders)", + "description": "Each purchase a customer makes in your store generates an [order](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) on VTEX. With the Orders API, you can view orders statuses and manage multiple aspects involved in order fulfillment, such as financial transactions, invoicing, shipping, and subscriptions. You can also [modify orders](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) and make configurations to allow or forbid marketplaces and sellers to change or cancel orders.\r\n\r\n## Order integration\n\r\nTo automate actions related to order processing, you can [integrate orders](https://developers.vtex.com/docs/guides/erp-integration-guide) with systems like ERP (Enterprise Resource Planning) and WMS (Warehouse Management System) using [Feed and Hook](https://developers.vtex.com/docs/guides/orders-feed).\r\n\r\n## Orders API Index\r\n\r\n### Orders\r\n\r\n- `GET` [Get order](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders/-orderId-)\r\n- `GET` [Get orders by order group ID](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders/order-group/-orderGroup-)\r\n- `GET` [List orders](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders)\r\n- `POST` [Start handling order](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/start-handling)\r\n- `POST` [Cancel order](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/cancel)\r\n- `POST` [Register modifications on order](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/changes)\r\n\r\n### Order modifications\r\n\r\n- `PATCH` [Create order modifications](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes)\r\n- `POST` [Preview order modifications](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/order-system/orders/-changeOrderId-/changes/preview)\r\n- `GET`[Get order modifications details](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-)\r\n- `GET`[Get order modifications history](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes)\r\n- `GET` [Get order modifications summary](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/orders/pvt/document/-changeOrderId-/change-summary) \r\n- `POST` [Retry order modifications](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-/retry)\r\n- `POST`[Cancel order modifications](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/order-system/orders/-changeOrderId-/changes/-changeRequestId-/cancel)\r\n- `PUT`[Update Order modifications settings](https://developers.vtex.com/docs/api-reference/orders-api#put-/api/order-system/orders/changes/settings)\r\n- `GET` [Get Order modifications settings](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/changes/settings)\r\n\r\n### Invoice\r\n\r\n- `POST` [Order invoice notification](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/invoice)\r\n- `PATCH` [Update order's partial invoice (send tracking number)](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-)\r\n\r\n### Tracking\r\n\r\n- `PUT` [Update order tracking status](https://developers.vtex.com/docs/api-reference/orders-api#put-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-/tracking)\r\n\r\n### Conversation\r\n\r\n- `GET` [Retrieve order conversation](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders/-orderId-/conversation-message)\r\n\r\n### Payment\r\n\r\n- `GET` [Retrieve payment transaction](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders/-orderId-/payment-transaction)\r\n- `POST` [Send payment notification](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/payments/-paymentId-/payment-notification)\r\n\r\n### Feed v2 (deprecated)\r\n\r\n- `GET` [Get feed order status](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/feed/orders/status)\r\n\r\n### Feed v3\r\n\r\n- `GET` [Get feed configuration](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/orders/feed/config)\r\n- `POST` [Create or update feed configuration](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/feed/config)\r\n- `DELETE` [Delete feed configuration](https://developers.vtex.com/docs/api-reference/orders-api#delete-/api/orders/feed/config)\r\n- `GET` [Retrieve feed items](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/orders/feed)\r\n- `POST` [Commit feed items](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/feed)\r\n- `POST` [Test JSONata expression](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/expressions/jsonata)\r\n\r\n### Order hook\r\n\r\n- `GET` [Get hook configuration](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/orders/hook/config)\r\n- `POST` [Create or update hook configuration](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/hook/config)\r\n- `DELETE` [Delete hook configuration](https://developers.vtex.com/docs/api-reference/orders-api#delete-/api/orders/hook/config)\r\n\r\n### User orders\r\n\r\n- `GET` [Retrieve user's orders](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/user/orders)\r\n- `GET` [Retrieve user order details](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/user/orders/-orderId-)\r\n\r\n### Change seller\r\n\r\n- `GET` [Get window to change seller](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/checkout/pvt/configuration/window-to-change-seller)\r\n- `POST` [Update window to change seller](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/checkout/pvt/configuration/window-to-change-seller)\r\n\r\n## Common parameters\r\n\r\n| **Parameter name** | **Description** | **Type** |\r\n| :---: | :--- | :--- |\r\n| `{{accountName}}` | Name of the VTEX account. Used as part of the URL. | Server variable. |\r\n| `{{environment}}` | Environment to use. Used as part of the URL. The default value is `vtexcommercestable`. | Server variable. |\r\n| `X-VTEX-API-AppKey` | Unique identifier of the [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys). | Authentication header. Must be used together with `X-VTEX-API-AppToken`. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `X-VTEX-API-AppToken` | Secret token of the [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys). | Authentication header. Must be used together with X-VTEX-API-AppKey. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `VtexIdclientAutCookie` | [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours. | Authentication header. Not necessary when using `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken`. |", + "contact": {}, + "version": "1.0" + }, + "servers": [ + { + "url": "https://{accountName}.{environment}.com.br", + "description": "VTEX server URL.", + "variables": { + "accountName": { + "description": "Name of the VTEX account. Used as part of the URL.", + "default": "apiexamples" + }, + "environment": { + "description": "Environment to use. Used as part of the URL.", + "enum": [ + "vtexcommercestable" + ], + "default": "vtexcommercestable" + } + } + } + ], + "paths": { + "/api/orders/feed/config": { + "get": { + "tags": [ + "Feed v3" + ], + "summary": "Get feed configuration", + "description": "The Orders Feed v3 is the best way to create order integrations. Below you can find details on the configuration API specification, and to know more see our [Feed v3 guide](https://developers.vtex.com/vtex-rest-api/docs/orders-feed) and our [order integration guide](https://developers.vtex.com/vtex-rest-api/docs/erp-integration-set-up-order-integration).\n\r\n> 📘 Onboarding guide \r\n>\r\n> Check the new [Orders onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/orders-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Orders and is organized by focusing on the developer's journey.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS Access | **Feed v3 and Hook view only** |\r\n| OMS | OMS Access | **Feed v3 and Hook Admin** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "operationId": "GetFeedConfiguration", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "filter": { + "type": "object", + "description": "Information on how orders are filtered to show on the feed.", + "properties": { + "type": { + "type": "string", + "description": "Determines what orders appear in the feed and how they are filtered. If a feed has the `FromWorkflow` type configuration, it will receive order updates only when order's statuses change and orders can be filtered by status, using the `status` field. A feed with the `FromOrders` type configuration gets updates whenever any change is made to an order. in this case, orders can be filtered by any property, according to JSONata expressions set in the `expression` field." + }, + "status": { + "type": "array", + "description": "List of order statuses that should be included in the feed. This should only be used in case `type` is `FromWorkflow`.", + "items": { + "type": "string", + "description": "Order status to be filtered in the feed." + } + }, + "expression": { + "type": "string", + "description": "JSONata query expression that defines what conditions must be met for an order to be included in the feed. This should only be used in case `type` is `FromOrders`." + }, + "disableSingleFire": { + "type": "boolean", + "description": "Sets a limit to how many times a specific order shows on the feed, after it first meets filtering conditions. Using the `FromOrders` type configuration with JSONata filtering expressions might cause orders to appear more than once on a feed, whenever changes are made to that order. If this field is `false` orders will appear in the feed only once." + } + } + }, + "queue": { + "type": "object", + "description": "Information that define the functioning of the queue.", + "properties": { + "visibilityTimeoutInSeconds": { + "type": "integer", + "description": "Period of time for which an item is not visible in the feed after it has been retrieved with the Get feed items request. Measured in seconds." + }, + "MessageRetentionPeriodInSeconds": { + "type": "integer", + "description": "Maximum life span of an order update after it gets to the feed. When a feed item is on the feed for this period of time, it is removed from the feed. Measured in seconds. The maximum number accepted in this field is `1209600` seconds." + } + } + }, + "quantity": { + "type": "integer", + "description": "Current number of messages in the feed, including messages that may not be visible due to time out after retrieval." + }, + "approximateAgeOfOldestMessageInSeconds": { + "type": "number", + "description": "Aproximate age of the oldest message in the feed, measured in seconds." + } + } + }, + "example": { + "filter": { + "type": "FromOrders", + "expression": "status = \"payment-pending\"", + "disableSingleFire": false + }, + "queue": { + "visibilityTimeoutInSeconds": 240, + "messageRetentionPeriodInSeconds": 345600 + }, + "quantity": 127, + "approximateAgeOfOldestMessageInSeconds": 78.91597222222222 + } + } + } + } + } + }, + "post": { + "tags": [ + "Feed v3" + ], + "summary": "Create or update feed configuration", + "description": "The Orders Feed v3 is the best way to create order integrations. Below you can find details on the configuration API specification, and to know more see our [Feed v3 guide](https://developers.vtex.com/vtex-rest-api/docs/orders-feed) and our [order integration guide](https://developers.vtex.com/vtex-rest-api/docs/erp-integration-set-up-order-integration)\n\r\n\rThere are two types of filtering that can be used. The `FromWorkflow` type filters orders by status, whereas the `FromOrders` type uses JSONata expressions to filter orders according to any property in the orders JSON document. This enables stores to filter delivered orders and orders in which products have been added or removed, for example. To learn more, access the [JSONata documentation](https://docs.jsonata.org/overview.html) and test filtering JSONata expressions with our [Test JSONata expression](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/expressions/jsonata) endpoint.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS Access | **Feed v3 and Hook view only** |\r\n| OMS | OMS Access | **Feed v3 and Hook Admin** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "operationId": "FeedConfiguration", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "filter", + "queue" + ], + "properties": { + "filter": { + "type": "object", + "description": "Object with type and status that will filter feed orders.", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "description": "Determines what orders appear in the feed and how they are filtered. There are two possible values:\n\r\n\r-`FromWorkflow`: the feed will receive order updates only when order's statuses change and orders can be filtered by status, using the `status` field described below.\n\r\n\r-`FromOrders`: the feed gets updates whenever any change is made to an order. In this case, orders can be filtered by any property, according to JSONata expressions passed in the `expression` field described below.", + "example": "FromWorkflow" + }, + "status": { + "type": "array", + "items": { + "type": "string", + "description": "Order status included in the feed.", + "example": "invoiced" + }, + "description": "List of order statuses that should be included in the feed. This should only be used in case `type` is set to `FromWorkflow`. The status event will be removed, if it can't deliver a message more than 100 times, 4 days progressively. \r\n\r\n**Status available to filter** \r\n\r\n- order-created \n\r\n- on-order-completed \n\r\n- on-order-completed-ffm \n\r\n- payment-pending \n\r\n- waiting-for-order-authorization \n\r\n- approve-payment \n\r\n- payment-approved \n\r\n- request-cancel \n\r\n- waiting-for-seller-decision \n\r\n- waiting-ffmt-authorization \n\r\n- waiting-for-authorization \n\r\n- waiting-for-manual-authorization \n\r\n- authorize-fulfillment \n\r\n- order-create-error \n\r\n- order-creation-error \n\r\n- window-to-cancel \n\r\n- window-to-change-seller \n\r\n- waiting-for-mkt-authorization \n\r\n- waiting-seller-handling \n\r\n- ready-for-handling \n\r\n- start-handling \n\r\n- handling \n\r\n- invoice-after-cancellation-deny \n\r\n- order-accepted \n\r\n- invoice \n\r\n- invoiced \n\r\n- replaced \n\r\n- cancellation-requested \n\r\n- cancel \n\r\n- canceled.", + "example": [ + "order-created", + "on-order-completed", + "payment-pending", + "waiting-for-order-authorization", + "approve-payment", + "payment-approved", + "request-cancel", + "waiting-for-seller-decision", + "authorize-fulfillment", + "order-create-error", + "order-creation-error", + "window-to-cancel", + "canceled" + ] + }, + "expression": { + "type": "string", + "description": "JSONata query expression that defines what conditions must be met for an order to be included in the feed. This should only be used in case `type` is set to `FromOrders`.", + "example": "value > 100" + }, + "disableSingleFire": { + "type": "boolean", + "description": "Sets a limit to how many times a specific order shows on the feed, after it first meets filtering conditions. Using the `FromOrders` type configuration with JSONata filtering expressions might cause orders to appear more than once on a feed, whenever changes are made to that order. If this field is `false` orders will appear in the feed only once.", + "example": false + } + } + }, + "queue": { + "type": "object", + "description": "Object with information about timeout and message retention.", + "required": [ + "visibilityTimeoutInSeconds", + "MessageRetentionPeriodInSeconds" + ], + "properties": { + "visibilityTimeoutInSeconds": { + "type": "integer", + "description": "Period of time for which an item becomes invisible after it has been [retrieved](https://developers.vtex.com/vtex-rest-api/reference/feed-v3#getfeedorderstatus1). Measured in seconds.", + "example": 250 + }, + "MessageRetentionPeriodInSeconds": { + "type": "integer", + "description": "Maximum life span of an order update in the feed. When a feed item is on the feed for this period of time, it is removed from the feed. Measured in seconds. The maximum number accepted in this field is `1209600` seconds.", + "example": 345600 + } + } + } + } + }, + "example": { + "filter": { + "type": "FromOrders", + "expression": "value > 100", + "disableSingleFire": false + }, + "queue": { + "visibilityTimeoutInSeconds": 250, + "MessageRetentionPeriodInSeconds": 345600 + } + } + } + } + }, + "responses": { + "200": { + "description": "Success" + }, + "403": { + "description": "The credentials are not enabled to access the service" + }, + "404": { + "description": "Value not found" + }, + "429": { + "description": "Too many requests" + } + } + }, + "delete": { + "tags": [ + "Feed v3" + ], + "summary": "Delete feed configuration", + "description": "Deletes the configuration set up in [Feed v3](https://developers.vtex.com/docs/guides/orders-feed). \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS Access | **Feed v3 and Hook view only** |\r\n| OMS | OMS Access | **Feed v3 and Hook Admin** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "operationId": "FeedConfigurationDelete", + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad request - Unable to check address / Only https scheme is accepted" + }, + "403": { + "description": "The credentials are not enabled to access the service" + }, + "404": { + "description": "Value not found" + }, + "429": { + "description": "Too many requests" + } + } + } + }, + "/api/orders/feed": { + "get": { + "tags": [ + "Feed v3" + ], + "summary": "Retrieve feed items", + "description": "Retrieve items from [feed](https://developers.vtex.com/docs/guides/orders-feed) queue. \n\r\nThe event will be removed if the message `send retry` is equal to, or greater than the maximum retention period.\r\n\r\n> This API will return `404 Not Found` if there is no [Feed Configuration](https://developers.vtex.com/docs/guides/orders-feed) available for the given X-VTEX-API-AppKey.", + "operationId": "Getfeedorderstatus1", + "parameters": [ + { + "name": "maxlot", + "in": "query", + "description": "Lot quantity to retrieve. Maximum accepted value is 10.", + "required": true, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "{{maxLot}}" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Getfeedorderstatus" + } + }, + "example": [ + { + "eventId": "ED423DDED4C1AE580CADAC1A4D02DA3F", + "handle": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoidnRleGFwcGtleS1wYXJ0bmVyc2xhdGFtLVJNQkpNUyIsIkFwcEtleSI6InZ0ZXhhcHBrZXktcGFydG5lcnNsYXRhbS1STUJKTVMiLCJBY2NvdW50IjoicGFydG5lcnNsYXRhbSIsIkhhbmRsZSI6IkFRRUIzbmtWR0piOXhhNGRjYlpkOTFVVWMyL2JObHc0Qnp3ZlNLV201Rjg2QXgrSGlRM053bEJkb2NwM2wvVytLdjFNQTZ4d3ZLcFYwYjlSeUttNVRpb3hrSVFMSG1Uck9xenB2aFlwU29uMzRrVmlNaWZHY2lnZFFqalBJdk00eWU4amVuaS9QKytaTmVxOFZWeFNGay81Yzg3YS84MTRjTFg2WGZPR2x2WitlTnVjTzA3S3UxK0xXaU5vQmJEY0cycGxKekxkRks3Qld3b1NTV3BmSWhrOGhmSFNkSzlzZVpJeG01QXFLbHFrUHNDNGk5emVaYVpBUVVrSi9aZWo3UjRrRDVRaXFjNmpjcnFheEdHc1lsNHMzUWM0ZmtWdmhYblJVQ2l2ZGdpMEtUYS8zcXlWWU9QTktIV2huTlZxMEZHNDNjME4vaWh6dDc0d1laNVl6aDFJRitHU2t1YTkrN1pCdnQ2VGs1cFRhZmVVclk0ckNPL2Fobnl1eXFLOG53ZkorVWxUTmt2ZVNFS29FdTNiUWQzSmc5R1lYWHlXOVVxRGo5dHJIZ1N5M3ZZa0dBWjd0MDZNZWUwQnBsdFBxWExaIiwiT3JkZXJJZCI6Ijk1MzcxMjAwNDEyNi0wMSIsIk1lc3NhZ2VJZCI6ImI5YjI4NDkwLTNjNzAtNDdjNi1hMTE3LWNhN2FjMTk2MDY1OSIsIkRvbWFpbiI6IkZ1bGZpbGxtZW50IiwiU3RhdGUiOiJyZWFkeS1mb3ItaGFuZGxpbmciLCJMYXN0U3RhdGUiOiJ3aW5kb3ctdG8tY2FuY2VsIiwiTGFzdENoYW5nZSI6IjA4LzEyLzIwMTkgMjA6NTQ6MDEiLCJDdXJyZW50Q2hhbmdlIjoiMDgvMTIvMjAxOSAyMDo1NDoyMyIsIkNyZWF0ZWRBdCI6IjA4LzEyLzIwMTkgMjE6MDE6MzAiLCJpc3MiOiJicm9hZGNhc3QtYXBpLnZ0ZXhjb21tZXJjZS5jb20uYnIiLCJhdWQiOiJwYXJ0bmVyc2xhdGFtX3Z0ZXhhcHBrZXktcGFydG5lcnNsYXRhbS1STUJKTVMifQ.7RQBZQb6pHhFhA_jMKTiSoJbDck7awgD3Xx7sdJcW6w", + "domain": "Fulfillment", + "state": "ready-for-handling", + "lastState": "window-to-cancel", + "orderId": "953712004126-01", + "lastChange": "2019-08-12T20:54:01.134057Z", + "currentChange": "2019-08-12T20:54:23.7153839Z" + } + ] + } + } + } + } + }, + "post": { + "tags": [ + "Feed v3" + ], + "summary": "Commit feed items", + "description": "Commit items in the [feed](https://developers.vtex.com/docs/guides/orders-feed) queue.\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "operationId": "Commititemfeedorderstatus", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "handles" + ], + "properties": { + "handles": { + "type": "array", + "description": "List of item handles to commit.", + "items": { + "type": "string", + "description": "Item handles." + } + } + } + }, + "example": { + "handles": [ + "AQEBSM/bSqonHYtx+UrHdbuJ0i7M9yMbI2jtYwMIPdEc4BenuneaCTC9VEJ3dgAy1XtfQvHBvgwZTO8LvGObIKNqiKXDZiMKY25vK+pblZEqf1pWdLMugu5XoHA5ZAd4IcBcXrBcrlr1GU8uvPEBoVLOsVBP9IAxIZkkeEedIDg3K6GPyEXVuPlTEYb/0OCunEGxWF+AZ1frFdXh7ulORTcuqO5oDlBGbpD+QYzCmF4mUZtQ0VVWh9icM1QBVh6PlJ0D/lfwnJKWpBn3jf8c+DTm7sD7wb1Lcz9uWMLhDtPwvH9vue4MvKU9sCahEQe7K5jWuwwb54szGbFKdfcACsTSQ9WlyBfMdbV83c27k68G3cnaBFExkC1MLHHE9UzpQ6l4s43BT4k95ocgMXffnj/HMUYXn+OCvlvjytY59x1OCRE=" + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/api/orders/hook/config": { + "get": { + "tags": [ + "Order hook" + ], + "summary": "Get hook configuration", + "description": "Retrieves a given hook's configuration details. Learn more with the [orders hook guide](https://developers.vtex.com/vtex-rest-api/docs/orders-feed#hook). \r\n\r\n> 📘 Onboarding guide \r\n>\r\n> Check the new [Orders onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/orders-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Orders and is organized by focusing on the developer's journey.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS Access | **Feed v3 and Hook view only** |\r\n| OMS | OMS Access | **Feed v3 and Hook Admin** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "operationId": "GetHookConfiguration", + "parameters": [ + { + "name": "clientEmail", + "in": "query", + "description": "Customer email.", + "required": false, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "customer@mail.com" + } + }, + { + "name": "page", + "in": "query", + "description": "Page number for result pagination.", + "required": false, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "10" + } + }, + { + "name": "per_page", + "in": "query", + "description": "Page quantity for result pagination.", + "required": false, + "style": "form", + "explode": true, + "schema": { + "type": "string", + "example": "15" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + }, + "post": { + "tags": [ + "Order hook" + ], + "summary": "Create or update hook configuration", + "description": "Configures filtering rules applied to orders hook. Learn more with the [orders hook guide](https://developers.vtex.com/vtex-rest-api/docs/orders-feed#hook).\n\r\n\rThere are two types of filtering that can be used: \n\r\n\r - `FromWorkflow`: filters orders by status.\n\r\n\r - `FromOrders`: uses JSONata expressions to filter orders according to any property in the orders JSON document.\n\r\n\r This enables stores to filter delivered orders and orders in which products have been added or removed, for example.\n\r\n\rTo learn more, access the [JSONata documentation](https://docs.jsonata.org/overview.html) and test filtering JSONata expressions with our [expressions API](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/expressions/jsonata).\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "operationId": "HookConfiguration", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HookConfigurationRequest" + }, + "example": { + "filter": { + "type": "FromOrders", + "expression": "value > 100", + "disableSingleFire": false + }, + "hook": { + "url": "https://endpoint.example/path", + "headers": { + "key": "value" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HookConfiguration" + }, + "example": { + "Domain": "Fulfillment", + "OrderId": "v52277740atmc-01", + "State": "ready-for-handling", + "LastState": "window-to-cancel", + "LastChange": "2019-08-14T17:11:39.2550122Z", + "CurrentChange": "2019-08-14T17:12:48.0965893Z", + "Origin": { + "Account": "automacaoqa", + "Key": "vtexappkey-appvtex" + } + } + } + } + } + } + }, + "delete": { + "tags": [ + "Order hook" + ], + "summary": "Delete hook configuration", + "description": "Deletes a given hook configuration.\n\r\n\rLearn more with the [orders hook guide](https://developers.vtex.com/vtex-rest-api/docs/orders-feed#hook).", + "operationId": "DeleteHookConfiguration", + "responses": { + "200": { + "description": "Success" + }, + "403": { + "description": "[The credentials are not enabled to access the service](https://httpstatuses.com/403)" + }, + "404": { + "description": "[Value not found](https://httpstatuses.com/404)" + }, + "429": { + "description": "[Too many requests](https://httpstatuses.com/429)" + } + } + } + }, + "/api/orders/pvt/document/{orderId}/change-summary": { + "get": { + "tags": [ + "Order modifications" + ], + "summary": "Get order modifications summary", + "description": "This endpoint retrieves a summary of modifications of every successful [Create order modifications request](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) made to an order and provides an overview of each request.\r\n > ⚠️ If you want information about all the modifications made to an order, use the [Get order modifications history endpoint](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/order-system/orders/-changeOrderId-/changes).\r\n## Permissions\r\nAny user or API key must have the appropriate License Manager resource to successfully run this request:\r\n| Product | Category | Resource |\n|---------|----------|----------|\n| OMS | OMS access | **OMS Viewer** |\r\nYou can create a custom role with this resource or use one of the following predefined roles:\r\n- **OMS - Full access** (OMS Viewer)\n- **Checkout Admin** (OMS Viewer)\n- **IntegrationProfile - Fulfillment Oms** (OMS Viewer)\r\nFor more information about security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).", + "operationId": "GetChangeSummary", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "Order ID.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "v12772213qst-02" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChangeSummary" + } + } + } + }, + "401": { + "description": "[Unauthorized - Invalid or missing authentication](https://httpstatuses.com/401)", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "RFC 9110 error type reference." + }, + "title": { + "type": "string", + "description": "Error title." + }, + "status": { + "type": "integer", + "description": "HTTP status code." + }, + "traceId": { + "type": "string", + "description": "Trace ID of the request for debugging." + } + } + }, + "example": { + "type": "https://tools.ietf.org/html/rfc9110#section-15.5.2", + "title": "Unauthorized", + "status": 401, + "traceId": "00-05464ee431d13f81b4fc065592acf694-d46dfbd48c924961-00" + } + } + } + }, + "403": { + "description": "[Forbidden - Insufficient permissions](https://httpstatuses.com/403)" + }, + "404": { + "description": "[Order not found](https://httpstatuses.com/404)" + } + } + } + }, + "/api/orders/expressions/jsonata": { + "post": { + "tags": [ + "Feed v3" + ], + "summary": "Test JSONata expression", + "description": "This endpoint allows you to test a JSON document with a JSONata expression, returning `true` if the document meets the criteria posed in the expression, or `false` if it does not.\n\r\n\rSince JSONata expressions can be used to filter order updates in the [Orders API feed and hook](https://developers.vtex.com/docs/guides/orders-feed), this endpoint can be used to test an expression's results before configuring the [feed or hook](https://developers.vtex.com/docs/guides/orders-feed).\n\r\n\rLearn more about how to use JSONata expressions, in the [JSONata documentation](https://docs.jsonata.org/overview.html).\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "operationId": "TestJSONataExpression", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "Expression", + "Document" + ], + "properties": { + "Expression": { + "type": "string", + "description": "JSONata expression to be tested." + }, + "Document": { + "type": "string", + "description": "JSON document to be evaluated by the expression." + } + } + }, + "example": { + "Expression": "status = \\\"canceled\\\"", + "Document": "{\\\"status\\\":\\\"canceled\\\"}" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "boolean", + "description": "Successful requests return the message `true`." + }, + "example": true + } + } + } + } + } + } + }, + "security": [ + { + "appKey": [], + "appToken": [] + }, + { + "VtexIdclientAutCookie": [] + } + ], + "components": { + "schemas": { + "TotalsUpdated": { + "type": "array", + "description": "Information about the order totals.", + "items": { + "type": "object", + "description": "Details about the order totals.", + "properties": { + "id": { + "type": "string", + "description": "Total ID, which defines what the total is about.", + "enum": [ + "Items", + "Discounts", + "Shipping", + "Tax" + ] + }, + "name": { + "type": "string", + "description": "Total name." + }, + "value": { + "type": "integer", + "description": "Total value in cents." + }, + "alternativeTotals": { + "type": "array", + "description": "Information about the order alternative totals, when applicable. For example, when there is a discount for items in the marketplace that results in a difference in the `Items` total value, the `alternativeTotals` can retrieve details about it.", + "nullable": true, + "items": { + "type": "object", + "description": "Details about the order alternative totals.", + "properties": { + "id": { + "type": "string", + "description": "Alternative total ID, which can be related to items, discounts, shipping or taxes." + }, + "name": { + "type": "string", + "description": "Alternative total name." + }, + "value": { + "type": "integer", + "description": "Alternative total value in cents." + } + } + } + } + } + } + }, + "Getfeedorderstatus": { + "title": "Getfeedorderstatus", + "required": [ + "eventId", + "handle", + "domain", + "state", + "lastState", + "orderId", + "lastChange", + "currentChange" + ], + "type": "object", + "properties": { + "eventId": { + "type": "string" + }, + "handle": { + "type": "string" + }, + "domain": { + "type": "string" + }, + "state": { + "type": "string" + }, + "lastState": { + "type": "string" + }, + "orderId": { + "type": "string" + }, + "lastChange": { + "type": "string" + }, + "currentChange": { + "type": "string" + } + } + }, + "HookFilter": { + "title": "Filter", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Determines what orders appear in the hook and how they are filtered. As shown in the examples above, there are two ways:\r\n\r\n - `FromWorkflow`: the hook will receive order updates only when there is a change or update in the [order status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). You must send at least one value for the `status` field to determine by which status the orders will be filtered.\r\n\r\n - `FromOrders`: the hook will receive order updates when there is a change in the order. In this case, orders can be filtered by any property, according to JSONata expressions passed in the `expression` field. You must send the request with values for the `expression` and `disableSingleFire` fields.", + "example": "FromWorkflow" + }, + "status": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of order statuses that should be included in the hook. This should only be used in case `type` is `FromWorkflow`." + }, + "expression": { + "type": "string", + "description": "JSONata query expression that defines what conditions must be met for an order to be included in the hook. This should only be used in case `type` is `FromOrders`." + }, + "disableSingleFire": { + "type": "boolean", + "description": "Sets a limit to how many times a specific order shows on the hook, after it first meets filtering conditions. Using the `FromOrders` type configuration with JSONata filtering expressions might cause orders to appear more than once on a feed, whenever changes are made to that order. If this field is `false` orders will appear in the hook only once. Send this field if you want to filter `FromOrders`.", + "example": false + } + } + }, + "HookConfigurationRequest": { + "title": "HookConfigurationRequest", + "required": [ + "filter", + "hook" + ], + "type": "object", + "properties": { + "filter": { + "$ref": "#/components/schemas/HookFilter" + }, + "hook": { + "$ref": "#/components/schemas/Hook" + } + }, + "example": { + "filter": { + "type": "FromWorkflow", + "status": [ + "order-completed", + "handling", + "ready-for-handling", + "waiting-ffmt-authorization", + "cancel" + ] + }, + "hook": { + "url": "https://endpoint.example/path", + "headers": { + "key": "value" + } + } + } + }, + "Hook": { + "title": "Hook", + "required": [ + "url", + "headers" + ], + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "headers": { + "$ref": "#/components/schemas/Headers" + } + }, + "example": { + "url": "https://endpoint.example/path", + "headers": { + "key": "value" + } + } + }, + "Headers": { + "title": "Headers", + "required": [ + "key" + ], + "type": "object", + "properties": { + "key": { + "type": "string" + } + }, + "example": { + "key": "value" + } + }, + "HookConfiguration": { + "title": "HookConfiguration", + "required": [ + "Domain", + "OrderId", + "State", + "LastState", + "LastChange", + "CurrentChange", + "Origin" + ], + "type": "object", + "properties": { + "Domain": { + "type": "string" + }, + "OrderId": { + "type": "string" + }, + "State": { + "type": "string" + }, + "LastState": { + "type": "string" + }, + "LastChange": { + "type": "string" + }, + "CurrentChange": { + "type": "string" + }, + "Origin": { + "$ref": "#/components/schemas/Origin2" + } + } + }, + "Origin2": { + "title": "Origin2", + "required": [ + "Account", + "Key" + ], + "type": "object", + "properties": { + "Account": { + "type": "string" + }, + "Key": { + "type": "string" + } + }, + "example": { + "Account": "automacaoqa", + "Key": "vtexappkey-appvtex" + } + }, + "LogisticsInfo1": { + "type": "object", + "description": "Logistics information object.", + "required": [ + "itemIndex", + "selectedSla", + "addressId", + "slas", + "shipsTo", + "itemId", + "deliveryChannels", + "price", + "listPrice", + "shippingEstimate", + "dockEstimate", + "shippingEstimateDate", + "lockTTL", + "deliveryCompany", + "polygonName", + "transitTime", + "sellingPrice", + "deliveryIds", + "deliveryWindow", + "pickupPointId", + "pickupStoreInfo", + "pickupDistance" + ], + "properties": { + "itemIndex": { + "type": "integer", + "description": "Index that identifies the position of the replacing item in the array, starting from `0`.", + "example": 0 + }, + "selectedSla": { + "type": "string", + "description": "Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the replacing order.", + "example": "Normal" + }, + "addressId": { + "type": "string", + "description": "Shipping address ID of the replacing item.", + "example": "9ec276fd3a604eb1aa151b5333ca5db7" + }, + "slas": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SlaV2" + }, + "description": "Information on Service Level Agreement (SLA) of the order modifications shipping policy." + }, + "shipsTo": { + "type": "array", + "items": { + "type": "string", + "description": "Country name represented in a three letters code ISO 3166 ALPHA-3.", + "example": "BRA" + }, + "description": "List of countries of the order modification shipping address." + }, + "itemId": { + "type": "string", + "description": "Replacing item's SKU ID, which is a unique numerical identifier.", + "example": "3" + }, + "deliveryChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryChannel" + }, + "description": "Array with the delivery channels associated with the trade policy." + }, + "price": { + "type": "integer", + "description": "Replacing item's final price, calculated in cents.", + "example": 600 + }, + "listPrice": { + "type": "integer", + "description": "Replacing item's price list, calculated in cents.", + "example": 600 + }, + "shippingEstimate": { + "type": "string", + "nullable": true, + "description": "Replacing item's shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.", + "example": "2023-07-29T17:52:18.6483116Z" + }, + "dockEstimate": { + "type": "string", + "nullable": true, + "description": "Replacing item's estimate duration of the [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) time. For instance, one business day is represented as `1bd`.", + "example": "1bd" + }, + "shippingEstimateDate": { + "type": "string", + "nullable": true, + "description": "Replacing item's total shipping duration estimated in days. For instance, three business days are represented as `3bd`.", + "example": "3bd" + }, + "lockTTL": { + "type": "string", + "nullable": true, + "description": "Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA. For instance, one business day is represented as `1bd`.", + "example": "1bd" + }, + "deliveryCompany": { + "type": "string", + "nullable": true, + "description": "[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) company's name.", + "example": "Correios" + }, + "polygonName": { + "type": "string", + "nullable": true, + "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.", + "example": "114 - Polanco _ H-05" + }, + "transitTime": { + "type": "string", + "nullable": true, + "description": "Duration in business days of the time the [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) takes in transit to fulfill the order. For example, three business days are represented as `3bd`.", + "example": "3bd" + }, + "sellingPrice": { + "type": "integer", + "description": "Change item's selling price.", + "example": 600 + }, + "deliveryIds": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryIdV2" + }, + "description": "Array with delivery information." + }, + "deliveryWindow": { + "type": "string", + "nullable": true, + "description": "Order modification [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.", + "example": null + }, + "pickupPointId": { + "type": "string", + "nullable": true, + "description": "ID of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).", + "example": "pup215rkw" + }, + "pickupStoreInfo": { + "$ref": "#/components/schemas/PickupStoreInfoV2" + }, + "pickupDistance": { + "type": "number", + "nullable": true, + "description": "Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.", + "example": "1.0" + } + } + }, + "SlaV2": { + "description": "Service Level Agreement (SLA) object.", + "required": [ + "id", + "deliveryChannel", + "name", + "deliveryIds", + "shippingEstimate", + "shippingEstimateDate", + "lockTTL", + "availableDeliveryWindows", + "deliveryWindow", + "price", + "listPrice", + "tax", + "pickupStoreInfo", + "pickupPointId", + "pickupDistance", + "polygonName", + "transitTime" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the order delivery or pickup.", + "example": "Normal" + }, + "deliveryChannel": { + "type": "string", + "description": "Order shipping type, which can be `pickup-in-point` for [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R), and `delivery` for delivery.", + "example": "delivery" + }, + "name": { + "type": "string", + "description": "Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the order delivery or pickup. It corresponds to the `id` value.", + "example": "Normal" + }, + "deliveryIds": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryIdV2" + }, + "description": "Information about delivery IDs." + }, + "shippingEstimate": { + "type": "string", + "nullable": true, + "description": "Total shipping duration estimated in days. For instance, three business days is represented as `3bd`.", + "example": "3bd" + }, + "shippingEstimateDate": { + "type": "string", + "nullable": true, + "description": "Shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.", + "example": "2023-07-27T17:52:18.6483116Z" + }, + "lockTTL": { + "type": "string", + "nullable": true, + "description": "Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA. For instance, one business day is represented as `1bd`.", + "example": "1bd" + }, + "availableDeliveryWindows": { + "type": "array", + "items": { + "type": "string", + "description": "Delivery window." + }, + "description": "Available [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, for when the shipping policy has shipping windows configurations." + }, + "deliveryWindow": { + "type": "object", + "nullable": true, + "description": "[Scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.", + "properties": { + "startDateUtc": { + "type": "string", + "description": "Delivery window starting date and time in [UTC ISO 8601 format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", + "example": "2024-03-14T00:00:00+00:00" + }, + "endDateUtc": { + "type": "string", + "description": "Delivery window ending date and time in [UTC ISO 8601 format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", + "example": "2024-03-14T23:59:59+00:00" + } + } + }, + "price": { + "type": "integer", + "description": "Shipping price for the item in cents. Does not account for the whole order's shipping price.", + "example": 600 + }, + "listPrice": { + "type": "integer", + "description": "Item's price list for a specific trade policy.", + "example": 600 + }, + "tax": { + "type": "integer", + "description": "Tax in cents, when applicable.", + "example": 0 + }, + "pickupStoreInfo": { + "$ref": "#/components/schemas/PickupStoreInfoV2" + }, + "pickupPointId": { + "type": "string", + "nullable": true, + "description": "Pickup point ID is the unique identifier of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) related to the SLA.", + "example": "pup215rkw" + }, + "pickupDistance": { + "type": "number", + "nullable": true, + "description": "Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.", + "example": 1 + }, + "polygonName": { + "type": "string", + "nullable": true, + "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.", + "example": "114 - Polanco _ H-05" + }, + "transitTime": { + "type": "string", + "nullable": true, + "description": "Duration in business days of the time the [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) takes in transit to fulfill the order. For example, three business days is represented as `3bd`.", + "example": "3bd" + } + } + }, + "PickupStoreInfoV2": { + "type": "object", + "description": "Information about a loading dock that was transformed into a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).", + "required": [ + "isPickupStore", + "friendlyName", + "address", + "additionalInfo", + "dockId" + ], + "deprecated": true, + "properties": { + "isPickupStore": { + "type": "boolean", + "description": "This field is related to converting a loading dock into a pickup point. It should always correspond to `false` because it has been deprecated.", + "example": false, + "nullable": true, + "deprecated": true + }, + "friendlyName": { + "type": "string", + "description": "Name of the loading dock converted to pickup point to be displayed at checkout. This field has been deprecated.", + "example": null, + "nullable": true, + "deprecated": true + }, + "address": { + "type": "string", + "nullable": true, + "description": "Address of the loading dock converted to pickup point. This field has been deprecated.", + "example": null, + "deprecated": true + }, + "additionalInfo": { + "type": "string", + "nullable": true, + "description": "Additional information about the loading dock converted to pickup point. This field has been deprecated.", + "example": null, + "deprecated": true + }, + "dockId": { + "type": "string", + "nullable": true, + "description": "ID of the loading dock converted to pickup point. This field has been deprecated.", + "example": "dockAjs28", + "deprecated": true + } + } + }, + "DeliveryIdV2": { + "title": "DeliveryIdV2", + "required": [ + "courierId", + "warehouseId", + "dockId", + "courierName", + "quantity", + "kitItemDetails", + "accountCarrierName" + ], + "type": "object", + "properties": { + "courierId": { + "type": "string", + "description": "ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).", + "example": "136769c" + }, + "warehouseId": { + "type": "string", + "description": "ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).", + "example": "w_156" + }, + "dockId": { + "type": "string", + "description": "ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).", + "example": "ld931" + }, + "courierName": { + "type": "string", + "description": "Name of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).", + "example": "Crossborder" + }, + "quantity": { + "type": "integer", + "description": "Quantity of items.", + "example": 1 + }, + "kitItemDetails": { + "type": "array", + "items": { + "type": "string", + "description": "Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), when applicable to the order.", + "example": null, + "nullable": true + } + }, + "accountCarrierName": { + "type": "string", + "nullable": true, + "description": "Name of the account's [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE).", + "example": "vtexlog" + } + }, + "example": { + "courierId": "1c083bf", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Donkey", + "quantity": 1, + "kitItemDetails": [], + "accountCarrierName": null + } + }, + "DeliveryChannel": { + "title": "DeliveryChannel", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Order modifications shipping type, which can be `pickup-in-point` for [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R), and `delivery` for delivery.", + "example": "delivery" + } + }, + "example": { + "id": "delivery" + } + }, + "ChangeSummary": { + "type": "object", + "description": "Summary of modifications made to an order.", + "properties": { + "original": { + "type": "array", + "description": "Summary of the original items in the order before modifications.", + "items": { + "type": "object", + "properties": { + "totalQuantity": { + "type": "integer", + "description": "Total quantity of the item." + }, + "quantity": { + "type": "integer", + "description": "Quantity of the item." + }, + "deliveryIds": { + "type": "array", + "nullable": true, + "items": { + "$ref": "#/components/schemas/DeliveryIdResponse" + } + }, + "itemIndex": { + "type": "integer", + "description": "Each item in the order is identified by an index. The position starts in `0`, followed by `1`, `2`, and so on." + }, + "uniqueId": { + "type": "string", + "description": "Alphanumeric sequence that identifies an SKU in a given order." + }, + "id": { + "type": "string", + "description": "Unique identifier of the SKU." + }, + "productId": { + "type": "string", + "description": "ID of the product associated with the item." + }, + "lockId": { + "type": "string", + "description": "Reservation ID." + }, + "ean": { + "type": "string", + "description": "EAN of the SKU.", + "nullable": true + }, + "seller": { + "type": "string", + "description": "Seller related to the order." + }, + "sellerSku": { + "type": "string", + "description": "SKU ID from the seller perspective." + }, + "priceValidUntil": { + "type": "string", + "description": "Date until when the price is going to be valid if there is a promotion. The date uses [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", + "nullable": true + }, + "name": { + "type": "string", + "description": "Name of the item as displayed to customers in the storefront." + }, + "additionalInfo": { + "type": "object", + "description": "Additional information about the item.", + "properties": { + "brandName": { + "type": "string", + "description": "Item's brand name." + }, + "brandId": { + "type": "string", + "description": "Item's brand ID." + }, + "categoriesIds": { + "type": "string", + "description": "Item's category ID." + }, + "dimension": { + "type": "object", + "description": "Item's dimension.", + "properties": { + "cubicweight": { + "type": "number", + "description": "Item's cubic weight." + }, + "height": { + "type": "number", + "description": "Item's height." + }, + "length": { + "type": "number", + "description": "Item's length." + }, + "weight": { + "type": "number", + "description": "Item's weight." + }, + "width": { + "type": "number", + "description": "Item's width." + } + } + }, + "productClusterId": { + "type": "string", + "description": "All product clusters related to the item." + }, + "commercialConditionId": { + "type": "string", + "description": "Commercial conditions ID." + }, + "offeringInfo": { + "type": "object", + "description": "Information about services related to the item. For example: guarantee or installation.", + "nullable": true + }, + "offeringType": { + "type": "string", + "description": "Offering type.", + "nullable": true + }, + "offeringTypeId": { + "type": "string", + "description": "Offering type ID." + }, + "categories": { + "type": "array", + "description": "Items categories information.", + "items": { + "type": "object", + "description": "Category information.", + "properties": { + "id": { + "type": "number", + "description": "Category ID." + }, + "name": { + "type": "string", + "description": "Category name." + } + } + } + } + } + }, + "attachments": { + "type": "array", + "description": "Array containing information on attachments.", + "items": { + "type": "string", + "description": "Attachments information." + } + }, + "attachmentOfferings": { + "type": "array", + "description": "Array containing attachments details.", + "nullable": true, + "items": { + "type": "object", + "description": "Attachments details.", + "properties": { + "name": { + "type": "string", + "description": "Name of the attachment.", + "nullable": true + }, + "required": { + "type": "boolean", + "description": "Defines if the attachment is required (`true`) or not (`false`).", + "nullable": true + } + } + } + }, + "assemblies": { + "type": "array", + "description": "Information about items customization.", + "nullable": true, + "items": { + "type": "string", + "description": "Customization information." + } + }, + "refId": { + "type": "string", + "description": "SKU reference ID." + }, + "shippingPrice": { + "type": "integer", + "description": "Item's shipping price.", + "nullable": true + }, + "price": { + "type": "integer", + "description": "Item's price." + }, + "sellingPrice": { + "type": "integer", + "description": "Item's selling price." + }, + "manualPrice": { + "type": "integer", + "description": "Item's [manual price](https://help.vtex.com/en/tutorial/change-the-price-of-an-item-in-the-shopping-cart--7Cd37aCAmtL1qmoZJJvjNf).", + "nullable": true + }, + "manualPriceAppliedBy": { + "type": "string", + "description": "User ID or appKey that made the manual price modification.", + "nullable": true + }, + "tax": { + "type": "integer", + "description": "Tax in cents, when applicable." + }, + "customTax": { + "type": "number", + "description": "Custom tax in cents, when applicable.", + "nullable": true + }, + "rewardValue": { + "type": "integer", + "description": "Item's reward value." + }, + "freightCommission": { + "type": "integer", + "description": "Value of the freight commission." + }, + "commission": { + "type": "integer", + "description": "Commission value registered for the seller." + }, + "priceTags": { + "type": "array", + "description": "List of objects with item's price modifiers.", + "items": { + "type": "object", + "description": "Price modifiers." + } + }, + "imageUrl": { + "type": "string", + "description": "SKU image URL." + }, + "detailUrl": { + "type": "string", + "description": "SKU slug." + }, + "components": { + "type": "array", + "description": "Item's components.", + "items": { + "type": "string", + "description": "Components." + } + }, + "bundleItems": { + "type": "array", + "description": "This field groups offerings (services) related to the item and displays their ID and quantity. A gift package is an example of an offering.", + "items": { + "type": "object", + "description": "Item's offering details.", + "properties": { + "id": { + "type": "integer", + "description": "Offering ID." + }, + "quantity": { + "type": "integer", + "description": "Offering quantity." + } + } + } + }, + "offerings": { + "type": "array", + "description": "Item's offerings, which are services related to the item. For example, guarantee or installation.", + "items": { + "type": "string", + "description": "Service name related to the item." + } + }, + "preSaleDate": { + "type": "string", + "description": "Item's pre sale date.", + "nullable": true + }, + "isGift": { + "type": "boolean", + "description": "This field is `true` when the item is a gift in order context and `false` when it is not." + }, + "taxCode": { + "type": "string", + "description": "Item's tax code.", + "nullable": true + }, + "measurementUnit": { + "type": "string", + "description": "Item's measurement unit." + }, + "unitMultiplier": { + "type": "number", + "description": "Item's unit multiplier." + }, + "marketingData": { + "type": "object", + "description": "Information about promotions and marketing. For example, coupon tracking information and internal or external UTMs.", + "nullable": true, + "properties": { + "id": { + "type": "string", + "description": "Object ID. The expected value is `marketingData`." + }, + "utmSource": { + "type": "string", + "description": "Value of the `utm_source` parameter of the URL that led to the request." + }, + "utmPartner": { + "type": "string", + "description": "UTM Source Parameters." + }, + "utmMedium": { + "type": "string", + "description": "Value of the `utm_medium` parameter of the URL that led to the request." + }, + "utmCampaign": { + "type": "string", + "description": "Value of the `utm_campaign` parameter of the URL that led to the request." + }, + "coupon": { + "type": "string", + "description": "Coupon code." + }, + "utmiCampaign": { + "type": "string", + "description": "Internal UTM value `utmi_cp`." + }, + "utmipage": { + "type": "string", + "description": "Internal UTM value `utmi_p`." + }, + "utmiPart": { + "type": "string", + "description": "Internal UTM value `utmi_pc`." + }, + "marketingTags": { + "type": "string", + "description": "Marketing tags information. This field can be used to register campaign data or informative tags regarding promotions.", + "items": { + "type": "string", + "description": "Marketing tag." + } + } + } + }, + "parentAssemblyBinding": { + "type": "string", + "description": "When items are indexed in between each other, this field returns the assembly option ID. This response is `null` for items that are not [assembly options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH).", + "nullable": true + }, + "parentItemIndex": { + "type": "integer", + "description": "Ranking number that shows how related items are indexed in between each other. It starts at `0` as the primary item reference and counts up to `1`, `2`, and so on. For example, a customer bought sunglasses and hired a warranty service. Since the sunglasses are index `0`, the warranty service (the [assembly option](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH)) is index `1` and has the `parentItemIndex` value `0`. This response is `null` for items that are not assembly options.", + "nullable": true + }, + "callCenterOperator": { + "type": "string", + "description": "Identification code of the call center operator responsible for the order.", + "nullable": true + }, + "priceDefinition": { + "type": "object", + "description": "Item's price information.", + "properties": { + "calculatedSellingPrice": { + "type": "integer", + "description": "Item's calculated unitary selling price in cents." + }, + "total": { + "type": "integer", + "description": "Total value of all item's units in cents." + }, + "sellingPrices": { + "type": "array", + "description": "Details on item's selling price.", + "items": { + "type": "object", + "description": "Selling price.", + "properties": { + "value": { + "type": "integer", + "description": "Total value of items in cents." + }, + "quantity": { + "type": "integer", + "description": "Quantity of items." + } + } + } + }, + "reason": { + "type": "string", + "description": "Reason for the price change." + } + } + }, + "costPrice": { + "type": "integer", + "description": "Item's cost price in cents." + } + } + } + }, + "added": { + "type": "array", + "description": "Array containing information on added items of order modification.", + "items": { + "type": "object", + "description": "Information about added items.", + "properties": { + "id": { + "type": "string", + "description": "SKU ID of the item being added." + }, + "uniqueId": { + "type": "string", + "description": "Unique ID of the item being added." + }, + "totalQuantity": { + "type": "integer", + "description": "Total quantity of the item being added." + }, + "quantity": { + "type": "integer", + "description": "Quantity of the item being added." + }, + "price": { + "type": "integer", + "description": "Price of the item being added." + }, + "measurementUnit": { + "type": "string", + "description": "Measurement unit of the item being added." + }, + "unitMultiplier": { + "type": "number", + "description": "Unit multiplier of the item being added." + }, + "imageUrl": { + "type": "string", + "description": "Image URL of the item being added." + }, + "sellingPrice": { + "type": "integer", + "description": "Selling price of the item being added." + }, + "priceTags": { + "type": "array", + "description": "List of objects with item's price modifiers.", + "items": { + "type": "string", + "description": "Price modifiers." + } + }, + "detailUrl": { + "type": "string", + "description": "Slug of the SKU being added." + }, + "name": { + "type": "string", + "description": "Name of the item being added." + }, + "refId": { + "type": "string", + "description": "SKU reference ID of the item being added." + }, + "deliveryIds": { + "type": "array", + "description": "Array containing information about the delivery IDs of the item being added.", + "nullable": true, + "items": { + "$ref": "#/components/schemas/DeliveryIdResponse" + } + } + } + } + }, + "removed": { + "type": "array", + "description": "Array containing information on removed items of order modification.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "SKU ID of the item being removed." + }, + "uniqueId": { + "type": "string", + "description": "Unique ID of the item being removed." + }, + "quantity": { + "type": "integer", + "description": "Quantity of the item being removed." + }, + "price": { + "type": "integer", + "description": "Price of the item being removed." + }, + "measurementUnit": { + "type": "string", + "description": "Measurement unit of the item being removed." + }, + "unitMultiplier": { + "type": "number", + "description": "Unit multiplier of the item being removed." + }, + "imageUrl": { + "type": "string", + "description": "Image URL of the item being removed." + }, + "sellingPrice": { + "type": "integer", + "description": "Selling price of the item being removed." + }, + "priceTags": { + "type": "array", + "description": "List of objects with item's price modifiers.", + "items": { + "type": "string", + "description": "Price modifiers." + } + }, + "detailUrl": { + "type": "string", + "description": "Slug of the SKU being removed." + }, + "name": { + "type": "string", + "description": "Name of the item being removed." + }, + "refId": { + "type": "string", + "description": "SKU reference ID of the item being removed." + }, + "deliveryIds": { + "type": "array", + "description": "Array containing information about the delivery IDs of the item being removed.", + "nullable": true, + "items": { + "$ref": "#/components/schemas/DeliveryIdResponse" + } + } + } + } + }, + "replaced": { + "type": "array", + "description": "Array containing information on replaced items of order modification.", + "items": { + "type": "object", + "properties": { + "replaceType": { + "type": "string", + "description": "Type of replacement operation.", + "enum": [ + "ItemReplacement", + "WeightChange", + "PriceChange", + "QuantityChange" + ] + }, + "userInputType": { + "type": "string", + "description": "Type of replacement operation.", + "enum": [ + "ItemReplacement", + "WeightChange", + "PriceChange", + "QuantityChange" + ] + }, + "from": { + "type": "object", + "description": "Information about item being replaced.", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "description": "Details about the item being replaced.", + "properties": { + "id": { + "type": "string", + "description": "SKU ID of the item being replaced." + }, + "uniqueId": { + "type": "string", + "description": "Unique ID of the item being replaced." + }, + "quantity": { + "type": "integer", + "description": "Quantity of the item being replaced." + }, + "price": { + "type": "integer", + "description": "Price of the item being replaced." + }, + "measurementUnit": { + "type": "string", + "description": "Measurement unit of the item being replaced." + }, + "unitMultiplier": { + "type": "number", + "description": "Unit multiplier of the item being replaced." + }, + "imageUrl": { + "type": "string", + "description": "Image URL of the item being replaced." + }, + "sellingPrice": { + "type": "integer", + "description": "Selling price of the item being replaced." + }, + "priceTags": { + "type": "array", + "description": "List of objects with item's price modifiers.", + "items": { + "type": "string", + "description": "Price modifiers." + } + }, + "detailUrl": { + "type": "string", + "description": "URL slug of the item being replaced." + }, + "name": { + "type": "string", + "description": "Name of the item being replaced." + }, + "refId": { + "type": "string", + "description": "SKU reference ID of the item being replaced." + }, + "deliveryIds": { + "type": "array", + "description": "Array containing information about the delivery IDs of the item being replaced.", + "nullable": true, + "items": { + "$ref": "#/components/schemas/DeliveryIdResponse" + } + } + } + } + }, + "shippingData": { + "type": "object", + "description": "Shipping data object.", + "nullable": true, + "properties": { + "logisticsInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LogisticsInfo1" + } + } + } + } + } + }, + "to": { + "type": "object", + "description": "Information about item replacing the previous one.", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "description": "Details about the item replacing the previous one.", + "properties": { + "id": { + "type": "string", + "description": "SKU ID of the item being replaced." + }, + "uniqueId": { + "type": "string", + "description": "Unique ID of the item replacing the previous one." + }, + "quantity": { + "type": "integer", + "description": "Quantity of the item replacing the previous one." + }, + "price": { + "type": "integer", + "description": "Price of the item replacing the previous one." + }, + "measurementUnit": { + "type": "string", + "description": "Measurement unit of the item replacing the previous one." + }, + "unitMultiplier": { + "type": "number", + "description": "Unit multiplier of the item replacing the previous one." + }, + "imageUrl": { + "type": "string", + "description": "Image URL of the item replacing the previous one." + }, + "sellingPrice": { + "type": "integer", + "description": "Selling price of the item replacing the previous one." + }, + "priceTags": { + "type": "array", + "description": "List of objects with item's price modifiers.", + "items": { + "type": "string", + "description": "Price modifiers." + } + }, + "detailUrl": { + "type": "string", + "description": "URL slug of the item being replaced." + }, + "name": { + "type": "string", + "description": "Name of the item replacing the previous one." + }, + "refId": { + "type": "string", + "description": "SKU reference ID of the item replacing the previous one." + }, + "deliveryIds": { + "type": "array", + "description": "Array containing information about the delivery IDs of the item being replaced.", + "nullable": true, + "items": { + "$ref": "#/components/schemas/DeliveryIdResponse" + } + } + } + } + }, + "shippingData": { + "type": "object", + "description": "Shipping data object.", + "nullable": true, + "properties": { + "logisticsInfo": { + "type": "array", + "description": "Array with shipping information.", + "items": { + "$ref": "#/components/schemas/LogisticsInfo1" + } + } + } + } + } + }, + "type": { + "type": "string", + "description": "Type of replacement operation.", + "enum": [ + "UserInput", + "System" + ] + } + } + } + }, + "manualDiscountValueAggregated": { + "type": "integer", + "description": "This field shows if a manual price was applied to the total order amount. The value is in cents." + }, + "manualIncrementValueAggregated": { + "type": "integer", + "description": "This field shows if an increment value was applied to the total order amount. The value is in cents." + }, + "totalChangeValueAggregated": { + "type": "integer", + "description": "This field shows how much the order total price is, considering that price modifications might have been made. The value is in cents." + }, + "totals": { + "items": { + "$ref": "#/components/schemas/TotalsUpdated" + } + }, + "lastChange": { + "type": "string", + "description": "Date and time of the last change in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + } + }, + "example": { + "original": [ + { + "totalQuantity": 3, + "quantity": 3, + "deliveryIds": [ + { + "courierId": "1", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Transportadora", + "quantity": 4, + "totalListPrice": null, + "accountCarrierName": "Store Name", + "kitItemDetails": [] + } + ], + "itemIndex": 0, + "uniqueId": "368A04D405BE40F9888D23920ACA17EC", + "id": "4", + "productId": "4", + "lockId": "00-1537351038731-01", + "ean": "7896025801879", + "seller": "1", + "sellerSku": "4", + "priceValidUntil": "2026-06-05T15:01:17Z", + "name": "Banana", + "additionalInfo": { + "brandName": "Brand name", + "brandId": "20000", + "categoriesIds": "/1/", + "dimension": { + "cubicweight": 1, + "height": 10, + "length": 10, + "weight": 5, + "width": 10 + }, + "productClusterId": "", + "commercialConditionId": "1", + "offeringInfo": null, + "offeringType": null, + "offeringTypeId": null, + "categories": [ + { + "id": 1, + "name": "Grocery" + } + ] + }, + "attachments": [], + "attachmentOfferings": null, + "assemblies": null, + "refId": "151762", + "shippingPrice": null, + "price": 1199, + "sellingPrice": 599, + "listPrice": 1199, + "manualPrice": null, + "manualPriceAppliedBy": null, + "tax": 215, + "customTax": null, + "rewardValue": 0, + "freightCommission": 0, + "commission": 0, + "priceTags": [ + { + "name": "tax@price-ecc63e22-47ba-4f6c-843b-cfce4f06995e#bf555b6a-3049-4242-9f34-24a5bbb2a6ca", + "rawValue": 0.275, + "isPercentual": true, + "identifier": "ecc63e22-47ba-4f6c-843b-cfce4f06995e", + "rate": null, + "jurisCode": null, + "jurisType": null, + "jurisName": null + }, + { + "name": "tax@price-45ef7f98-c05d-4d23-a867-593e1b8eecb7#3e134d5e-2e9b-4117-9f53-6a2ad41f8885", + "rawValue": 1.5, + "isPercentual": false, + "identifier": "45ef7f98-c05d-4d23-a867-593e1b8eecb7", + "rate": null, + "jurisCode": null, + "jurisType": null, + "jurisName": null + } + ], + "imageUrl": "https://example.com/image.jpg", + "detailUrl": "/banana/p", + "components": [], + "bundleItems": [], + "offerings": [], + "preSaleDate": null, + "isGift": false, + "taxCode": "", + "measurementUnit": "kg", + "unitMultiplier": 1, + "marketingData": null, + "parentAssemblyBinding": null, + "parentItemIndex": null, + "callCenterOperator": null, + "priceDefinition": { + "calculatedSellingPrice": 599, + "total": 1797, + "sellingPrices": [ + { + "value": 599, + "quantity": 3 + } + ], + "reason": null + }, + "costPrice": 599 + } + ], + "added": [ + { + "id": "11", + "uniqueId": "DF6E5BB06ED84724A29A68ED392F99CE", + "totalQuantity": 1, + "quantity": 1, + "price": 749, + "measurementUnit": "un", + "unitMultiplier": 1, + "imageUrl": "https://example.com/image.jpg", + "sellingPrice": 749, + "priceTags": [], + "detailUrl": "/nuggets/p", + "name": "Nuggets", + "refId": "XX00021", + "deliveryIds": [ + { + "courierId": "1", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Transportadora", + "quantity": 5, + "totalListPrice": null, + "accountCarrierName": "Store Name", + "kitItemDetails": [] + } + ] + } + ], + "removed": [ + { + "id": "17", + "uniqueId": "8A6A0E3F26DE4F479F9017A60784DF2F", + "quantity": 7, + "price": 5500, + "measurementUnit": "un", + "unitMultiplier": 1, + "imageUrl": "https://example.com/image.jpg", + "sellingPrice": 5500, + "priceTags": [], + "detailUrl": "/plush-shark-18/p", + "name": "Plush shark", + "refId": null, + "deliveryIds": [ + { + "courierId": "1", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Transportadora", + "quantity": 7, + "totalListPrice": null, + "accountCarrierName": "Store Name", + "kitItemDetails": [] + } + ] + } + ], + "replaced": [ + { + "replaceType": "WeightChange", + "userInputType": "WeightChange", + "from": { + "items": [ + { + "id": "1", + "uniqueId": "6024FC8687884BC3B9AA9A8630C52804", + "quantity": 1, + "price": 765, + "measurementUnit": "kg", + "unitMultiplier": 1, + "imageUrl": "https://example.com/image.jpg", + "sellingPrice": 765, + "priceTags": [], + "detailUrl": "/apple/p", + "name": "Apple", + "refId": "197326", + "deliveryIds": [ + { + "courierId": "1", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Transportadora", + "quantity": 5, + "totalListPrice": null, + "accountCarrierName": "recorrenciacharlie", + "kitItemDetails": [] + } + ] + } + ], + "shippingData": null + }, + "to": { + "items": [ + { + "id": "1", + "uniqueId": "6024FC8687884BC3B9AA9A8630C52804", + "totalQuantity": 1, + "quantity": 1, + "price": 765, + "measurementUnit": "kg", + "unitMultiplier": 2, + "imageUrl": "https://example.com/image.jpg", + "sellingPrice": 1530, + "priceTags": [], + "detailUrl": "/apple/p", + "name": "Apple", + "refId": "197326", + "deliveryIds": [ + { + "courierId": "1", + "warehouseId": "1_1", + "dockId": "1", + "courierName": "Transportadora", + "quantity": 5, + "totalListPrice": null, + "accountCarrierName": "Store Name", + "kitItemDetails": [] + } + ] + } + ], + "shippingData": null + }, + "type": "UserInput" + } + ], + "manualDiscountValueAggregated": 0, + "manualIncrementValueAggregated": 0, + "totalChangesValueAggregated": -37393, + "totals": [ + { + "id": "Items", + "name": "Items Total", + "value": -37684, + "alternativeTotals": null + }, + { + "id": "Discounts", + "name": "Discounts Total", + "value": 600, + "alternativeTotals": null + }, + { + "id": "Shipping", + "name": "Shipping Total", + "value": -94, + "alternativeTotals": null + }, + { + "id": "Tax", + "name": "Tax Total", + "value": -215, + "alternativeTotals": null + } + ], + "lastChange": "2025-06-05T17:03:41.3219923Z" + } + }, + "DeliveryIdResponse": { + "title": "DeliveryIdResponse", + "type": "object", + "properties": { + "courierId": { + "type": "string", + "description": "ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140)." + }, + "warehouseId": { + "type": "string", + "description": "ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb)." + }, + "dockId": { + "type": "string", + "description": "ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj)." + }, + "courierName": { + "type": "string", + "description": "Name of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140)." + }, + "quantity": { + "type": "integer", + "description": "Quantity of items in the warehouse or dock." + }, + "totalListPrice": { + "type": "integer", + "description": "Total list price in cents.", + "nullable": true + }, + "accountCarrierName": { + "type": "string", + "description": "Name of the account's [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE)." + }, + "kitItemDetails": { + "type": "array", + "description": "Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) items, when applicable.", + "nullable": true, + "items": { + "type": "string", + "description": "Kit item information." + } + } + } + } + } + }, + "tags": [ + { + "name": "Orders" + }, + { + "name": "Order modifications" + }, + { + "name": "Invoice" + }, + { + "name": "Tracking" + }, + { + "name": "Conversation" + }, + { + "name": "Payment" + }, + { + "name": "Feed v2 (deprecated)" + }, + { + "name": "Feed v3" + }, + { + "name": "Order hook" + }, + { + "name": "User orders" + }, + { + "name": "Change seller" + } + ] +} diff --git a/clients/manitou/output/pick-and-pack-last-mile.json b/clients/manitou/output/pick-and-pack-last-mile.json new file mode 100644 index 0000000000..5ab5d2f05d --- /dev/null +++ b/clients/manitou/output/pick-and-pack-last-mile.json @@ -0,0 +1,4308 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "Pick and Pack Last Mile Protocol API", + "description": "The Pick and Pack Last Mile Protocol API enables seamless integration between the [Pick and Pack](https://help.vtex.com/en/tutorial/vtex-pick-and-pack--1OOops3WrUyz7e0bnhkfXU) app and delivery services. This API allows carriers and brokers to securely and efficiently exchange shipment information with the Pick and Pack app. It streamlines the process of managing orders, updating shipping statuses, and handling various service-related tasks, ensuring timely and accurate delivery updates. \n\n>ℹ️ Blank fields are included as `null` instead of being omitted.\r\n## Authentication\r\n- [`POST` Create an access token](https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api#post-/token)\r\n\r\n## Service integration\r\n- [`POST` Create a service](https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api#post-/create-service)\r\n\r\n## Carriers\r\n- [`POST` Calculate rates](https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api#post-/rates)\r\n- [`POST` List carriers](https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api#post-/list-carriers)\r\n\r\n## Shipping updates\r\n- [`GET` Get a service](https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api#get-/-carrierId-/-serviceId-)\r\n- [`PATCH` Update service](https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api#patch-/-carrierId-/-serviceId-)\r\n- [`POST` Create notes](https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api#post-/notes/-carrierId-/-serviceId-)\r\n- [`POST` Create evidence](https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api#post-/evidences/-carrierId-/-serviceId-)\r\n- [`POST` Create labels](https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api#post-/labels/-carrierId-/-serviceId-)\r\n- [`POST` Cancel service](https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api#post-/cancel-service)\r\n- [`POST` Cancel ongoing service](https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api#post-/cancel/service/-carrierId-/-serviceId-)\r\n- [`POST` Pause and resume service](https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api#post-/pause-service)\r\n- [`POST` Create on hold service](https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api#post-/on-hold/-carrierId-/-serviceId-)", + "version": "1.0" + }, + "servers": [ + { + "url": "https://auth.pickingnpacking.com/{environment}", + "variables": { + "environment": { + "default": "DefaultParameterValue", + "description": "Server to access the authentication necessary to make a request in the Pick and Pack Provider API." + } + } + }, + { + "url": "https://{store_endpoint}", + "variables": { + "your_endpoint": { + "default": "storeapi.com", + "description": "Server from the store." + } + } + }, + { + "url": "https://api.pickingnpacking.com/{environment}/v1/tracking/hook", + "variables": { + "environment": { + "default": "DefaultParameterValue", + "description": "Environment of the Pick and Pack Protocol App." + } + } + } + ], + "paths": { + "/token": { + "post": { + "tags": [ + "Authentication" + ], + "summary": "Create JWT token", + "description": "Creates a `JWT` (JSON Web Token) necessary to access the Pick and Pack Last Mile Protocol API information.\r\n\r\n>ℹ️ To generate the `JWT` it is necessary to have the `API KEY` previously generated by the Pick and Pack team.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "operationId": "Createtoken", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatetokenRequest" + }, + "example": { + "apiKey": "{pnpApiKey}" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "description": "Generated `JWT` token." + }, + "example": "{token}" + } + } + } + }, + "deprecated": false, + "servers": [ + { + "url": "https://auth.pickingnpacking.com/{environment}", + "variables": { + "environment": { + "default": "DefaultParameterValue", + "description": "Server to access the authentication necessary to make a request in the Pick and Pack Last Mile Protocol API." + } + } + } + ] + } + }, + "/create-service": { + "post": { + "tags": [ + "Service integration" + ], + "summary": "Create service", + "description": "Creates a service with the information that VTEX will send to the carrier. To understand how to integrate with a carrier, check the [VTEX Pick and Pack Carriers Integration Protocol](https://developers.vtex.com/docs/guides/vtex-pick-and-pack) guide.\r\n\r\nThis endpoint must be developed by the carriers or brokers to integrate into the protocol.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "operationId": "Createservice", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + } + ], + "requestBody": { + "content": { + "application/json": { + "example": { + "orderId": "SLR-29384924-01", + "carrierId": "servientrega-50461c9f3335", + "seller": "qaolimpica", + "sender": { + "name": "Tabitha Sears", + "phone": "+57 2305781612", + "email": "tabitha_sears@fortean.brother", + "city": "Jenkinsville", + "state": "Northern Mariana Islands", + "country": "US", + "address": "77 Sullivan Place, Jenkinsville, Northern Mariana Islands", + "addressComplement": "Flat 45", + "number": "1029", + "reference": "3", + "location": { + "latitude": -75.269008, + "longitude": 137.499833 + }, + "pickupDate": "2024-04-25T18:06:41.202Z" + }, + "receiver": { + "name": "Pansy Graves", + "phone": "+57 4240807147", + "email": "pansy_graves@zentime.moda", + "city": "Valle", + "state": "Marshall Islands", + "country": "Iceland", + "neighborhood": "Billings", + "number": "9840", + "reference": "63 Billings Place, Valle, Marshall Islands", + "addressComplement": "Flat 45", + "location": { + "latitude": -33.249891, + "longitude": -135.052901 + }, + "identification": "9541933267", + "deliveryDate": "2024-04-16T20:49:36.117Z", + "contactName": "Savannah Porter", + "deliveryWindow": { + "name": "consectetur", + "initialDate": "2024-04-25T22:50:41.209Z", + "finalDate": "2024-05-05T21:50:41.210Z" + } + }, + "packages": [ + { + "id": "6266df719ac55224b793ad36", + "orderId": "SLR-1221800709659-01", + "envelope": "Large", + "description": "Delicate package", + "categories": [ + "Cellphone", + "Technology" + ], + "dimensions": { + "width": "68", + "height": "43", + "length": "13" + }, + "weight": "19", + "totalValue": 5616.01, + "items": [ + { + "id": "6266df71a19ebe35637e1f42", + "name": "Tomatos", + "ean": "473390795673", + "refId": "6266", + "image": "https://static9.depositphotos.com/1628352/1107/i/600/depositphotos_11071361-stock-photo-tomato.jpg", + "type": "Food", + "price": 774230.01, + "weight": "4 kg", + "quantity": 4 + }, + { + "id": "6266df71803601c3bc4e2d99", + "name": "Tomatos", + "ean": "329949764612", + "refId": "6266", + "image": "https://static9.depositphotos.com/1628352/1107/i/600/depositphotos_11071361-stock-photo-cellphone.jpg", + "type": "Foods", + "price": 23162, + "weight": "14 kg", + "quantity": 9 + } + ] + } + ], + "type": "PICKUP_DELIVERY", + "carrierServiceType": "OTHERS", + "comments": "Delivery comments.", + "paymentMethod": "CASH_ON_DELIVERY", + "orderValue": 8000, + "settings": [ + { + "label": "Key secret", + "value": "keysecret-0122", + "key": "secrekey" + } + ], + "timezone": { + "offset": 300, + "value": "America/Bogota" + } + }, + "schema": { + "$ref": "#/components/schemas/CreateServiceBody" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResponseService" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Required authentication" + }, + "404": { + "description": "Resource not found" + }, + "500": { + "description": "Internal error" + } + }, + "deprecated": false, + "servers": [ + { + "url": "https://{store_endpoint}", + "variables": { + "your_endpoint": { + "default": "storeapi.com", + "description": "Server from the store." + } + } + } + ] + } + }, + "/rates": { + "post": { + "tags": [ + "Carriers" + ], + "summary": "Calculate rates", + "description": "Retrieves all rates from the carriers. To understand how to integrate with a carrier, check the [VTEX Pick and Pack Carriers Integration Protocol](https://developers.vtex.com/docs/guides/vtex-pick-and-pack) guide.\r\n\r\nThis endpoint must be developed by the carriers or brokers to integrate into the protocol.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "operationId": "Createservice", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + } + ], + "requestBody": { + "content": { + "application/json": { + "example": { + "orderId": "SLR-29384924-01", + "carrierId": "servientrega-50461c9f3335", + "seller": "qaolimpica", + "sender": { + "name": "Tabitha Sears", + "phone": "+57 2305781612", + "email": "tabitha_sears@fortean.brother", + "city": "Jenkinsville", + "state": "Northern Mariana Islands", + "country": "US", + "address": "77 Sullivan Place, Jenkinsville, Northern Mariana Islands", + "addressComplement": "Flat 45", + "number": "1029", + "reference": "3", + "location": { + "latitude": -75.269008, + "longitude": 137.499833 + }, + "pickupDate": "2024-04-25T18:06:41.202Z" + }, + "receiver": { + "name": "Pansy Graves", + "phone": "+57 4240807147", + "email": "pansy_graves@zentime.moda", + "city": "Valle", + "state": "Marshall Islands", + "country": "Iceland", + "neighborhood": "Billings", + "number": "9840", + "reference": "63 Billings Place, Valle, Marshall Islands", + "addressComplement": "Flat 32", + "location": { + "latitude": -33.249891, + "longitude": -135.052901 + }, + "identification": "9541933267", + "deliveryDate": "2024-04-16T20:49:36.117Z", + "contactName": "Savannah Porter", + "deliveryWindow": { + "name": "consectetur", + "initialDate": "2024-04-25T22:50:41.209Z", + "finalDate": "2024-05-05T21:50:41.210Z" + } + }, + "packages": [ + { + "id": "6266df719ac55224b793ad36", + "orderId": "SLR-1221800709659-01", + "envelope": "Large", + "description": "Delicate package", + "categories": [ + "Foods" + ], + "dimensions": { + "width": "68", + "height": "43", + "length": "13" + }, + "weight": "19", + "totalValue": 5616.01, + "items": [ + { + "id": "6266df71a19ebe35637e1f42", + "name": "Tomatos", + "ean": "473390795673", + "refId": "6266", + "image": "https://static9.depositphotos.com/1628352/1107/i/600/depositphotos_11071361-stock-photo-tomato.jpg", + "type": "Food", + "price": 774230.01, + "weight": "4 kg", + "quantity": 4 + } + ] + } + ], + "type": "PICKUP_DELIVERY", + "carrierServiceType": "OTHERS", + "comments": "Delivery comments.", + "paymentMethod": "CASH_ON_DELIVERY", + "orderValue": 8000, + "settings": [ + { + "label": "Key secret", + "value": "keysecret-0122", + "key": "secrekey" + } + ], + "timezone": { + "offset": 300, + "value": "America/Bogota" + } + }, + "schema": { + "$ref": "#/components/schemas/CreateServiceBody" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceBody" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Required authentication" + }, + "404": { + "description": "Resource not found" + }, + "500": { + "description": "Internal error" + } + }, + "deprecated": false, + "servers": [ + { + "url": "https://{store_endpoint}", + "variables": { + "your_endpoint": { + "default": "storeapi.com", + "description": "Server from the store." + } + } + } + ] + } + }, + "/list-carriers": { + "post": { + "tags": [ + "Carriers" + ], + "summary": "List carriers", + "description": "Retrieves all carriers from the broker.\r\n\r\nThis endpoint must be developed by the carriers or brokers to integrate into the protocol.\r\n\r\nThis endpoint only applies to multi-carrier integrations such as Shipstation or Shippo.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "operationId": "Createservice", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResponseService" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Required authentication" + }, + "404": { + "description": "Resource not found" + }, + "500": { + "description": "Internal error" + } + }, + "deprecated": false, + "servers": [ + { + "url": "https://{store_endpoint}", + "variables": { + "your_endpoint": { + "default": "storeapi.com", + "description": "Server from the store." + } + } + } + ] + } + }, + "/{carrierId}/{serviceId}": { + "get": { + "tags": [ + "Shipping updates" + ], + "summary": "Get service", + "description": "Returns information about a service, which can be queried by providing the carrier ID and the corresponding service ID as query parameters.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).", + "operationId": "Getservice", + "parameters": [ + { + "name": "carrierId", + "in": "path", + "description": "Carrier ID.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50" + } + }, + { + "name": "serviceId", + "in": "path", + "description": "Service ID generated by the carrier.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "78c83922-d658-48bf-89d5-0658a6a94e27" + } + }, + { + "$ref": "#/components/parameters/Authorization" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceBody" + }, + "example": { + "message": "success", + "data": { + "id": "519400fb-f980-4a6a-809c-9f986fdb98a4", + "orderId": "46369545534253-01", + "carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50", + "serviceId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&78c83922-d658-48bf-89d5-0658a6a94e27", + "carrierName": "AfterShip", + "seller": "lastmile", + "status": "DELIVERED", + "type": "PICKUP_DELIVERY", + "tags": [], + "labels": [ + { + "id": "78c83922-d658-48bf-89d5-0658a6a94e27", + "name": "Shipping label", + "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf", + "type": "PDF" + } + ], + "evidences": [], + "packages": [ + { + "id": "a46e5bc1-8959-459f-a094-b6e699f7214c", + "orderId": "46369545534253-01", + "envelope": "Foam or Plastic Containers", + "dimensions": { + "height": "5", + "length": "11", + "width": "7" + }, + "weight": "48", + "totalValue": 5352, + "items": [ + { + "id": "184", + "name": "Chicken", + "ean": "EAN354", + "quantity": 8, + "price": 669, + "refId": "314", + "image": "https://picsum.photos/seed/YtoZ9/128/480", + "type": "other", + "weight": "6" + } + ], + "categories": [ + "Movies", + "Garden", + "Books" + ], + "description": "Unde deserunt libero cupiditate illum." + } + ], + "timeline": [ + { + "id": "77263f59-0ac5-4b0c-bfe5-f17a1648474d", + "date": "2024-03-09T01:33:14.917Z", + "createdAt": "2024-03-09T01:33:14.917Z", + "updatedAt": "2024-03-09T01:33:14.917Z", + "type": "STATUS", + "description": "Service pending in DEV", + "author": "System", + "metaData": { + "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", + "metaData": { + "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", + "metaData": null, + "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27", + "shippingPrice": 284.02, + "status": "PENDING", + "labels": [ + { + "name": "Shipping label", + "id": "78c83922-d658-48bf-89d5-0658a6a94e27", + "type": "PDF", + "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf" + } + ] + }, + "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27", + "shippingPrice": 284.02, + "status": "PENDING", + "labels": [ + { + "name": "Shipping label", + "id": "78c83922-d658-48bf-89d5-0658a6a94e27", + "type": "PDF", + "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf" + } + ] + } + }, + { + "id": "9906da15-15e4-4dbd-8e90-c34ec43ed446", + "date": "2024-03-09T01:46:20.006Z", + "createdAt": "2024-03-09T01:46:20.006Z", + "updatedAt": "2024-03-09T01:46:20.006Z", + "type": "NOTE", + "description": "A new note has been added", + "author": "afterShip", + "metaData": { + "0": { + "type": "COMMENT", + "note": "The package is delivered at the door", + "author": "afterShip" + } + } + }, + { + "id": "35619274-3bca-4749-8a38-53a62776144a", + "date": "2024-03-09T01:44:17.437Z", + "createdAt": "2024-03-09T01:44:17.437Z", + "updatedAt": "2024-03-09T01:44:17.437Z", + "type": "NOTE", + "description": "A new note has been added", + "author": "afterShip", + "metaData": { + "0": { + "type": "COMMENT", + "note": "Tracking Number: 10001709948594168", + "author": "afterShip" + } + } + }, + { + "id": "9b60e3fd-5bf9-43c6-99f2-4292a57fa408", + "date": "2024-03-09T01:46:19.689Z", + "createdAt": "2024-03-09T01:46:19.689Z", + "updatedAt": "2024-03-09T01:46:19.689Z", + "type": "STATUS", + "description": "The package was delivered", + "author": "System", + "metaData": { + "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", + "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9361289676091361892011", + "status": "DELIVERED" + } + }, + { + "id": "21c9acaa-e14b-41bd-aaa7-a2cebd7384c0", + "date": "2024-03-09T01:43:15.887Z", + "createdAt": "2024-03-09T01:43:15.887Z", + "updatedAt": "2024-03-09T01:43:15.887Z", + "type": "STATUS", + "description": "Service pending", + "author": "System", + "metaData": { + "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", + "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9361289676091361892011", + "status": "PENDING" + } + }, + { + "id": "7a1a3a63-f94c-49f1-a912-bc3f095d7845", + "date": "2024-03-09T01:45:18.812Z", + "createdAt": "2024-03-09T01:45:18.812Z", + "updatedAt": "2024-03-09T01:45:18.812Z", + "type": "STATUS", + "description": "Courier picked the package", + "author": "System", + "metaData": { + "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", + "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9361289676091361892011", + "status": "PICKED" + } + }, + { + "id": "9ca25940-bdae-4f19-a5b4-92477abfa059", + "date": "2024-03-09T01:33:14.978Z", + "createdAt": "2024-03-09T01:33:14.978Z", + "updatedAt": "2024-03-09T01:33:14.978Z", + "type": "LABEL", + "description": "Added a label", + "author": "System", + "metaData": { + "name": "Shipping label", + "id": "78c83922-d658-48bf-89d5-0658a6a94e27", + "type": "PDF", + "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf" + } + }, + { + "id": "24b84b8b-7418-4ed8-bc89-b6a1cbee2331", + "date": "2024-03-09T01:43:16.289Z", + "createdAt": "2024-03-09T01:43:16.289Z", + "updatedAt": "2024-03-09T01:43:16.289Z", + "type": "NOTE", + "description": "A new note has been added", + "author": "afterShip", + "metaData": { + "0": { + "type": "COMMENT", + "note": "Tracking Number: 10001709948594168", + "author": "afterShip" + } + } + }, + { + "id": "9dfad688-e99a-4b27-9ccb-959da40c3bf8", + "date": "2024-03-09T01:33:08.385Z", + "createdAt": "2024-03-09T01:33:08.385Z", + "updatedAt": "2024-03-09T01:33:08.385Z", + "type": "STATUS", + "description": "Service creation by AfterShip", + "author": "System", + "metaData": { + "status": "CREATED" + } + }, + { + "id": "781ab0af-e62a-4a21-a837-8d0eea3f57c2", + "date": "2024-03-09T01:44:17.077Z", + "createdAt": "2024-03-09T01:44:17.077Z", + "updatedAt": "2024-03-09T01:44:17.077Z", + "type": "STATUS", + "description": "Courier on route", + "author": "System", + "metaData": { + "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", + "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9361289676091361892011", + "status": "ON_ROUTE" + } + } + ], + "notes": [ + { + "type": "COMMENT", + "date": "2024-03-09T01:43:16.280Z", + "content": "Tracking Number: 10001709948594168", + "author": "afterShip" + }, + { + "type": "COMMENT", + "date": "2024-03-09T01:44:17.423Z", + "content": "Tracking Number: 10001709948594168", + "author": "afterShip" + }, + { + "type": "COMMENT", + "date": "2024-03-09T01:46:19.998Z", + "content": "The package is delivered at the door", + "author": "afterShip" + } + ], + "timezone": { + "offset": 300, + "value": "America/Bogota", + "label": null + }, + "carrierLogo": "iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAYAAADDPmHLAAAACXBIWXMAACxLAAAsSwGlPZapAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAtTSURBVHgB7Z1PbBvHFca/WZICXCCFkt6aAGEORZ3YjaVD0d5MpUCL5BIZydGprUOKRBYg+ZQUDSqxSIG0F8uB7PZmufYxruVLghRwRN9S9GDZTpwUPZgB6t6aEE3hAKLEybxdrk3bEnd2dnb+LPcHyJLMFUXqffvem5k3bxgKCF+YGMfmZl18OYEAdXD2pPi6DoZ6dAEbF/+M3/9TrAPGO+DoiG/ooy2+/0JctyE+Omzl8xYKCEMB4At769gMGmDsoHhHDWHEOvJhI/zg/ArGxlpseaMNz/FWAHxubwMIpsVbeDFHgyexIbzEFaC35quH8EoAd43OgyMPu3DLMBEyOFqo1Zo+eQbnBdCP59PCvQujC/fuBy0RJs6y0zdX4TjOCqBv+HmwYMG5u10W8go93nRZCM4JoBCGfxCHheCUAPjsM0cRsEWLSV2+OCgEJwTAX5uoo9I9A39ifDY4XxPDyOMuJIsBLCPu+kVh/FsYFeMTjE2j270VvnfbLwWWGLm7fjcoLFRrU7a8gRUPwI/tO4LK1lWMuvEJyne2uuth/mMB4x5AGP+E+LSAkofhfEkkiE0YxJgAwuFdt3sR5V0/nChBnBEhoQMDGBFAGO+r3fXCDu90YzAvyF0ApfEVMSSCXAVQGj8jBkSQmwBK42siZxHkIoDS+JrJUQTaBRBm+1vdq6XxtbOBWigCraMD/RNBm1tnSuPnwoQYRp+AZrQKgM/uXwTj0yjJi6P89ae1TqJpCwF87mkq1boIH/jOI8BPhE4f+370/e1/AtcvA3e+hhcwNsVWPmlBA1oE4FXSN3UYeGEW2PPd+///y9vA+38CPl6D80RJ4aSOfECPAI7tWxWfjsBlfvBj4OU3gMf3Dr+OhHDhj8C1y3AaMWUs1g0OISOZBRCuYjF2Bq7yPeHmD/8+EkAaPr4EfHAK+O9/4CwsOMRWbmRyWZkE4LTrpzjfeCVy91lYPw+0/uKqEDpiaPhUllCQbRRQ6S45aXyK880Psxs/fq554eB+6uTghlZYM1UVKXuAfkXPLbiEbJxXhfKDc28B//oHnCLDqKAKVaJyLjdQjfNpeezxyBu4lh9wTl6gBQWUPIAziZ+uOK/K+6eBv6+5IQRFL6AmgLl9t6zH/t3G86ZxZ/6gxU59OoWUpBYAn9vfEC5nHbbIO86r4kJ+oOAF0gvg2D4yfgOmMRXns2I3P0jtBVIJwErmH8d5cvm23X0abOUHtdqjaeYF0s0D0LjfJE/88N543ifjE/SaacTwhOFQtbWZarUwnQAYDsIkjV/6Z/hBaNhInssknM2nuVxaAHzuR9PGM3+agqXkylfota+fg2HGw0RdEnkPwHvm50L/Ldbpf/uLKJ76xDf/i17zOy9H78E0vCe9MiudBIrs/yvQ3LMtaBTw/DExJ/8inMaNWcKOGA08KnOhlACsj/0HISFQckXx1SVo/E93vSvrBJJzApJrAeT+HWkmQncWhQVanXvhdftCcLaSKAzZraSrJAXAzGb/MtAfnKp2piytBVCcD2sFzrlZS8jZAZnLEm/r/q7er+AypvMDH6qFCIlJoeRRwNbWBEzx7HORMdNChjj/G5F1v5TvsJHi+8mZ6HepGJ/e27M/gzEkbCcRAnoNI/GfXPlLb0Rfq5ZhxcNG3fkBuXsqFFWN8zSd/fxs9B6JC38wMz/At0kArWGXJAuAw4wHGFzdo9mzA1PqyZWu/EBHnN9p2ZqmuI2QnAckC4CxJ4UIzEN37+G3oztZpUz7m6/vLcio5AfXPgL++o56nKdVy1fetjxKYRpCgCkPsBv0B3z1pHriFecHFFJ+9W6yQbKO591atq4nXTA0CeSv7a3DFegObv4tcqcqiWKcH5x/a+dEkdw9PUZJnorxKc5TDkOv0Z2ahfFwFDeE4R6gWq2LGUA4BQmAxJAlP6APGnHES7XkJW5c1hvnXSE6OWVjt4fVq4JtMpgfqJZhXf8o+siCE3E+gaBSh7IAer26SALhLLbKtH0pTyN62xlCAGN+tGunkBCGhZzLsGyXoedAggD4uJhThjdkzQ+G4XKcHwYbfuaC9W7h2onzg999qMdF03P8+j2R4b/pZ3laghf3MwmUIWt+4FOcz0DxPMCDUEh480K6RZjwZ94rhvE5z7Aa2EMbRWDPI9FwTWYCKb7zfa5GHoSzjMvBRWFPP4NPgtYNRojhAggqRlqWG+PAcxLXpN5f6TZB0B768LAHxSRCG0VCZsauKK4/ptfLkgP0iuUBRpGxsfawh4cKgP358zaio9RL/KSTvSaQlQLwmHbSBckC4L0rKPETzr9IukRiGBhsoMRPGG8lXSIRAlgpAF9hlUTbJQugWi0F4CsStksUQJhFMpQi0ImZrWQbMq1iJKeCef6J4O3PMDJ8aaByicnZTFIAQf5bX2nZdlS4bqIVvZzN5AQQxZJ85wPijRxFh95j/rWLHdl+gVICiGJJL/9blP44RRaBufcn7bHll4NZZRUmoD/Q4s/d68idBXovtHPZlLhZIH2zypeEURjodikM5F8pTC6Sdui40gVEFRvtYxlvpzlFRNoDRMNBfhYmocreuEuYT+3iBruEmfZknLXSXJ6uIqiHVdiA/pjkEXwYKdC+/8W+aG20jqltN9NcnkoA7PRNGg20YIN4l6+r+UHcPYSaP9jqGcT5JbYcLuFLk74snLGm+EUN2MK1/MClY2SCYBkpUTswwlbL+J2g3TppOonP7R/++MonkMK9LmFKB0aobQyx7QUGydIFRBWK8x+cdqs9HNlE5cegiFNeIIZq+l99d3iL9iwewLVuoPdQuvsJ9a1hLnmBGMoPaOilOz9w/TjZ2vYMFFHeGBLONTN2Ei4yOH9AsVqVwfG8u2cJr6bN/AfJtjOoWl2Cy1XDsfHi+QOZ3nzX+l1D6GdsjudlELN+acf9Dz0FMiJygQXx6QRKzMP5jJibWUUGdB0f715CWHxWReKnHPtj9GwOrdUOhe6oxAwaXH+MFgFE9QJBZjWWyBLMZEn87nsmaKI/KtCiypIhMN5UPSl8x6eDZkQ+sCo+SR9aVJICxk+ylZsL0Ij+BhG1Gr3AsoxcO/waqneWoJlcesCFPYarwTo4q6MkO5T0VXtTuuL+fU+NnChFoIkcjR8+PXKkFEFGcjZ++CuQM6UIFDFg/PDXwAClCFJiyPiEkTZxYauZ6tgkbNUT+kVLZPuTJoxPGO8Ezef2L4lFjEWUPEwO4/zEXwkL8NlnjopZQ1pB9KMdff50xE1xPOvKngrWesGXecFdWlTRY8rlP4j1wwBGOCR0qKJKzOsvwSJOnAYReYPKRetH1JnD6l0/iFPHgYS5QYDFwoYFGt710LQR63fDyfNgwjIzxucLJITQ3aP6/2W23HaqhtLZA4HCsBAEDc89grOGj/HiRKj+sHFefOlLjtASie1ZjN1Zc9XwMR4dCRYKYUIIgcLDQQe9Qr9/QrCms2Inb7wSwCBi+NgQd9lRq2Jg1IyZX/LN6IN4K4BB7uYLJsJEmMlXmhjrtlwYxmWlEAKICYVQqVxFflPMHTF+nyyC4WMKdWhU/4CL/CqTab6+QMYnCndqGDv16XIum1Zppc6hCRxdFPPYONq0qnOnUligob8i1wUKlQMM0h8yXoUOattPFc31xxT24Mh+R7PjyE7h4v4ghfUAMRl3LmvZgesyxT86VnXnssYduC5TeA9A9GcN19P9EJ/sh5FCMxKHR6feuUw7cEfA+MRIeIAYyXxAueWaj4zO8fHEdthObffl2Sjuj1Sji5ESQDhVzIZ1MineVG8So+UBQPnAjbUdp4rDzhuf5X84lmOMnABCov6G95K88JSNm0sYQUZSAGFTq+3tQ4jygQ5txETJ6EHVx2G94QjzLdIWvdPvEPp9AAAAAElFTkSuQmCC", + "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9361289676091361892011", + "comments": "Comments.", + "paymentMethod": "ONLINE", + "carrierServiceType": "BROKER", + "rate": { + "shippingPrice": { + "value": 0, + "currency": "USD" + }, + "insurancePrice": { + "value": 0, + "currency": "USD" + } + }, + "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", + "shippingFinishedDate": "2024-01-05T11:11:11.000Z", + "metaData": { + "integrationResponse": {}, + "carrier": { + "name": "[FedEx] Postmen Testing Account", + "image": null, + "metaData": {}, + "id": "fedex", + "type": { + "metaData": {}, + "terms": "", + "rate": { + "shippingPrice": { + "value": 284.02, + "currency": "USD" + }, + "insurancePrice": { + "value": 0, + "currency": "USD" + } + }, + "name": "FedEx First Overnight®", + "transitTime": 0, + "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", + "description": "FedEx", + "id": "fedex_first_overnight", + "international": false + } + } + } + } + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json; charset=utf-8": { + "schema": { + "$ref": "#/components/schemas/m4031" + }, + "example": { + "message": "Unauthorized", + "requestId": "c7c1ce02-b63f-4001-a1ac-798554c85bd6" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/m4031" + }, + "example": { + "message": "Invalid token", + "requestId": "09563f82-fe06-4004-b623-85e3aa4c92c9" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json; charset=utf-8": { + "schema": { + "$ref": "#/components/schemas/m4041" + }, + "example": { + "type": "exception", + "code": "TRP0005E", + "data": { + "0": "1", + "carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50", + "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27" + }, + "requestId": "9e3ce442-458c-4861-99aa-23b2cd2da9cf", + "date": "2024-03-15T06:00:21.009Z", + "message": "Service not found: 'MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&78c83922-d658-48bf-89d5-0658a6a94e27'" + } + } + } + } + }, + "deprecated": false, + "servers": [ + { + "url": "https://api.pickingnpacking.com/{environment}/v1/tracking/hook", + "variables": { + "environment": { + "default": "DefaultParameterValue" + } + } + } + ] + }, + "patch": { + "tags": [ + "Shipping updates" + ], + "summary": "Update service", + "description": "Updates a service with the details of the tracking service via webhook.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "operationId": "Updateservice", + "parameters": [ + { + "name": "carrierId", + "in": "path", + "description": "Carrier ID.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50" + } + }, + { + "name": "serviceId", + "in": "path", + "description": "Service ID.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "78c83922-d658-48bf-89d5-0658a6a94e27" + } + }, + { + "$ref": "#/components/parameters/Authorization" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateserviceRequest" + }, + "example": { + "message": "Service updated successfully", + "data": { + "status": "PENDING", + "agent": { + "id": "27327489234", + "name": "Pedro", + "identification": "020323809", + "phone": "+57314855674", + "email": "pedro434234@gmailc.om", + "vehicle": "SCOOTER" + }, + "trackingUrl": "https://localhost.com", + "totalDistanceTraveled": 2, + "rating": 5, + "shippingPrice": 150000, + "shippingEstimatedDate": "2024-04-27T20:25:45.067Z" + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json; charset=utf-8": { + "schema": { + "$ref": "#/components/schemas/ServiceBody1" + }, + "example": { + "message": "Service updated successfully", + "data": { + "status": "PENDING", + "agent": { + "id": "27327489234", + "name": "Pedro", + "identification": "020323809", + "phone": "+57314855674", + "email": "pedro434234@gmailc.om", + "vehicle": "SCOOTER" + }, + "trackingUrl": "https://localhost.com", + "totalDistanceTraveled": 2, + "rating": 5, + "shippingPrice": 150000, + "shippingEstimatedDate": "2024-04-27T20:25:45.067Z" + } + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json; charset=utf-8": { + "schema": { + "$ref": "#/components/schemas/m4031" + }, + "example": { + "message": "Unauthorized", + "requestId": "b5077045-e5ee-4eeb-8783-467c5454d03c" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/m4031" + }, + "example": { + "message": "Authentication token expired", + "requestId": "6d5f5fa2-cf31-4878-9be5-7e094022a206" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json; charset=utf-8": { + "schema": { + "$ref": "#/components/schemas/m4041" + }, + "example": { + "type": "exception", + "code": "TRP0005E", + "data": { + "0": "1", + "carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50", + "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27" + }, + "requestId": "8ce83c17-d9c4-434f-94cd-f2016bb7be8a", + "date": "2024-03-15T05:59:30.114Z", + "message": "Service not found: 'MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&_78c83922-d658-48bf-89d5-0658a6a94e27'" + } + } + } + } + }, + "deprecated": false, + "servers": [ + { + "url": "https://api.pickingnpacking.com/{environment}/v1/tracking/hook", + "variables": { + "environment": { + "default": "DefaultParameterValue" + } + } + } + ] + } + }, + "/notes/{carrierId}/{serviceId}": { + "post": { + "tags": [ + "Shipping updates" + ], + "summary": "Create notes", + "description": "Allows carriers to add notes and information on existing services.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "operationId": "Createnotes", + "parameters": [ + { + "name": "carrierId", + "in": "path", + "description": "Carrier ID.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50" + } + }, + { + "name": "serviceId", + "in": "path", + "description": "Service ID.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "78c83922-d658-48bf-89d5-0658a6a94e27" + } + }, + { + "$ref": "#/components/parameters/Authorization" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CreatenotesRequest" + } + }, + "example": [ + { + "type": "ERROR", + "note": "The package takes time to be shipped", + "author": "Oscar Rojas" + }, + { + "type": "COMMENT", + "note": "The package was picked up", + "author": "Oscar Rojas" + } + ] + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json; charset=utf-8": { + "schema": { + "$ref": "#/components/schemas/ServiceBody3" + }, + "example": { + "message": "Notes saved successfully", + "data": [ + { + "type": "ERROR", + "note": "The package takes time to be shipped", + "author": "Oscar Rojas" + }, + { + "type": "COMMENT", + "note": "The package was picked up", + "author": "Oscar Rojas" + } + ] + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json; charset=utf-8": { + "schema": { + "$ref": "#/components/schemas/m4031" + }, + "example": { + "message": "Unauthorized", + "requestId": "3c685f11-45ec-4b8a-88ce-b9fff421eafe" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/m4031" + }, + "example": { + "message": "Authentication token expired", + "requestId": "6fd59420-57c6-4111-bb32-e2aa35eff256" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json; charset=utf-8": { + "schema": { + "$ref": "#/components/schemas/m4041" + }, + "example": { + "type": "exception", + "code": "TRP0005E", + "data": { + "0": "1", + "carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50", + "serviceId": "servicemock" + }, + "requestId": "6129725b-fbb1-42dd-9ec2-4fefecce41c1", + "date": "2024-03-15T06:14:15.950Z", + "message": "Service not found: 'MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&servicemock'" + } + } + } + } + }, + "deprecated": false, + "servers": [ + { + "url": "https://api.pickingnpacking.com/{environment}/v1/tracking/hook", + "variables": { + "environment": { + "default": "DefaultParameterValue" + } + } + } + ] + } + }, + "/evidences/{carrierId}/{serviceId}": { + "post": { + "tags": [ + "Shipping updates" + ], + "summary": "Create evidence", + "description": "Allows the carrier to add evidence of delivery or pickup to the shipping service, as photos, text.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "operationId": "Createevidence", + "parameters": [ + { + "name": "carrierId", + "in": "path", + "description": "Carrier ID.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50" + } + }, + { + "name": "serviceId", + "in": "path", + "description": "Service ID.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "78c83922-d658-48bf-89d5-0658a6a94e27" + } + }, + { + "$ref": "#/components/parameters/Authorization" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CreateevidenceRequest" + }, + "example": [ + { + "type": "IMAGE", + "content": "https://parkers-images.bauersecure.com/wp-images/18727/courier-van-insurance-01.jpg", + "author": "Felipe Cardenas" + }, + { + "type": "TEXT", + "content": "The package was delivered", + "author": "Felipe Cardenas" + } + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json; charset=utf-8": { + "schema": { + "$ref": "#/components/schemas/ServiceBody4" + }, + "example": { + "message": "Evidences saved successfully", + "data": [ + { + "type": "IMAGE", + "content": "https://parkers-images.bauersecure.com/wp-images/18727/courier-van-insurance-01.jpg", + "author": "Felipe Cardenas" + }, + { + "type": "TEXT", + "content": "The package was delivered", + "author": "Felipe Cardenas" + } + ] + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json; charset=utf-8": { + "schema": { + "$ref": "#/components/schemas/m4031" + }, + "example": { + "message": "Unauthorized", + "requestId": "c482e112-aa73-4dfb-a31c-1586978dfead" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/m4031" + }, + "example": { + "message": "Authentication token expired", + "requestId": "bcd67893-292d-4547-a01f-62feb56f8a74" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json; charset=utf-8": { + "schema": { + "$ref": "#/components/schemas/m4041" + }, + "example": { + "type": "exception", + "code": "TRP0005E", + "data": { + "0": "1", + "carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50", + "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27" + }, + "requestId": "b39a0833-629f-429e-8955-f448165502ac", + "date": "2024-03-15T06:22:50.518Z", + "message": "Service not found: 'MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&_78c83922-d658-48bf-89d5-0658a6a94e27'" + } + } + } + } + }, + "deprecated": false, + "servers": [ + { + "url": "https://api.pickingnpacking.com/{environment}/v1/tracking/hook", + "variables": { + "environment": { + "default": "DefaultParameterValue" + } + } + } + ] + } + }, + "/labels/{carrierId}/{serviceId}": { + "post": { + "tags": [ + "Shipping updates" + ], + "summary": "Create label", + "description": "Allows the carrier to create and add a shipping label to an order. \n\nIt is important that the tag ID is a unique value, if this value is repeated it will throw an exception. \n\n> ⚠️ If the label is type `BASE64` or `TXT`, the max size that allowed is 180kb. \r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "operationId": "Createlabels", + "parameters": [ + { + "name": "carrierId", + "in": "path", + "description": "Carrier ID.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50" + } + }, + { + "name": "serviceId", + "in": "path", + "description": "Service ID.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "78c83922-d658-48bf-89d5-0658a6a94e27" + } + }, + { + "$ref": "#/components/parameters/Authorization" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatelabelsRequest" + }, + "example": { + "id": "JADF8ADF89-7AD7AF-78ADFASDF", + "url": "http://s3://mybucket-alpha/orc/2013-10-04-custdata/label-pickup.pdf", + "name": "Delivery label", + "type": "PDF" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json; charset=utf-8": { + "schema": { + "$ref": "#/components/schemas/ServiceBody5" + }, + "example": { + "message": "Label saved successfully", + "data": { + "id": "JADF8ADF89-7AD7AF-78ADFASDF", + "url": "http://s3://mybucket-alpha/orc/2013-10-04-custdata/label-pickup.pdf", + "name": "Delivery label", + "type": "PDF" + } + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json; charset=utf-8": { + "schema": { + "$ref": "#/components/schemas/m4031" + }, + "example": { + "message": "Unauthorized", + "requestId": "c482e112-aa73-4dfb-a31c-1586978dfead" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/m4031" + }, + "example": { + "message": "Authentication token expired", + "requestId": "8c0bbb1b-8486-4d94-8136-8586c0ea2efe" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json; charset=utf-8": { + "schema": { + "$ref": "#/components/schemas/m4041" + }, + "example": { + "type": "exception", + "code": "TRP0005E", + "data": { + "0": "1", + "carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50", + "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27" + }, + "requestId": "b39a0833-629f-429e-8955-f448165502ac", + "date": "2024-03-15T06:22:50.518Z", + "message": "Service not found: 'MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&_78c83922-d658-48bf-89d5-0658a6a94e27'" + } + } + } + } + }, + "deprecated": false, + "servers": [ + { + "url": "https://api.pickingnpacking.com/{environment}/v1/tracking/hook", + "variables": { + "environment": { + "default": "DefaultParameterValue" + } + } + } + ] + } + }, + "/cancel/{carrierId}/{serviceId}": { + "post": { + "tags": [ + "Shipping updates" + ], + "summary": "Cancel ongoing service", + "description": "Resquest that will cancel an ongoing shipping service.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "operationId": "PostCancelservice", + "parameters": [ + { + "name": "carrierId", + "in": "path", + "description": "Carrier ID.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50" + } + }, + { + "name": "serviceId", + "in": "path", + "description": "Service ID.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "78c83922-d658-48bf-89d5-0658a6a94e27" + } + }, + { + "$ref": "#/components/parameters/Authorization" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CancelOngoingServiceRequest" + }, + "example": { + "comment": "The delivery address was changed", + "type": "END_CLIENT_CANCELED" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json; charset=utf-8": { + "schema": { + "$ref": "#/components/schemas/ServiceBody6" + }, + "example": { + "message": "Service canceled successfully", + "data": { + "comment": "The delivery address was changed", + "type": "END_CLIENT_CANCELED" + } + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json; charset=utf-8": { + "schema": { + "$ref": "#/components/schemas/m4031" + }, + "example": { + "message": "Unauthorized", + "requestId": "c482e112-aa73-4dfb-a31c-1586978dfead" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/m4031" + }, + "example": { + "message": "Authentication token expired", + "requestId": "8c0bbb1b-8486-4d94-8136-8586c0ea2efe" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json; charset=utf-8": { + "schema": { + "$ref": "#/components/schemas/m4041" + }, + "example": { + "type": "exception", + "code": "TRP0005E", + "data": { + "0": "1", + "carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50", + "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27" + }, + "requestId": "b39a0833-629f-429e-8955-f448165502ac", + "date": "2024-03-15T06:22:50.518Z", + "message": "Service not found: 'MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&_78c83922-d658-48bf-89d5-0658a6a94e27'" + } + } + } + } + }, + "deprecated": false, + "servers": [ + { + "url": "https://api.pickingnpacking.com/{environment}/v1/tracking/hook", + "variables": { + "environment": { + "default": "DefaultParameterValue" + } + } + } + ] + } + }, + "/cancel-service": { + "post": { + "tags": [ + "Shipping updates" + ], + "summary": "Cancel service", + "description": "Cancels a specific service.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "operationId": "Createservice", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CancelServiceRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CancelServiceResponse" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Required authentication" + }, + "404": { + "description": "Resource not found" + }, + "500": { + "description": "Internal error" + } + }, + "deprecated": false, + "servers": [ + { + "url": "https://{store_endpoint}", + "variables": { + "your_endpoint": { + "default": "storeapi.com", + "description": "Server from the store." + } + } + } + ] + } + }, + "/pause-service": { + "post": { + "tags": [ + "Shipping updates" + ], + "summary": "Pause and resume service", + "description": "Pauses or resumes a paused service.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "operationId": "Createservice", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PauseResumeServiceRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PauseResumeServiceResponse" + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Required authentication" + }, + "404": { + "description": "Resource not found" + }, + "500": { + "description": "Internal error" + } + }, + "deprecated": false, + "servers": [ + { + "url": "https://{store_endpoint}", + "variables": { + "your_endpoint": { + "default": "storeapi.com", + "description": "Server from the store." + } + } + } + ] + } + }, + "/on-hold/{carrierId}/{serviceId}": { + "post": { + "tags": [ + "Shipping updates" + ], + "summary": "Create on hold service", + "description": "Request that allows a carrier to temporarily pause a shipping service.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "operationId": "Onholdservice", + "parameters": [ + { + "name": "carrierId", + "in": "path", + "description": "Carrier ID.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50" + } + }, + { + "name": "serviceId", + "in": "path", + "description": "Service ID.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "78c83922-d658-48bf-89d5-0658a6a94e27" + } + }, + { + "$ref": "#/components/parameters/Authorization" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnholdserviceRequest" + }, + "example": { + "comment": "The delivery address was changed", + "type": "END_CLIENT_PAUSE" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json; charset=utf-8": { + "schema": { + "$ref": "#/components/schemas/ServiceBody6" + }, + "example": { + "message": "Service on hold successfully", + "data": { + "comment": "The delivery address was changed", + "type": "END_CLIENT_PAUSE" + } + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json; charset=utf-8": { + "schema": { + "$ref": "#/components/schemas/m4031" + }, + "example": { + "message": "Unauthorized", + "requestId": "c482e112-aa73-4dfb-a31c-1586978dfead" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/m4031" + }, + "example": { + "message": "Authentication token expired", + "requestId": "8c0bbb1b-8486-4d94-8136-8586c0ea2efe" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json; charset=utf-8": { + "schema": { + "$ref": "#/components/schemas/m4041" + }, + "example": { + "type": "exception", + "code": "TRP0005E", + "data": { + "0": "1", + "carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50", + "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27" + }, + "requestId": "b39a0833-629f-429e-8955-f448165502ac", + "date": "2024-03-15T06:22:50.518Z", + "message": "Service not found: 'MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&_78c83922-d658-48bf-89d5-0658a6a94e27'" + } + } + } + } + }, + "deprecated": false, + "servers": [ + { + "url": "https://api.pickingnpacking.com/{environment}/v1/tracking/hook", + "variables": { + "environment": { + "default": "DefaultParameterValue" + } + } + } + ] + } + } + }, + "components": { + "parameters": { + "Authorization": { + "name": "Authorization", + "in": "header", + "description": "Authentication JWT. JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information as a JSON object between parties.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "{token}" + } + } + }, + "schemas": { + "CreatetokenRequest": { + "required": [ + "apiKey" + ], + "type": "object", + "properties": { + "apiKey": { + "type": "string", + "description": "The `API KEY` previously generated by the Pick and Pack team. To contact the team, fill out our [form](https://vtex.com/us-en/contact) and indicate the name of the Pick and Pack product in the `Comments` section." + } + }, + "example": { + "apiKey": "{pnpApiKey}" + } + }, + "CreateServiceBody": { + "type": "object", + "properties": { + "orderId": { + "type": "string", + "description": "Order ID." + }, + "carrierId": { + "type": "string", + "description": "Carrier ID." + }, + "seller": { + "type": "string", + "description": "Identifier representing the seller associated with the order." + }, + "sender": { + "description": "Sender personal information.", + "type": "object", + "properties": { + "name": { + "description": "Sender name.", + "type": "string" + }, + "phone": { + "description": "Sender phone number.", + "type": "string" + }, + "email": { + "description": "Sender email.", + "type": "string" + }, + "city": { + "description": "Sender city of residence.", + "type": "string" + }, + "state": { + "description": "Sender state of residence.", + "type": "string" + }, + "country": { + "description": "Sender country of residence.", + "type": "string" + }, + "address": { + "description": "Sender address.", + "type": "string" + }, + "addressComplement": { + "description": "Sender address complement, as apartment number.", + "type": "string" + }, + "number": { + "description": "Sender residence number.", + "type": "string" + }, + "reference": { + "description": "Reference to the sender's address to facilitate localization.", + "type": "string" + }, + "location": { + "description": "Object containing specific latitude and longitude of the sender's address.", + "type": "object", + "properties": { + "latitude": { + "description": "Sender address' latitude.", + "type": "number" + }, + "longitude": { + "description": "Sender address' longitude.", + "type": "number" + } + } + }, + "pickupDate": { + "description": "Package pickup date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", + "type": "string" + } + } + }, + "receiver": { + "description": "Receiver personal information.", + "type": "object", + "properties": { + "name": { + "description": "Receiver name.", + "type": "string" + }, + "phone": { + "description": "Receiver phone number.", + "type": "string" + }, + "email": { + "description": "Receiver email.", + "type": "string" + }, + "city": { + "description": "Receiver city of residence.", + "type": "string" + }, + "state": { + "description": "Receiver state of residence.", + "type": "string" + }, + "country": { + "description": "Receiver country of residence.", + "type": "string" + }, + "address": { + "description": "Receiver address.", + "type": "string" + }, + "addressComplement": { + "description": "Receiver address complement, as apartment number.", + "type": "string" + }, + "number": { + "description": "Receiver residence number.", + "type": "string" + }, + "reference": { + "description": "Reference to the receiver's address to facilitate localization.", + "type": "string" + }, + "location": { + "description": "Object containing specific latitude and longitude of the receiver's address.", + "type": "object", + "properties": { + "latitude": { + "description": "Receiver address' latitude.", + "type": "number" + }, + "longitude": { + "description": "Receiver address' longitude.", + "type": "number" + } + } + }, + "identification": { + "description": "Receiver identification code.", + "type": "string" + }, + "deliveryDate": { + "description": "Delivery estimated date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", + "type": "string" + }, + "contactName": { + "description": "Receiver contact name.", + "type": "string" + }, + "deliveryWindow": { + "description": "Object containing information about package delivery window.", + "type": "object", + "properties": { + "name": { + "description": "Carrier name.", + "type": "string" + }, + "initialDate": { + "description": "Delivery initial date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", + "type": "string" + }, + "finalDate": { + "description": "Delivery final date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.", + "type": "string" + } + } + } + } + }, + "packages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Package" + }, + "description": "Array containing information about all order's packages." + }, + "carrierServiceType": { + "type": "string", + "description": "Carrier service type. The `carrierServiceType` value is not limited to these specific values. It will be defined by the carrier integrating with the Pick and Pack Last Mile Protocol API.", + "enum": [ + "BROKER", + "PICKUP_IN_STORE", + "NATIONAL", + "INTERNATIONAL", + "EXPRESS", + "SPECIALIZED", + "OTHERS" + ] + }, + "type": { + "type": "string", + "description": "Order's type of delivery, `Delivery` or [`Pickup`](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R)." + }, + "paymentMethod": { + "type": "string", + "description": "Payment method." + }, + "comments": { + "type": "string", + "description": "Comments." + }, + "orderValue": { + "type": "integer", + "description": "Total value of the order." + }, + "settings": { + "description": "Array of objects with additional custom fields defined by the carrier.", + "type": "array", + "items": { + "description": "Object containing information about a custom field.", + "type": "object", + "properties": { + "label": { + "description": "Custom field description.", + "type": "string" + }, + "value": { + "description": "Custom field value.", + "type": "string" + }, + "key": { + "description": "Custom field key.", + "type": "string" + } + } + } + }, + "timezone": { + "$ref": "#/components/schemas/Timezone" + } + } + }, + "ServiceBody": { + "required": [ + "message", + "data" + ], + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "Status message about the request." + }, + "data": { + "$ref": "#/components/schemas/Data", + "type": "object", + "description": "Service general information." + } + } + }, + "Data": { + "required": [ + "id", + "orderId", + "carrierId", + "serviceId", + "carrierName", + "seller", + "status", + "type", + "tags", + "labels", + "evidences", + "packages", + "timeline", + "notes", + "timezone", + "carrierLogo", + "trackingUrl", + "comments", + "paymentMethod", + "carrierServiceType", + "rate", + "shippingEstimatedDate", + "shippingFinishedDate", + "metaData" + ], + "properties": { + "id": { + "type": "string", + "description": "Service ID." + }, + "orderId": { + "type": "string", + "description": "Order ID." + }, + "carrierId": { + "type": "string", + "description": "Carrier ID." + }, + "serviceId": { + "type": "string", + "description": "Service ID." + }, + "carrierName": { + "type": "string", + "description": "Carrier name." + }, + "seller": { + "type": "string", + "description": "Identifier representing the seller associated with the order." + }, + "status": { + "type": "string", + "description": "Order [status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196)." + }, + "type": { + "type": "string", + "description": "Order's type of delivery, `Delivery` or [`Pickup`](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R)." + }, + "tags": { + "type": "array", + "items": { + "type": "string", + "description": "Extra information added in the order." + }, + "description": "Array of tags." + }, + "labels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Label" + }, + "description": "Array containing information about all shipping labels printed in the order." + }, + "evidences": { + "type": "array", + "items": { + "type": "string", + "description": "Message explaining the delivery incident." + }, + "description": "Array with additional notes when an incident occurs in the delivery of the package." + }, + "packages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Package" + }, + "description": "Array containing information about all order's packages." + }, + "timeline": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Timeline" + }, + "description": "Array containing information about the timeline of order changes." + }, + "notes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Note" + }, + "description": "Array with services information." + }, + "timezone": { + "$ref": "#/components/schemas/Timezone" + }, + "carrierLogo": { + "type": "string", + "description": "Carrier logo." + }, + "trackingUrl": { + "type": "string", + "description": "Tracking URL." + }, + "comments": { + "type": "string", + "description": "Comments." + }, + "paymentMethod": { + "type": "string", + "description": "Payment method." + }, + "carrierServiceType": { + "type": "string", + "description": "Carrier service type. The `carrierServiceType` value is not limited to these specific values. It will be defined by the carrier integrating with the Pick and Pack Last Mile Protocol API.", + "enum": [ + "BROKER", + "PICKUP_IN_STORE", + "NATIONAL", + "INTERNATIONAL", + "EXPRESS", + "SPECIALIZED", + "OTHERS" + ] + }, + "rate": { + "$ref": "#/components/schemas/Rate" + }, + "shippingEstimatedDate": { + "type": "string", + "description": "Shipping estimated date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + }, + "shippingFinishedDate": { + "type": "string", + "nullable": true, + "description": "Shipping finished date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + }, + "metaData": { + "$ref": "#/components/schemas/MetaData1" + } + }, + "example": { + "id": "519400fb-f980-4a6a-809c-9f986fdb98a4", + "orderId": "46369545534253-01", + "carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50", + "serviceId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&78c83922-d658-48bf-89d5-0658a6a94e27", + "carrierName": "AfterShip", + "seller": "lastmile", + "status": "DELIVERED", + "type": "PICKUP_DELIVERY", + "tags": [], + "labels": [ + { + "id": "78c83922-d658-48bf-89d5-0658a6a94e27", + "name": "Shipping label", + "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf", + "type": "PDF" + } + ], + "evidences": [], + "packages": [ + { + "id": "a46e5bc1-8959-459f-a094-b6e699f7214c", + "orderId": "46369545534253-01", + "envelope": "Foam or Plastic Containers", + "dimensions": { + "height": "5", + "length": "11", + "width": "7" + }, + "weight": "48", + "totalValue": 5352, + "items": [ + { + "id": "184", + "name": "Chicken", + "ean": "EAN354", + "quantity": 8, + "price": 669, + "refId": "314", + "image": "https://picsum.photos/seed/YtoZ9/128/480", + "type": "other", + "weight": "6" + } + ], + "categories": [ + "Movies", + "Garden", + "Books" + ], + "description": "Unde deserunt libero cupiditate illum." + } + ], + "timeline": [ + { + "id": "77263f59-0ac5-4b0c-bfe5-f17a1648474d", + "date": "2024-03-09T01:33:14.917Z", + "createdAt": "2024-03-09T01:33:14.917Z", + "updatedAt": "2024-03-09T01:33:14.917Z", + "type": "STATUS", + "description": "Service pending in DEV", + "author": "System", + "metaData": { + "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", + "metaData": null, + "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27", + "shippingPrice": 284.02, + "status": "PENDING", + "labels": [ + { + "name": "Shipping label", + "id": "78c83922-d658-48bf-89d5-0658a6a94e27", + "type": "PDF", + "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf" + } + ] + } + }, + { + "id": "9906da15-15e4-4dbd-8e90-c34ec43ed446", + "date": "2024-03-09T01:46:20.006Z", + "createdAt": "2024-03-09T01:46:20.006Z", + "updatedAt": "2024-03-09T01:46:20.006Z", + "type": "NOTE", + "description": "A new note has been added", + "author": "afterShip", + "metaData": { + "0": { + "type": "COMMENT", + "note": "The package is delivered at the door", + "author": "afterShip" + } + } + }, + { + "id": "35619274-3bca-4749-8a38-53a62776144a", + "date": "2024-03-09T01:44:17.437Z", + "createdAt": "2024-03-09T01:44:17.437Z", + "updatedAt": "2024-03-09T01:44:17.437Z", + "type": "NOTE", + "description": "A new note has been added", + "author": "afterShip", + "metaData": { + "0": { + "type": "COMMENT", + "note": "Tracking Number: 10001709948594168", + "author": "afterShip" + } + } + }, + { + "id": "9b60e3fd-5bf9-43c6-99f2-4292a57fa408", + "date": "2024-03-09T01:46:19.689Z", + "createdAt": "2024-03-09T01:46:19.689Z", + "updatedAt": "2024-03-09T01:46:19.689Z", + "type": "STATUS", + "description": "The package was delivered", + "author": "System", + "metaData": { + "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", + "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9361289676091361892011", + "status": "DELIVERED" + } + }, + { + "id": "21c9acaa-e14b-41bd-aaa7-a2cebd7384c0", + "date": "2024-03-09T01:43:15.887Z", + "createdAt": "2024-03-09T01:43:15.887Z", + "updatedAt": "2024-03-09T01:43:15.887Z", + "type": "STATUS", + "description": "Service pending", + "author": "System", + "metaData": { + "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", + "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9361289676091361892011", + "status": "PENDING" + } + }, + { + "id": "7a1a3a63-f94c-49f1-a912-bc3f095d7845", + "date": "2024-03-09T01:45:18.812Z", + "createdAt": "2024-03-09T01:45:18.812Z", + "updatedAt": "2024-03-09T01:45:18.812Z", + "type": "STATUS", + "description": "Courier picked the package", + "author": "System", + "metaData": { + "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", + "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9361289676091361892011", + "status": "PICKED" + } + }, + { + "id": "9ca25940-bdae-4f19-a5b4-92477abfa059", + "date": "2024-03-09T01:33:14.978Z", + "createdAt": "2024-03-09T01:33:14.978Z", + "updatedAt": "2024-03-09T01:33:14.978Z", + "type": "LABEL", + "description": "Added a label", + "author": "System", + "metaData": { + "name": "Shipping label", + "id": "78c83922-d658-48bf-89d5-0658a6a94e27", + "type": "PDF", + "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf" + } + }, + { + "id": "24b84b8b-7418-4ed8-bc89-b6a1cbee2331", + "date": "2024-03-09T01:43:16.289Z", + "createdAt": "2024-03-09T01:43:16.289Z", + "updatedAt": "2024-03-09T01:43:16.289Z", + "type": "NOTE", + "description": "A new note has been added", + "author": "afterShip", + "metaData": { + "0": { + "type": "COMMENT", + "note": "Tracking Number: 10001709948594168", + "author": "afterShip" + } + } + }, + { + "id": "9dfad688-e99a-4b27-9ccb-959da40c3bf8", + "date": "2024-03-09T01:33:08.385Z", + "createdAt": "2024-03-09T01:33:08.385Z", + "updatedAt": "2024-03-09T01:33:08.385Z", + "type": "STATUS", + "description": "Service creation by AfterShip", + "author": "System", + "metaData": { + "status": "CREATED" + } + }, + { + "id": "781ab0af-e62a-4a21-a837-8d0eea3f57c2", + "date": "2024-03-09T01:44:17.077Z", + "createdAt": "2024-03-09T01:44:17.077Z", + "updatedAt": "2024-03-09T01:44:17.077Z", + "type": "STATUS", + "description": "Courier on route", + "author": "System", + "metaData": { + "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", + "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9361289676091361892011", + "status": "ON_ROUTE" + } + } + ], + "notes": [ + { + "type": "COMMENT", + "date": "2024-03-09T01:43:16.280Z", + "content": "Tracking Number: 10001709948594168", + "author": "afterShip" + }, + { + "type": "COMMENT", + "date": "2024-03-09T01:44:17.423Z", + "content": "Tracking Number: 10001709948594168", + "author": "afterShip" + }, + { + "type": "COMMENT", + "date": "2024-03-09T01:46:19.998Z", + "content": "The package is delivered at the door", + "author": "afterShip" + } + ], + "timezone": { + "offset": 300, + "value": "America/Bogota", + "label": null + }, + "carrierLogo": "iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAYAAADDPmHLAAAACXBIWXMAACxLAAAsSwGlPZapAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAtTSURBVHgB7Z1PbBvHFca/WZICXCCFkt6aAGEORZ3YjaVD0d5MpUCL5BIZydGprUOKRBYg+ZQUDSqxSIG0F8uB7PZmufYxruVLghRwRN9S9GDZTpwUPZgB6t6aEE3hAKLEybxdrk3bEnd2dnb+LPcHyJLMFUXqffvem5k3bxgKCF+YGMfmZl18OYEAdXD2pPi6DoZ6dAEbF/+M3/9TrAPGO+DoiG/ooy2+/0JctyE+Omzl8xYKCEMB4At769gMGmDsoHhHDWHEOvJhI/zg/ArGxlpseaMNz/FWAHxubwMIpsVbeDFHgyexIbzEFaC35quH8EoAd43OgyMPu3DLMBEyOFqo1Zo+eQbnBdCP59PCvQujC/fuBy0RJs6y0zdX4TjOCqBv+HmwYMG5u10W8go93nRZCM4JoBCGfxCHheCUAPjsM0cRsEWLSV2+OCgEJwTAX5uoo9I9A39ifDY4XxPDyOMuJIsBLCPu+kVh/FsYFeMTjE2j270VvnfbLwWWGLm7fjcoLFRrU7a8gRUPwI/tO4LK1lWMuvEJyne2uuth/mMB4x5AGP+E+LSAkofhfEkkiE0YxJgAwuFdt3sR5V0/nChBnBEhoQMDGBFAGO+r3fXCDu90YzAvyF0ApfEVMSSCXAVQGj8jBkSQmwBK42siZxHkIoDS+JrJUQTaBRBm+1vdq6XxtbOBWigCraMD/RNBm1tnSuPnwoQYRp+AZrQKgM/uXwTj0yjJi6P89ae1TqJpCwF87mkq1boIH/jOI8BPhE4f+370/e1/AtcvA3e+hhcwNsVWPmlBA1oE4FXSN3UYeGEW2PPd+///y9vA+38CPl6D80RJ4aSOfECPAI7tWxWfjsBlfvBj4OU3gMf3Dr+OhHDhj8C1y3AaMWUs1g0OISOZBRCuYjF2Bq7yPeHmD/8+EkAaPr4EfHAK+O9/4CwsOMRWbmRyWZkE4LTrpzjfeCVy91lYPw+0/uKqEDpiaPhUllCQbRRQ6S45aXyK880Psxs/fq554eB+6uTghlZYM1UVKXuAfkXPLbiEbJxXhfKDc28B//oHnCLDqKAKVaJyLjdQjfNpeezxyBu4lh9wTl6gBQWUPIAziZ+uOK/K+6eBv6+5IQRFL6AmgLl9t6zH/t3G86ZxZ/6gxU59OoWUpBYAn9vfEC5nHbbIO86r4kJ+oOAF0gvg2D4yfgOmMRXns2I3P0jtBVIJwErmH8d5cvm23X0abOUHtdqjaeYF0s0D0LjfJE/88N543ifjE/SaacTwhOFQtbWZarUwnQAYDsIkjV/6Z/hBaNhInssknM2nuVxaAHzuR9PGM3+agqXkylfota+fg2HGw0RdEnkPwHvm50L/Ldbpf/uLKJ76xDf/i17zOy9H78E0vCe9MiudBIrs/yvQ3LMtaBTw/DExJ/8inMaNWcKOGA08KnOhlACsj/0HISFQckXx1SVo/E93vSvrBJJzApJrAeT+HWkmQncWhQVanXvhdftCcLaSKAzZraSrJAXAzGb/MtAfnKp2piytBVCcD2sFzrlZS8jZAZnLEm/r/q7er+AypvMDH6qFCIlJoeRRwNbWBEzx7HORMdNChjj/G5F1v5TvsJHi+8mZ6HepGJ/e27M/gzEkbCcRAnoNI/GfXPlLb0Rfq5ZhxcNG3fkBuXsqFFWN8zSd/fxs9B6JC38wMz/At0kArWGXJAuAw4wHGFzdo9mzA1PqyZWu/EBHnN9p2ZqmuI2QnAckC4CxJ4UIzEN37+G3oztZpUz7m6/vLcio5AfXPgL++o56nKdVy1fetjxKYRpCgCkPsBv0B3z1pHriFecHFFJ+9W6yQbKO591atq4nXTA0CeSv7a3DFegObv4tcqcqiWKcH5x/a+dEkdw9PUZJnorxKc5TDkOv0Z2ahfFwFDeE4R6gWq2LGUA4BQmAxJAlP6APGnHES7XkJW5c1hvnXSE6OWVjt4fVq4JtMpgfqJZhXf8o+siCE3E+gaBSh7IAer26SALhLLbKtH0pTyN62xlCAGN+tGunkBCGhZzLsGyXoedAggD4uJhThjdkzQ+G4XKcHwYbfuaC9W7h2onzg999qMdF03P8+j2R4b/pZ3laghf3MwmUIWt+4FOcz0DxPMCDUEh480K6RZjwZ94rhvE5z7Aa2EMbRWDPI9FwTWYCKb7zfa5GHoSzjMvBRWFPP4NPgtYNRojhAggqRlqWG+PAcxLXpN5f6TZB0B768LAHxSRCG0VCZsauKK4/ptfLkgP0iuUBRpGxsfawh4cKgP358zaio9RL/KSTvSaQlQLwmHbSBckC4L0rKPETzr9IukRiGBhsoMRPGG8lXSIRAlgpAF9hlUTbJQugWi0F4CsStksUQJhFMpQi0ImZrWQbMq1iJKeCef6J4O3PMDJ8aaByicnZTFIAQf5bX2nZdlS4bqIVvZzN5AQQxZJ85wPijRxFh95j/rWLHdl+gVICiGJJL/9blP44RRaBufcn7bHll4NZZRUmoD/Q4s/d68idBXovtHPZlLhZIH2zypeEURjodikM5F8pTC6Sdui40gVEFRvtYxlvpzlFRNoDRMNBfhYmocreuEuYT+3iBruEmfZknLXSXJ6uIqiHVdiA/pjkEXwYKdC+/8W+aG20jqltN9NcnkoA7PRNGg20YIN4l6+r+UHcPYSaP9jqGcT5JbYcLuFLk74snLGm+EUN2MK1/MClY2SCYBkpUTswwlbL+J2g3TppOonP7R/++MonkMK9LmFKB0aobQyx7QUGydIFRBWK8x+cdqs9HNlE5cegiFNeIIZq+l99d3iL9iwewLVuoPdQuvsJ9a1hLnmBGMoPaOilOz9w/TjZ2vYMFFHeGBLONTN2Ei4yOH9AsVqVwfG8u2cJr6bN/AfJtjOoWl2Cy1XDsfHi+QOZ3nzX+l1D6GdsjudlELN+acf9Dz0FMiJygQXx6QRKzMP5jJibWUUGdB0f715CWHxWReKnHPtj9GwOrdUOhe6oxAwaXH+MFgFE9QJBZjWWyBLMZEn87nsmaKI/KtCiypIhMN5UPSl8x6eDZkQ+sCo+SR9aVJICxk+ylZsL0Ij+BhG1Gr3AsoxcO/waqneWoJlcesCFPYarwTo4q6MkO5T0VXtTuuL+fU+NnChFoIkcjR8+PXKkFEFGcjZ++CuQM6UIFDFg/PDXwAClCFJiyPiEkTZxYauZ6tgkbNUT+kVLZPuTJoxPGO8Ezef2L4lFjEWUPEwO4/zEXwkL8NlnjopZQ1pB9KMdff50xE1xPOvKngrWesGXecFdWlTRY8rlP4j1wwBGOCR0qKJKzOsvwSJOnAYReYPKRetH1JnD6l0/iFPHgYS5QYDFwoYFGt710LQR63fDyfNgwjIzxucLJITQ3aP6/2W23HaqhtLZA4HCsBAEDc89grOGj/HiRKj+sHFefOlLjtASie1ZjN1Zc9XwMR4dCRYKYUIIgcLDQQe9Qr9/QrCms2Inb7wSwCBi+NgQd9lRq2Jg1IyZX/LN6IN4K4BB7uYLJsJEmMlXmhjrtlwYxmWlEAKICYVQqVxFflPMHTF+nyyC4WMKdWhU/4CL/CqTab6+QMYnCndqGDv16XIum1Zppc6hCRxdFPPYONq0qnOnUligob8i1wUKlQMM0h8yXoUOattPFc31xxT24Mh+R7PjyE7h4v4ghfUAMRl3LmvZgesyxT86VnXnssYduC5TeA9A9GcN19P9EJ/sh5FCMxKHR6feuUw7cEfA+MRIeIAYyXxAueWaj4zO8fHEdthObffl2Sjuj1Sji5ESQDhVzIZ1MineVG8So+UBQPnAjbUdp4rDzhuf5X84lmOMnABCov6G95K88JSNm0sYQUZSAGFTq+3tQ4jygQ5txETJ6EHVx2G94QjzLdIWvdPvEPp9AAAAAElFTkSuQmCC", + "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9361289676091361892011", + "comments": "Comments.", + "paymentMethod": "ONLINE", + "carrierServiceType": "BROKER", + "rate": { + "shippingPrice": { + "value": 0, + "currency": "USD" + }, + "insurancePrice": { + "value": 0, + "currency": "USD" + } + }, + "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", + "shippingFinishedDate": "2024-01-05T11:11:11.000Z", + "metaData": { + "integrationResponse": {}, + "carrier": { + "name": "[FedEx] Postmen Testing Account", + "image": null, + "metaData": {}, + "id": "fedex", + "type": { + "metaData": {}, + "terms": "", + "rate": { + "shippingPrice": { + "value": 284.02, + "currency": "USD" + }, + "insurancePrice": { + "value": 0, + "currency": "USD" + } + }, + "name": "FedEx First Overnight®", + "transitTime": 0, + "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", + "description": "FedEx", + "id": "fedex_first_overnight", + "international": false + } + } + } + } + }, + "Label": { + "required": [ + "id", + "name", + "url", + "type" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Label ID." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "url": { + "type": "string", + "description": "Label URL." + }, + "type": { + "type": "string", + "description": "Label's type of file." + } + }, + "example": { + "id": "78c83922-d658-48bf-89d5-0658a6a94e27", + "name": "Shipping label", + "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf", + "type": "PDF" + } + }, + "Package": { + "required": [ + "id", + "orderId", + "envelope", + "dimensions", + "weight", + "totalValue", + "items", + "categories", + "description" + ], + "type": "object", + "description": "Package information.", + "properties": { + "id": { + "type": "string", + "description": "Package ID." + }, + "orderId": { + "type": "string", + "description": "Order ID." + }, + "envelope": { + "type": "string", + "description": "Name of the envelope used." + }, + "dimensions": { + "$ref": "#/components/schemas/Dimensions", + "description": "Package dimensions." + }, + "weight": { + "type": "string", + "description": "Package weight in grams." + }, + "totalValue": { + "type": "integer", + "format": "int32", + "description": "Total value of the order." + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Item", + "description": "Product general information." + }, + "description": "Array containing information about the order's products." + }, + "categories": { + "type": "array", + "items": { + "type": "string", + "description": "Category name." + }, + "description": "Array of categories." + }, + "description": { + "type": "string", + "description": "Package description." + } + }, + "example": { + "id": "a46e5bc1-8959-459f-a094-b6e699f7214c", + "orderId": "46369545534253-01", + "envelope": "Foam or Plastic Containers", + "dimensions": { + "height": "5", + "length": "11", + "width": "7" + }, + "weight": "48", + "totalValue": 5352, + "items": [ + { + "id": "184", + "name": "Chicken", + "ean": "EAN354", + "quantity": 8, + "price": 669, + "refId": "314", + "image": "https://picsum.photos/seed/YtoZ9/128/480", + "type": "other", + "weight": "6" + } + ], + "categories": [ + "Movies", + "Garden", + "Books" + ], + "description": "Unde deserunt libero cupiditate illum." + } + }, + "Dimensions": { + "required": [ + "height", + "length", + "width" + ], + "type": "object", + "properties": { + "height": { + "type": "string", + "description": "Package height in centimeters." + }, + "length": { + "type": "string", + "description": "Package length in centimeters." + }, + "width": { + "type": "string", + "description": "Package width in centimeters." + } + }, + "example": { + "height": "5", + "length": "11", + "width": "7" + } + }, + "Item": { + "title": "Item", + "required": [ + "id", + "name", + "ean", + "quantity", + "price", + "refId", + "image", + "type", + "weight" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Product ID." + }, + "name": { + "type": "string", + "description": "Product name." + }, + "ean": { + "type": "string", + "description": "Unique SKU identification code (barcode). Up to 13 numerical characters." + }, + "quantity": { + "type": "integer", + "format": "int32", + "description": "Quantity of units of the product." + }, + "price": { + "type": "integer", + "format": "int32", + "description": "Product price in cents." + }, + "refId": { + "type": "string", + "description": "Product reference ID." + }, + "image": { + "type": "string", + "description": "SKU image." + }, + "type": { + "type": "string", + "description": "Item type." + }, + "weight": { + "type": "string", + "description": "Product weight in grams." + } + }, + "example": { + "id": "184", + "name": "Chicken", + "ean": "EAN354", + "quantity": 8, + "price": 669, + "refId": "314", + "image": "https://picsum.photos/seed/YtoZ9/128/480", + "type": "other", + "weight": "6" + } + }, + "Timeline": { + "required": [ + "id", + "date", + "createdAt", + "updatedAt", + "type", + "description", + "author", + "metaData" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Timeline ID." + }, + "date": { + "type": "string", + "description": "Timeline actual date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + }, + "createdAt": { + "type": "string", + "description": "Order's creation date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + }, + "updatedAt": { + "type": "string", + "description": "Date of the order's last update in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + }, + "type": { + "type": "string", + "description": "Order status." + }, + "description": { + "type": "string", + "description": "Description of the status." + }, + "author": { + "type": "string", + "description": "Status author." + }, + "metaData": { + "$ref": "#/components/schemas/MetaData", + "description": "Metadata about the delivery information." + } + }, + "example": { + "id": "77263f59-0ac5-4b0c-bfe5-f17a1648474d", + "date": "2024-03-09T01:33:14.917Z", + "createdAt": "2024-03-09T01:33:14.917Z", + "updatedAt": "2024-03-09T01:33:14.917Z", + "type": "STATUS", + "description": "Service pending in DEV", + "author": "System", + "metaData": { + "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", + "metaData": null, + "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27", + "shippingPrice": 284.02, + "status": "PENDING", + "labels": [ + { + "name": "Shipping label", + "id": "78c83922-d658-48bf-89d5-0658a6a94e27", + "type": "PDF", + "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf" + } + ] + } + } + }, + "MetaData": { + "title": "MetaData", + "type": "object", + "properties": { + "0": { + "$ref": "#/components/schemas/generatedObject", + "description": "Item ID in the cart." + }, + "shippingEstimatedDate": { + "type": "string", + "nullable": true, + "description": "Order's Shipping estimated date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + }, + "metaData": { + "type": "string", + "nullable": true, + "description": "Metadata." + }, + "serviceId": { + "type": "string", + "description": "Service ID." + }, + "shippingPrice": { + "type": "number", + "description": "Order's shipping price in cents." + }, + "status": { + "type": "string", + "description": "Shipping status." + }, + "labels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Label" + }, + "description": "Shipping labels, there may be more than one per order due to breakage in packages." + }, + "trackingUrl": { + "type": "string", + "description": "Carrier's tracking URL of the order." + }, + "name": { + "type": "string", + "description": "Carrier name." + }, + "id": { + "type": "string", + "description": "Tracking ID." + }, + "type": { + "type": "string", + "description": "Type of transportation." + }, + "url": { + "type": "string", + "description": "Carrier URL." + } + }, + "example": { + "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", + "metaData": null, + "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27", + "shippingPrice": 284.02, + "status": "PENDING", + "labels": [ + { + "name": "Shipping label", + "id": "78c83922-d658-48bf-89d5-0658a6a94e27", + "type": "PDF", + "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf" + } + ] + } + }, + "generatedObject": { + "required": [ + "type", + "note", + "author" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of extra information about the item's shipping." + }, + "note": { + "type": "string", + "description": "Text with extra information about the item's shipping." + }, + "author": { + "type": "string", + "description": "Author." + } + }, + "example": { + "type": "COMMENT", + "note": "The package is delivered at the door", + "author": "afterShip" + } + }, + "Note": { + "required": [ + "type", + "date", + "content", + "author" + ], + "type": "object", + "description": "Notes with delivery information.", + "properties": { + "type": { + "type": "string", + "description": "Type of note." + }, + "date": { + "type": "string", + "description": "Date of creation of the note in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + }, + "content": { + "type": "string", + "description": "Content of the note." + }, + "author": { + "type": "string", + "description": "Author of the note." + } + }, + "example": { + "type": "COMMENT", + "date": "2024-03-09T01:43:16.280Z", + "content": "Tracking Number: 10001709948594168", + "author": "afterShip" + } + }, + "Timezone": { + "required": [ + "offset", + "value", + "label" + ], + "type": "object", + "description": "Time zone information.", + "properties": { + "offset": { + "type": "integer", + "format": "int32", + "description": "Time zone offset." + }, + "value": { + "type": "string", + "description": "Time zone." + }, + "label": { + "type": "string", + "nullable": true, + "description": "Label." + } + }, + "example": { + "offset": 300, + "value": "America/Bogota", + "label": null + } + }, + "Rate": { + "required": [ + "shippingPrice", + "insurancePrice" + ], + "type": "object", + "description": "Rate cost information.", + "properties": { + "shippingPrice": { + "$ref": "#/components/schemas/ShippingPrice" + }, + "insurancePrice": { + "$ref": "#/components/schemas/InsurancePrice" + } + }, + "example": { + "shippingPrice": { + "value": 0, + "currency": "USD" + }, + "insurancePrice": { + "value": 0, + "currency": "USD" + } + } + }, + "ShippingPrice": { + "required": [ + "value", + "currency" + ], + "type": "object", + "description": "Shipping cost information.", + "properties": { + "value": { + "type": "integer", + "format": "int32", + "description": "Shipping cost in cents." + }, + "currency": { + "type": "string", + "description": "Currency code in [ISO 4217](https://www.iban.com/currency-codes) format." + } + }, + "example": { + "value": 0, + "currency": "USD" + } + }, + "InsurancePrice": { + "required": [ + "value", + "currency" + ], + "type": "object", + "description": "Insurance cost information.", + "properties": { + "value": { + "type": "integer", + "format": "int32", + "description": "Insurance cost in cents." + }, + "currency": { + "type": "string", + "description": "Currency code in [ISO 4217](https://www.iban.com/currency-codes) format." + } + }, + "example": { + "value": 0, + "currency": "USD" + } + }, + "MetaData1": { + "required": [ + "integrationResponse", + "carrier" + ], + "type": "object", + "description": "Metadata about the Carrier.", + "properties": { + "integrationResponse": { + "type": "object", + "description": "Carrier integration information." + }, + "carrier": { + "$ref": "#/components/schemas/Carrier" + } + }, + "example": { + "integrationResponse": {}, + "carrier": { + "name": "[FedEx] Postmen Testing Account", + "image": null, + "metaData": {}, + "id": "fedex", + "type": { + "metaData": {}, + "terms": "", + "rate": { + "shippingPrice": { + "value": 284.02, + "currency": "USD" + }, + "insurancePrice": { + "value": 0, + "currency": "USD" + } + }, + "name": "FedEx First Overnight®", + "transitTime": 0, + "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", + "description": "FedEx", + "id": "fedex_first_overnight", + "international": false + } + } + } + }, + "Carrier": { + "required": [ + "name", + "image", + "metaData", + "id", + "type" + ], + "type": "object", + "description": "Object containing information about a carrier.", + "properties": { + "name": { + "type": "string", + "description": "Carrier name." + }, + "image": { + "type": "string", + "nullable": true, + "description": "Carrier logo." + }, + "metaData": { + "type": "object", + "description": "Carrier metadata." + }, + "id": { + "type": "string", + "description": "Carrier ID." + }, + "type": { + "$ref": "#/components/schemas/Type", + "description": "Carrier type." + } + }, + "example": { + "name": "[FedEx] Postmen Testing Account", + "image": null, + "metaData": {}, + "id": "fedex", + "type": { + "metaData": {}, + "terms": "", + "rate": { + "shippingPrice": { + "value": 284.02, + "currency": "USD" + }, + "insurancePrice": { + "value": 0, + "currency": "USD" + } + }, + "name": "FedEx First Overnight®", + "transitTime": 0, + "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", + "description": "FedEx", + "id": "fedex_first_overnight", + "international": false + } + } + }, + "Type": { + "title": "Type", + "required": [ + "metaData", + "terms", + "rate", + "name", + "transitTime", + "shippingEstimatedDate", + "description", + "id", + "international" + ], + "type": "object", + "properties": { + "metaData": { + "type": "object", + "description": "Carrier metadata." + }, + "terms": { + "type": "string", + "description": "Carrier terms." + }, + "rate": { + "$ref": "#/components/schemas/Rate1", + "description": "Carrier rate." + }, + "name": { + "type": "string", + "description": "Carrier name." + }, + "transitTime": { + "type": "integer", + "format": "int32", + "description": "Carrier transit time." + }, + "shippingEstimatedDate": { + "type": "string", + "nullable": true, + "description": "Carrier Shipping estimated date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + }, + "description": { + "type": "string", + "description": "Carrier description." + }, + "id": { + "type": "string", + "description": "Carrier ID." + }, + "international": { + "type": "boolean", + "description": "Defines if the carrier is international (`true`) or not (`false`)." + } + }, + "example": { + "metaData": {}, + "terms": "", + "rate": { + "shippingPrice": { + "value": 284.02, + "currency": "USD" + }, + "insurancePrice": { + "value": 0, + "currency": "USD" + } + }, + "name": "FedEx First Overnight®", + "transitTime": 0, + "shippingEstimatedDate": "2024-01-05T11:11:11.000Z", + "description": "", + "id": "fedex_first_overnight", + "international": false + } + }, + "Rate1": { + "required": [ + "shippingPrice", + "insurancePrice" + ], + "type": "object", + "description": "Rate cost information.", + "properties": { + "shippingPrice": { + "$ref": "#/components/schemas/ShippingPrice1" + }, + "insurancePrice": { + "$ref": "#/components/schemas/InsurancePrice" + } + }, + "example": { + "shippingPrice": { + "value": 284.02, + "currency": "USD" + }, + "insurancePrice": { + "value": 0, + "currency": "USD" + } + } + }, + "ShippingPrice1": { + "required": [ + "value", + "currency" + ], + "type": "object", + "description": "Shipping cost information.", + "properties": { + "value": { + "type": "integer", + "format": "int32", + "description": "Shipping cost in cents." + }, + "currency": { + "type": "string", + "description": "Cost currency code in [ISO 4217](https://www.iban.com/currency-codes) format.." + } + }, + "example": { + "value": 284.02, + "currency": "USD" + } + }, + "m4031": { + "required": [ + "message", + "requestId" + ], + "type": "object", + "description": "Request information.", + "properties": { + "message": { + "type": "string", + "description": "Request message." + }, + "requestId": { + "type": "string", + "description": "Request ID." + } + }, + "example": { + "message": "Invalid token", + "requestId": "09563f82-fe06-4004-b623-85e3aa4c92c9" + } + }, + "Data1": { + "required": [ + "0", + "carrierId", + "serviceId" + ], + "type": "object", + "description": "Request data.", + "properties": { + "0": { + "type": "string", + "description": "Request item." + }, + "carrierId": { + "type": "string", + "description": "Carrier ID." + }, + "serviceId": { + "type": "string", + "description": "Service ID." + } + }, + "example": { + "0": "1", + "carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50", + "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27" + } + }, + "m4041": { + "required": [ + "type", + "code", + "data", + "requestId", + "date", + "message" + ], + "type": "object", + "description": "Request information.", + "properties": { + "type": { + "type": "string", + "description": "Type of request." + }, + "code": { + "type": "string", + "description": "Request code." + }, + "data": { + "$ref": "#/components/schemas/Data1" + }, + "requestId": { + "type": "string", + "description": "Request ID." + }, + "date": { + "type": "string", + "description": "Request date." + }, + "message": { + "type": "string", + "description": "Request message." + } + }, + "example": { + "type": "exception", + "code": "TRP0005E", + "data": { + "0": "1", + "carrierId": "MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50", + "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27" + }, + "requestId": "9e3ce442-458c-4861-99aa-23b2cd2da9cf", + "date": "2024-03-15T06:00:21.009Z", + "message": "Service not found: 'MTEyMjMtQWZ0ZXJTaGlwLWRldmVsb3BtZW50&78c83922-d658-48bf-89d5-0658a6a94e27'" + } + }, + "UpdateserviceRequest": { + "required": [ + "status", + "agent", + "trackingUrl", + "totalDistanceTraveled", + "rating", + "shippingPrice", + "shippingEstimatedDate" + ], + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Delivery status." + }, + "agent": { + "type": "string", + "nullable": true, + "description": "Delivery agent." + }, + "trackingUrl": { + "type": "string", + "description": "Delivery tracking URL." + }, + "totalDistanceTraveled": { + "type": "string", + "nullable": true, + "description": "Delivery total distance traveled in kilometers." + }, + "rating": { + "type": "string", + "nullable": true, + "description": "Rating." + }, + "shippingPrice": { + "type": "string", + "nullable": true, + "description": "Delivery shipping price in cents." + }, + "shippingEstimatedDate": { + "type": "string", + "nullable": true, + "description": "Shipping estimated date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + } + }, + "example": { + "status": "DELIVERED", + "agent": null, + "trackingUrl": "https://localhost.com", + "totalDistanceTraveled": null, + "rating": null, + "shippingPrice": null, + "shippingEstimatedDate": "2024-01-05T11:11:11.000Z" + } + }, + "ServiceBody1": { + "required": [ + "message", + "data" + ], + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "Service message." + }, + "data": { + "$ref": "#/components/schemas/Data3", + "description": "Service data." + } + }, + "example": { + "message": "Service updated successfully", + "data": { + "status": "PENDING", + "agent": { + "id": "27327489234", + "name": "Pedro", + "identification": "020323809", + "phone": "+57314855674", + "email": "pedro434234@gmailc.om", + "vehicle": "SCOOTER" + }, + "trackingUrl": "https://localhost.com", + "totalDistanceTraveled": 2, + "rating": 5, + "shippingPrice": 150000, + "shippingEstimatedDate": "2024-04-27T20:25:45.067Z" + } + } + }, + "Data3": { + "required": [ + "status", + "agent", + "trackingUrl", + "totalDistanceTraveled", + "rating", + "shippingPrice", + "shippingEstimatedDate" + ], + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Service status." + }, + "agent": { + "$ref": "#/components/schemas/Agent", + "description": "Service agent." + }, + "trackingUrl": { + "type": "string", + "description": "Service tracking URL." + }, + "totalDistanceTraveled": { + "type": "integer", + "format": "int32", + "description": "Delivery total distance traveled in kilometers." + }, + "rating": { + "type": "integer", + "format": "int32", + "description": "Rating." + }, + "shippingPrice": { + "type": "integer", + "format": "int32", + "description": "Shipping price." + }, + "shippingEstimatedDate": { + "type": "string", + "description": "Shipping estimated date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + } + }, + "example": { + "status": "PENDING", + "agent": { + "id": "27327489234", + "name": "Pedro", + "identification": "020323809", + "phone": "+57314855674", + "email": "pedro434234@gmailc.om", + "vehicle": "SCOOTER" + }, + "trackingUrl": "https://localhost.com", + "totalDistanceTraveled": 2, + "rating": 5, + "shippingPrice": 150000, + "shippingEstimatedDate": "2024-04-27T20:25:45.067Z" + } + }, + "Agent": { + "required": [ + "id", + "name", + "identification", + "phone", + "email", + "vehicle" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Agent ID." + }, + "name": { + "type": "string", + "description": "Agent name." + }, + "identification": { + "type": "string", + "description": "Agent identification." + }, + "phone": { + "type": "string", + "description": "Agent phone number." + }, + "email": { + "type": "string", + "description": "Agent email." + }, + "vehicle": { + "type": "string", + "description": "Agent vehicle." + } + }, + "example": { + "id": "27327489234", + "name": "Pedro", + "identification": "020323809", + "phone": "+57314855674", + "email": "pedro434234@gmailc.om", + "vehicle": "SCOOTER" + } + }, + "CreatenotesRequest": { + "required": [ + "type", + "note", + "author" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Note's type." + }, + "note": { + "type": "string", + "description": "Note's text." + }, + "author": { + "type": "string", + "description": "Note's author." + } + }, + "example": { + "type": "ERROR", + "note": "The package takes time to be shipped", + "author": "Oscar Rojas" + } + }, + "ServiceBody3": { + "required": [ + "message", + "data" + ], + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "Service message." + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Data9" + }, + "description": "Service data." + } + }, + "example": { + "message": "Notes saved successfully", + "data": [ + { + "type": "ERROR", + "note": "The package takes time to be shipped", + "author": "Oscar Rojas" + }, + { + "type": "COMMENT", + "note": "The package was picked up", + "author": "Oscar Rojas" + } + ] + } + }, + "Data9": { + "required": [ + "type", + "note", + "author" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Note's type." + }, + "note": { + "type": "string", + "description": "Note's text." + }, + "author": { + "type": "string", + "description": "Note's author." + } + }, + "example": { + "type": "ERROR", + "note": "The package takes time to be shipped", + "author": "Oscar Rojas" + } + }, + "CreateevidenceRequest": { + "required": [ + "type", + "content", + "author" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Note's type." + }, + "note": { + "type": "string", + "description": "Note's text." + }, + "author": { + "type": "string", + "description": "Note's author." + } + }, + "example": { + "type": "IMAGE", + "content": "https://parkers-images.bauersecure.com/wp-images/18727/courier-van-insurance-01.jpg", + "author": "Felipe Cardenas" + } + }, + "ServiceBody4": { + "required": [ + "message", + "data" + ], + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "Service message." + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Data12" + }, + "description": "Service data." + } + }, + "example": { + "message": "Evidences saved successfully", + "data": [ + { + "type": "IMAGE", + "content": "https://parkers-images.bauersecure.com/wp-images/18727/courier-van-insurance-01.jpg", + "author": "Felipe Cardenas" + }, + { + "type": "TEXT", + "content": "The package was delivered", + "author": "Felipe Cardenas" + } + ] + } + }, + "Data12": { + "required": [ + "type", + "content", + "author" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Note's type." + }, + "note": { + "type": "string", + "description": "Note's text." + }, + "author": { + "type": "string", + "description": "Note's author." + } + }, + "example": { + "type": "IMAGE", + "content": "https://parkers-images.bauersecure.com/wp-images/18727/courier-van-insurance-01.jpg", + "author": "Felipe Cardenas" + } + }, + "CreatelabelsRequest": { + "required": [ + "id", + "url", + "name", + "type" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Label ID." + }, + "url": { + "type": "string", + "description": "Label URL." + }, + "name": { + "type": "string", + "description": "Label name." + }, + "type": { + "type": "string", + "description": "Label type." + } + }, + "example": { + "id": "JADF8ADF89-7AD7AF-78ADFASDF", + "url": "http://s3://mybucket-alpha/orc/2013-10-04-custdata/label-pickup.pdf", + "name": "Delivery label", + "type": "PDF" + } + }, + "ServiceBody5": { + "required": [ + "message", + "data" + ], + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "Service message." + }, + "data": { + "$ref": "#/components/schemas/Data15", + "description": "Service data." + } + }, + "example": { + "message": "Label saved successfully", + "data": { + "id": "JADF8ADF89-7AD7AF-78ADFASDF", + "url": "http://s3://mybucket-alpha/orc/2013-10-04-custdata/label-pickup.pdf", + "name": "Delivery label", + "type": "PDF" + } + } + }, + "Data15": { + "required": [ + "id", + "url", + "name", + "type" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Label ID." + }, + "url": { + "type": "string", + "description": "Label URL." + }, + "name": { + "type": "string", + "description": "Label name." + }, + "type": { + "type": "string", + "description": "Label type." + } + }, + "example": { + "id": "JADF8ADF89-7AD7AF-78ADFASDF", + "url": "http://s3://mybucket-alpha/orc/2013-10-04-custdata/label-pickup.pdf", + "name": "Delivery label", + "type": "PDF" + } + }, + "CancelOngoingServiceRequest": { + "required": [ + "comment", + "type" + ], + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "Service comment." + }, + "type": { + "type": "string", + "description": "Service type." + } + }, + "example": { + "comment": "The delivery address was changed", + "type": "END_CLIENT_CANCELED" + } + }, + "ServiceBody6": { + "required": [ + "message", + "data" + ], + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "Service message." + }, + "data": { + "$ref": "#/components/schemas/Data18", + "description": "Service data." + } + }, + "example": { + "message": "Service canceled successfully", + "data": { + "comment": "The delivery address was changed", + "type": "END_CLIENT_CANCELED" + } + } + }, + "Data18": { + "required": [ + "comment", + "type" + ], + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "Service comment." + }, + "type": { + "type": "string", + "description": "Service type." + } + }, + "example": { + "comment": "The delivery address was changed", + "type": "END_CLIENT_CANCELED" + } + }, + "OnholdserviceRequest": { + "required": [ + "comment", + "type" + ], + "type": "object", + "properties": { + "comment": { + "type": "string", + "description": "Service comment." + }, + "type": { + "type": "string", + "description": "Service type." + } + }, + "example": { + "comment": "The delivery address was changed", + "type": "END_CLIENT_PAUSE" + } + }, + "ResponseService": { + "type": "object", + "required": [ + "status", + "serviceId", + "shippingPrice", + "metaData", + "shippingEstimatedDate", + "labels" + ], + "properties": { + "status": { + "type": "string", + "example": "PENDING", + "description": "Status of the service.", + "enum": [ + "PENDING", + "ASSIGNED", + "PICKED", + "ON_ROUTE", + "INCIDENT", + "RETURNED", + "DELIVERED", + "CANCELED", + "ON_HOLD" + ] + }, + "serviceId": { + "type": "string", + "example": "ASDF23324KDSF2", + "description": "Service ID." + }, + "shippingPrice": { + "type": "number", + "example": 20000.09, + "description": "Service shipping price." + }, + "metaData": { + "type": "object", + "properties": { + "{keyValue}": { + "description": "Carrier additional information.", + "type": "string" + } + }, + "example": { + "anyKey": "anyValue" + } + }, + "shippingEstimatedDate": { + "type": "string", + "example": "2024-05-29T22:36:37.589Z", + "description": "Shipping estimated date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`." + }, + "labels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Label" + }, + "description": "Shipping labels, there may be more than one per order due to breakage in packages." + } + } + }, + "ListRequest": { + "type": "object", + "required": [ + "settings" + ], + "properties": { + "settings": { + "type": "array", + "items": { + "type": "object", + "properties": { + "label": { + "type": "string", + "example": "Api key", + "description": "Custom label." + }, + "key": { + "type": "string", + "example": "aftership-api-key", + "description": "Custom key." + }, + "value": { + "type": "string", + "example": "8f_XXXXXXXXX_db79", + "description": "Custom value." + } + } + } + } + } + }, + "CancelServiceRequest": { + "type": "object", + "required": [ + "serviceId", + "carrierId", + "settings", + "reason", + "metaData" + ], + "properties": { + "serviceId": { + "type": "string", + "example": "apknieot924892jaf-1231", + "description": "Service ID." + }, + "carrierId": { + "type": "string", + "example": "servientrega9234jaf", + "description": "Carrier ID." + }, + "settings": { + "type": "array", + "description": "Array of custom fields.", + "items": { + "type": "object", + "required": [ + "label", + "key", + "value" + ], + "properties": { + "label": { + "type": "string", + "example": "Cliente ID", + "description": "Custom label." + }, + "key": { + "type": "string", + "example": "clientId", + "description": "Custom key." + }, + "value": { + "type": "string", + "example": "HUR123", + "description": "Custom value." + } + } + } + }, + "reason": { + "type": "string", + "example": "La dirección de entrega esta mal registrada", + "description": "Reason for the cancelation." + }, + "metaData": { + "type": "object", + "description": "Object containing service metadata.", + "properties": { + "myFieldCustom": { + "type": "string", + "example": "custom value", + "description": "Custom value." + } + } + } + } + }, + "CancelServiceResponse": { + "type": "object", + "required": [ + "message", + "data" + ], + "properties": { + "message": { + "type": "string", + "example": "Service executed successfully", + "description": "Message of successful cancelation." + }, + "data": { + "type": "object", + "description": "Object containing service information.", + "required": [ + "serviceId", + "carrierId", + "reason" + ], + "properties": { + "serviceId": { + "type": "string", + "description": "Service ID.", + "example": "apknieot924892jaf-1231" + }, + "carrierId": { + "type": "string", + "description": "Carrier ID.", + "example": "servientrega9234jaf" + }, + "reason": { + "type": "string", + "example": "En el lugar de residencia no hay quien reciba el paquete", + "description": "Reason for the cancelation." + } + } + } + } + }, + "PauseResumeServiceRequest": { + "type": "object", + "required": [ + "serviceId", + "carrierId", + "settings", + "reason", + "metaData" + ], + "properties": { + "serviceId": { + "type": "string", + "example": "apknieot924892jaf-1231", + "description": "Service ID." + }, + "carrierId": { + "type": "string", + "example": "servientrega9234jaf", + "description": "Carrier ID." + }, + "pause": { + "type": "boolean", + "description": "Condition that the service is paused (`false`) or not (`true`).", + "example": false + }, + "settings": { + "type": "array", + "description": "Array of custom fields.", + "items": { + "type": "object", + "required": [ + "label", + "key", + "value" + ], + "properties": { + "label": { + "type": "string", + "example": "Cliente ID", + "description": "Custom label." + }, + "key": { + "type": "string", + "example": "clientId", + "description": "Custom key." + }, + "value": { + "type": "string", + "example": "HUR123", + "description": "Custom value." + } + } + } + }, + "reason": { + "type": "string", + "example": "La dirección de entrega esta mal registrada", + "description": "Reason for the pause or resume." + }, + "metaData": { + "type": "object", + "description": "Object containing service metadata.", + "properties": { + "myFieldCustom": { + "type": "string", + "example": "custom value", + "description": "Custom value." + } + } + } + } + }, + "PauseResumeServiceResponse": { + "type": "object", + "required": [ + "message", + "data" + ], + "properties": { + "message": { + "type": "string", + "example": "Service executed successfully", + "description": "Message of successful cancelation." + }, + "data": { + "type": "object", + "description": "Object containing service information.", + "required": [ + "serviceId", + "carrierId", + "reason" + ], + "properties": { + "serviceId": { + "type": "string", + "description": "Service ID.", + "example": "apknieot924892jaf-1231" + }, + "carrierId": { + "type": "string", + "description": "Carrier ID.", + "example": "servientrega9234jaf" + }, + "cancel": { + "type": "boolean", + "description": "Condition that the service is paused (`false`) or not (`true`).", + "example": false + }, + "reason": { + "type": "string", + "example": "En el lugar de residencia no hay quien reciba el paquete", + "description": "Reason for the cancelation." + } + } + } + } + } + } + }, + "tags": [ + { + "name": "Authentication" + }, + { + "name": "Service integration", + "description": "These endpoints must be developed to integrate with the Lastmile Pick and Pack Last Mile Protocol API." + }, + { + "name": "Shipping updates", + "description": "This endpoint will allow the carriers to update an ongoing shipping service." + }, + { + "name": "Carriers" + } + ] +} diff --git a/clients/manitou/output/pick-and-pack-order-changes.json b/clients/manitou/output/pick-and-pack-order-changes.json new file mode 100644 index 0000000000..b6f2a27ebc --- /dev/null +++ b/clients/manitou/output/pick-and-pack-order-changes.json @@ -0,0 +1,1260 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "Pick and Pack Order changes API", + "description": "The Pick and Pack Order changes API manages order modifications in a Pick and Pack order. This API supports actions like updating deadlines, adding items, modifying quantities, rejecting or replacing items, and updating item details.\r\n\r\n>ℹ️ This API is currently in beta and subject to changes. Use it with caution in production environments.\r\n\r\n## Order changes\r\n\r\n- `PUT` [Update order deadline](https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api#put-/orders/-orderId-/deadline)\r\n- `POST` [Update items of the order](https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api#post-/order/changes)\r\n\r\n## BIN locations\r\n\r\n- [`GET` Get BIN location](https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api#get-/-skuId-/warehouses/-warehouseId-)\r\n- [`POST` Create BIN location](https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api#post-/-skuId-/warehouses/-warehouseId-)\r\n- [`PUT` Update BIN location](https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api#put-/-skuId-/warehouses/-warehouseId-)\r\n- [`DELETE` Delete BIN location](https://developers.vtex.com/docs/api-reference/pick-and-pack-order-changes-api#delete-/-skuId-/warehouses/-warehouseId-)", + "contact": {}, + "version": "1.0" + }, + "servers": [ + { + "url": "https://{accountName}.{environment}.com.br/vtex_pickandpack", + "description": "VTEX server URL.", + "variables": { + "accountName": { + "description": "Name of the VTEX account. Used as part of the URL.", + "default": "apiexamples" + }, + "environment": { + "description": "Environment to use. Used as part of the URL.", + "enum": [ + "vtexcommercestable" + ], + "default": "vtexcommercestable" + } + } + }, + { + "url": "https://{accountName}.myvtex.com/pickpack/bin-location", + "description": "VTEX server URL.", + "variables": { + "accountName": { + "description": "Name of the VTEX account. Used as part of the URL.", + "default": "apiexamples" + } + } + } + ], + "paths": { + "/orders/{orderId}/deadline": { + "put": { + "summary": "Update order deadline", + "description": "Updates the deadline for an order. The `min` and `max` fields specify the deadline window, while the description provides additional information.\r\n\r\n>ℹ️ This endpoint is currently in beta and subject to changes. Use with caution in production environments.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **View order** |\r\n| OMS | OMS access | **Only show orders created by the user (via call center)** |\r\n| Catalog | Telesales | **Assisted Sales** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "parameters": [ + { + "$ref": "#/components/parameters/orderId" + } + ], + "tags": [ + "Order changes" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateDeadlineRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateDeadlineResponse" + }, + "example": { + "order": { + "currentDeadline": { + "max": "2024-12-24T23:03:02Z", + "min": "2024-12-23T23:03:02Z" + }, + "deadlineChanges": [ + { + "current": true, + "description": "Extend deadline due to delayed shipment", + "handled": true, + "max": "2024-12-24T23:03:02.000Z", + "min": "2024-12-23T23:03:02.000Z", + "oldDates": { + "max": "2024-12-04T17:20:48.088Z", + "min": "2024-12-04T17:20:48.088Z" + }, + "updatedAt": "2024-12-03T17:35:59.786Z" + } + ], + "orderId": "1481050515517-01" + }, + "success": true + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "description": "Request error object with error information.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message.", + "type": "string" + } + } + }, + "success": { + "description": "Condition if the request was successful.", + "type": "boolean" + } + } + }, + "example": { + "error": { + "code": "400", + "message": "New dates must be greater than the current dates" + }, + "success": false + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "description": "Authentication failed due to missing, invalid, or expired credentials. Ensure the `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken` headers include valid values.", + "type": "string" + } + } + }, + "example": { + "message": "Unauthorized" + } + } + } + } + }, + "deprecated": false, + "operationId": "put_orders_ByOrderId_deadline" + } + }, + "/order/changes": { + "post": { + "summary": "Update items of the order", + "description": "The endpoint supports actions like adding items, modifying quantities, rejecting or replacing items, and updating item details, adding notes and suggest product replacements.\r\n\r\n>ℹ️ This endpoint is currently in beta and subject to changes. Use with caution in production environments.\r\n\r\n>⚠️ Before using this endpoint, you must make a request with the [Cart simulation](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForms/simulation) endpoint to check inventory availability. For more information of how to simulate a cart, check the [Simulate a shopping cart](https://developers.vtex.com/docs/guides/simulate-a-shopping-cart) guide.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **View order** |\r\n| OMS | OMS access | **Only show orders created by the user (via call center)** |\r\n| Catalog | Telesales | **Assisted Sales** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "tags": [ + "Order changes" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/AddItemRequest" + }, + { + "$ref": "#/components/schemas/AddQuantityRequest" + }, + { + "$ref": "#/components/schemas/ItemToAddRequest" + }, + { + "$ref": "#/components/schemas/RejectItemRequest" + }, + { + "$ref": "#/components/schemas/ReplaceItemRequest" + }, + { + "$ref": "#/components/schemas/ItemToReplace" + }, + { + "$ref": "#/components/schemas/UpdateItemRequest" + } + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddItemRequest" + }, + "example": { + "message": "Error requesting picking action" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "description": "Error message.", + "type": "string" + } + } + }, + "example": { + "message": "Error requesting picking action" + } + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "description": "Authentication failed due to missing, invalid, or expired credentials. Ensure the `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken` headers include valid values.", + "type": "string" + } + } + }, + "example": { + "message": "Unauthorized" + } + } + } + } + }, + "deprecated": false, + "operationId": "post_order_changes" + } + }, + "/{skuId}/warehouses/{warehouseId}": { + "get": { + "summary": "Get BIN location", + "description": "Retrieves the BIN location for a specific SKU in a warehouse. The BIN location is a specific, designated storage location within a warehouse. This location isn't necessarily a physical container. Each BIN is typically assigned a unique identifier or code, facilitating precise tracking and retrieval of items within the warehouse.\r\n\r\n>ℹ️ This endpoint is currently in beta and subject to changes. Use with caution in production environments.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **View order** |\r\n| OMS | OMS access | **Only show orders created by the user (via call center)** |\r\n| Catalog | Telesales | **Assisted Sales** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "parameters": [ + { + "name": "skuId", + "in": "path", + "description": "Unique identifier of the SKU.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "1" + } + }, + { + "name": "warehouseId", + "in": "path", + "description": "Unique identifier of the warehouse.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "10" + } + } + ], + "tags": [ + "BIN locations" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The BIN location within the warehouse." + }, + "hostname": { + "type": "string", + "description": "The account name managing the BIN location." + }, + "warehouseId": { + "type": "string", + "description": "The identifier of the warehouse." + }, + "skuId": { + "type": "string", + "description": "The identifier of the SKU." + } + } + }, + "example": { + "location": "My location 14", + "hostname": "lastmile", + "warehouseId": "10", + "skuId": "1" + } + } + } + } + }, + "servers": [ + { + "url": "https://{accountName}.myvtex.com/pickpack/bin-location", + "description": "VTEX server URL.", + "variables": { + "accountName": { + "description": "Name of the VTEX account. Used as part of the URL.", + "default": "apiexamples" + } + } + } + ], + "operationId": "get_BySkuId_warehouses_ByWarehouseId" + }, + "post": { + "summary": "Create BIN location", + "description": "Creates a new BIN location by warehouse ID and SKU ID. The BIN location is a specific, designated storage location within a warehouse. This location isn't necessarily a physical container. Each BIN is typically assigned a unique identifier or code, facilitating precise tracking and retrieval of items within the warehouse.\r\n\r\n>ℹ️ This endpoint is currently in beta and subject to changes. Use with caution in production environments.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **View order** |\r\n| OMS | OMS access | **Only show orders created by the user (via call center)** |\r\n| Catalog | Telesales | **Assisted Sales** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "tags": [ + "BIN locations" + ], + "parameters": [ + { + "name": "skuId", + "in": "path", + "description": "Unique identifier of the SKU.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "1" + } + }, + { + "name": "warehouseId", + "in": "path", + "description": "Unique identifier of the warehouse.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "10" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The BIN location within the warehouse." + } + }, + "required": [ + "location" + ] + }, + "example": { + "location": "My location 14" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The BIN location within the warehouse." + }, + "hostname": { + "type": "string", + "description": "The account name managing the BIN location." + }, + "warehouseId": { + "type": "string", + "description": "The identifier of the warehouse." + }, + "skuId": { + "type": "string", + "description": "The identifier of the SKU." + } + } + }, + "example": { + "location": "My location 14", + "hostname": "lastmile", + "warehouseId": "10", + "skuId": "1" + } + } + } + } + }, + "servers": [ + { + "url": "https://{accountName}.myvtex.com/pickpack/bin-location", + "description": "VTEX server URL.", + "variables": { + "accountName": { + "description": "Name of the VTEX account. Used as part of the URL.", + "default": "apiexamples" + } + } + } + ], + "operationId": "post_BySkuId_warehouses_ByWarehouseId" + }, + "put": { + "summary": "Update BIN location", + "description": "Updates the BIN location by warehouse ID and SKU ID. The BIN location is a specific, designated storage location within a warehouse. This location isn't necessarily a physical container. Each BIN is typically assigned a unique identifier or code, facilitating precise tracking and retrieval of items within the warehouse.\r\n\r\n>ℹ️ This endpoint is currently in beta and subject to changes. Use with caution in production environments.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **View order** |\r\n| OMS | OMS access | **Only show orders created by the user (via call center)** |\r\n| Catalog | Telesales | **Assisted Sales** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.\n\n> Requests with a body must be sent with `Content-Type: application/json`.", + "tags": [ + "BIN locations" + ], + "parameters": [ + { + "name": "skuId", + "in": "path", + "description": "Unique identifier of the SKU.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "1" + } + }, + { + "name": "warehouseId", + "in": "path", + "description": "Unique identifier of the warehouse.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "10" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The BIN location within the warehouse." + } + }, + "required": [ + "location" + ] + }, + "example": { + "location": "My location 14" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The BIN location within the warehouse." + }, + "hostname": { + "type": "string", + "description": "The account name managing the BIN location." + }, + "warehouseId": { + "type": "string", + "description": "The identifier of the warehouse." + }, + "skuId": { + "type": "string", + "description": "The identifier of the SKU." + } + } + }, + "example": { + "location": "My location 14", + "hostname": "lastmile", + "warehouseId": "10", + "skuId": "1" + } + } + } + } + }, + "servers": [ + { + "url": "https://{accountName}.myvtex.com/pickpack/bin-location", + "description": "VTEX server URL.", + "variables": { + "accountName": { + "description": "Name of the VTEX account. Used as part of the URL.", + "default": "apiexamples" + } + } + } + ], + "operationId": "put_BySkuId_warehouses_ByWarehouseId" + }, + "delete": { + "summary": "Delete BIN location", + "description": "Deletes a specific BIN location by warehouse ID and SKU ID. The BIN location is a specific, designated storage location within a warehouse. This location isn't necessarily a physical container. Each BIN is typically assigned a unique identifier or code, facilitating precise tracking and retrieval of items within the warehouse.\r\n\r\n>ℹ️ This endpoint is currently in beta and subject to changes. Use with caution in production environments.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **View order** |\r\n| OMS | OMS access | **Only show orders created by the user (via call center)** |\r\n| Catalog | Telesales | **Assisted Sales** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "tags": [ + "BIN locations" + ], + "parameters": [ + { + "name": "skuId", + "in": "path", + "description": "Unique identifier of the SKU.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "1" + } + }, + { + "name": "warehouseId", + "in": "path", + "description": "Unique identifier of the warehouse.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "10" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "Empty array." + }, + "example": [] + } + } + } + }, + "servers": [ + { + "url": "https://{accountName}.myvtex.com/pickpack/bin-location", + "description": "VTEX server URL.", + "variables": { + "accountName": { + "description": "Name of the VTEX account. Used as part of the URL.", + "default": "apiexamples" + } + } + } + ], + "operationId": "delete_BySkuId_warehouses_ByWarehouseId" + } + }, + "/{skuId}/warehouses": { + "get": { + "summary": "List BIN locations", + "description": "Retrieves a list of warehouses associated with a specific SKU ID. The BIN location is a specific, designated storage location within a warehouse. This location isn't necessarily a physical container. Each BIN is typically assigned a unique identifier or code, facilitating precise tracking and retrieval of items within the warehouse.\r\n\r\n>ℹ️ This endpoint is currently in beta and subject to changes. Use with caution in production environments.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **View order** |\r\n| OMS | OMS access | **Only show orders created by the user (via call center)** |\r\n| Catalog | Telesales | **Assisted Sales** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "tags": [ + "BIN locations" + ], + "parameters": [ + { + "name": "skuId", + "in": "path", + "description": "Unique identifier of the SKU.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "1" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "description": "BIN location", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The BIN location within the warehouse." + }, + "hostname": { + "type": "string", + "description": "The account name managing the BIN location." + }, + "warehouseId": { + "type": "string", + "description": "The identifier of the warehouse." + }, + "skuId": { + "type": "string", + "description": "The identifier of the SKU." + } + } + } + }, + "example": [ + { + "location": "My location 14 edited", + "hostname": "lastmile", + "warehouseId": "14", + "skuId": "2" + }, + { + "location": "My location 15 edited", + "hostname": "lastmile", + "warehouseId": "15", + "skuId": "1" + }, + { + "location": "My location 4 edited", + "hostname": "lastmile", + "warehouseId": "10", + "skuId": "7" + } + ] + } + } + } + }, + "servers": [ + { + "url": "https://{accountName}.myvtex.com/pickpack/warehouses", + "description": "VTEX server URL.", + "variables": { + "accountName": { + "description": "Name of the VTEX account. Used as part of the URL.", + "default": "apiexamples" + } + } + } + ], + "operationId": "get_BySkuId_warehouses" + }, + "delete": { + "summary": "Delete all BIN locations", + "description": "Deletes all BIN locations for a specific SKU ID. The BIN location is a specific, designated storage location within a warehouse. This location isn't necessarily a physical container. Each BIN is typically assigned a unique identifier or code, facilitating precise tracking and retrieval of items within the warehouse.\r\n\r\n>ℹ️ This endpoint is currently in beta and subject to changes. Use with caution in production environments.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **View order** |\r\n| OMS | OMS access | **Only show orders created by the user (via call center)** |\r\n| Catalog | Telesales | **Assisted Sales** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", + "parameters": [ + { + "name": "skuId", + "in": "path", + "description": "Unique identifier of the SKU.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "1" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "Empty array." + }, + "example": [] + } + } + } + }, + "operationId": "delete_BySkuId_warehouses" + } + } + }, + "security": [ + { + "appKey": [], + "appToken": [] + }, + { + "VtexIdclientAutCookie": [] + } + ], + "components": { + "schemas": { + "UpdateDeadlineRequest": { + "required": [ + "description", + "max", + "min" + ], + "type": "object", + "description": "Contains deadline information.", + "properties": { + "description": { + "type": "string", + "description": "Reason or purpose of the deadline change." + }, + "max": { + "type": "string", + "description": "Latest deadline date in ISO 8601 format." + }, + "min": { + "type": "string", + "description": "Earliest deadline date in ISO 8601 format." + } + }, + "example": { + "UpdateDeadline": { + "description": "Extend deadline due to delayed shipment", + "max": "2024-12-24T23:03:02Z", + "min": "2024-12-23T23:03:02Z" + } + } + }, + "UpdateDeadlineResponse": { + "type": "object", + "properties": { + "order": { + "description": "Object with current deadline information.", + "type": "object", + "properties": { + "currentDeadline": { + "description": "Current deadline information.", + "type": "object", + "properties": { + "max": { + "description": "Latest deadline date in ISO 8601 format.", + "type": "string" + }, + "min": { + "description": "Earliest deadline date in ISO 8601 format.", + "type": "string" + } + } + }, + "deadlineChanges": { + "description": "Object containg information of the deadline changes.", + "type": "array", + "items": { + "description": "Deadline change.", + "type": "object", + "properties": { + "current": { + "description": "If the deadline changes were update.", + "type": "boolean" + }, + "description": { + "description": "Reason or purpose for the update.", + "type": "string" + }, + "handled": { + "description": "If the deadline changes were handled by the picker.", + "type": "boolean" + }, + "max": { + "description": "Latest deadline date in ISO 8601 format.", + "type": "string" + }, + "min": { + "description": "Earliest deadline date in ISO 8601 format.", + "type": "string" + }, + "oldDates": { + "description": "Object containg previous deadline information.", + "type": "object", + "properties": { + "max": { + "description": "Latest deadline date in ISO 8601 format.", + "type": "string" + }, + "min": { + "description": "Earliest deadline date in ISO 8601 format.", + "type": "string" + } + } + }, + "updatedAt": { + "description": "An explanation about the purpose of this instance.", + "type": "string" + } + } + } + }, + "orderId": { + "description": "Unique identifier of the order.", + "type": "string" + } + } + }, + "success": { + "description": "Condition if the request was successful.", + "type": "boolean" + } + } + }, + "AddItemRequest": { + "required": [ + "type", + "orderId", + "itemId", + "quantity", + "warehouseId", + "price", + "sellingPrice", + "note", + "pickingOptions" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Action type (`ADD_ITEM`)." + }, + "orderId": { + "type": "string", + "description": "Unique identifier of the order." + }, + "itemId": { + "type": "string", + "description": "Unique identifier of the item." + }, + "quantity": { + "type": "integer", + "description": "Quantity of items to add." + }, + "warehouseId": { + "type": "string", + "description": "Unique identifier of the warehouse." + }, + "price": { + "type": "integer", + "description": "Price of the item." + }, + "sellingPrice": { + "type": "integer", + "description": "Selling price of the item." + }, + "note": { + "type": "string", + "description": "Note to add to the item." + }, + "pickingOptions": { + "required": [ + "onNotFound", + "alternateOptions" + ], + "type": "object", + "description": "Items picking options.", + "properties": { + "onNotFound": { + "type": "string", + "description": "List of alternate options." + }, + "alternateOptions": { + "type": "array", + "items": { + "type": "string", + "description": "ID of alternative items." + }, + "description": "List of IDs of alternative items." + } + } + } + }, + "example": { + "type": "ADD_ITEM", + "orderId": "1481110515526-01", + "itemId": "49", + "quantity": 2, + "warehouseId": "9029", + "price": 500000, + "sellingPrice": 200000, + "note": "TEST from VTEX PROXY 3", + "pickingOptions": { + "onNotFound": "REPLACE", + "alternateOptions": [ + "74" + ] + } + } + }, + "AddQuantityRequest": { + "required": [ + "type", + "orderId", + "itemId", + "newQuantity", + "unitMultiplier", + "reasonType", + "reasonDetail" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Action type (`ADD_QUANTITY`)." + }, + "orderId": { + "type": "string", + "description": "Unique identifier of the order." + }, + "itemId": { + "type": "string", + "description": "Unique identifier for the item." + }, + "newQuantity": { + "type": "integer", + "description": "New quantity of items." + }, + "unitMultiplier": { + "type": "integer", + "description": "Unit multiplier." + }, + "reasonType": { + "type": "string", + "description": "Reason type." + }, + "reasonDetail": { + "type": "string", + "description": "Reason detail." + } + }, + "example": { + "type": "ADD_QUANTITY", + "orderId": "1481110515526-01", + "itemId": "3", + "newQuantity": 4, + "unitMultiplier": 1, + "reasonType": "TEST", + "reasonDetail": "test reason detail" + } + }, + "RejectItemRequest": { + "required": [ + "type", + "orderId", + "itemId", + "quantity", + "reasonType", + "reasonDetail" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Action type (`REJECT`)." + }, + "orderId": { + "type": "string", + "description": "Unique identifier of the order." + }, + "itemId": { + "type": "string", + "description": "Unique identifier for the item." + }, + "quantity": { + "type": "integer", + "description": "Quantity of items to reject." + }, + "reasonType": { + "type": "string", + "description": "Reason type." + }, + "reasonDetail": { + "type": "string", + "description": "Reason detail." + } + }, + "example": { + "type": "REJECT", + "orderId": "1481110515526-01", + "itemId": "1364", + "quantity": 1, + "reasonType": "INVENTORY", + "reasonDetail": "inventory unavailable" + } + }, + "ReplaceItemRequest": { + "required": [ + "type", + "orderId", + "itemToReplace", + "ItemToAddRequest", + "reasonType", + "reasonDetail" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Action type (`REPLACE`)." + }, + "orderId": { + "type": "string", + "description": "Unique identifier of the order." + }, + "itemToReplace": { + "$ref": "#/components/schemas/ItemToReplace" + }, + "ItemToAddRequest": { + "$ref": "#/components/schemas/ItemToAddRequest" + }, + "reasonType": { + "type": "string", + "description": "Reason type." + }, + "reasonDetail": { + "type": "string", + "description": "Reason detail." + } + }, + "example": { + "type": "REPLACE", + "orderId": "1481110515526-01", + "itemToReplace": { + "id": "49", + "quantity": 1 + }, + "ItemToAddRequest": { + "id": "17", + "quantity": 2, + "price": 20000, + "sellingPrice": 10000, + "warehouseId": "9029", + "note": "TEST from VTEX PROXY 1", + "pickingOptions": { + "onNotFound": "REPLACE", + "alternateOptions": [ + "74" + ] + } + }, + "reasonType": "TEST", + "reasonDetail": "test reason detail" + } + }, + "ItemToReplace": { + "required": [ + "id", + "quantity" + ], + "type": "object", + "description": "Items to be replaced in the order.", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the item." + }, + "quantity": { + "type": "integer", + "format": "int32", + "description": "Item quantity." + } + }, + "example": { + "id": "49", + "quantity": 1 + } + }, + "ItemToAddRequest": { + "type": "object", + "description": "Items to be added in the order.", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier of the item." + }, + "quantity": { + "type": "integer", + "format": "int32", + "description": "Item quantity." + }, + "price": { + "type": "integer", + "format": "int32", + "description": "Price of the item." + }, + "sellingPrice": { + "type": "integer", + "format": "int32", + "description": "Selling price of the item." + }, + "warehouseId": { + "type": "string", + "description": "Unique identifier of the warehouse." + }, + "note": { + "type": "string", + "description": "Note to add to the item." + }, + "pickingOptions": { + "required": [ + "onNotFound", + "alternateOptions" + ], + "type": "object", + "description": "Items picking options.", + "properties": { + "onNotFound": { + "type": "string", + "description": "List of alternate options." + }, + "alternateOptions": { + "type": "array", + "items": { + "type": "string", + "description": "ID of alternative items." + }, + "description": "List of IDs of alternative items." + } + } + } + }, + "example": { + "id": "17", + "quantity": 2, + "price": 20000, + "sellingPrice": 10000, + "warehouseId": "9029", + "note": "TEST from VTEX PROXY 1", + "pickingOptions": { + "onNotFound": "REPLACE", + "alternateOptions": [ + "74" + ] + } + } + }, + "UpdateItemRequest": { + "required": [ + "type", + "orderId", + "itemId", + "note", + "pickingOptions" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Action type (`UPDATE_ITEM`).", + "enum": [ + "UPDATE_ITEM" + ] + }, + "orderId": { + "type": "string", + "description": "Unique identifier of the order." + }, + "itemId": { + "type": "string", + "description": "Unique identifier of the item." + }, + "note": { + "type": "string", + "description": "Note to add to the item." + }, + "pickingOptions": { + "required": [ + "onNotFound", + "alternateOptions" + ], + "type": "object", + "description": "Items picking options.", + "properties": { + "onNotFound": { + "type": "string", + "description": "List of alternate options." + }, + "alternateOptions": { + "type": "array", + "items": { + "type": "string", + "description": "ID of alternative items." + }, + "description": "List of IDs of alternative items." + } + } + } + }, + "example": { + "type": "UPDATE_ITEM", + "orderId": "1479430515373-01", + "itemId": "1248", + "note": "TEST from VTEX PROXY 3", + "pickingOptions": { + "onNotFound": "REPLACE", + "alternateOptions": [ + "74" + ] + } + } + } + }, + "parameters": { + "orderId": { + "name": "orderId", + "in": "path", + "description": "Unique identifier of the order.", + "required": true, + "style": "simple", + "schema": { + "type": "string", + "example": "1481050515517-01" + } + } + } + }, + "tags": [ + { + "name": "Order changes" + }, + { + "name": "BIN locations" + } + ] +} diff --git a/clients/manitou/output/pricing.json b/clients/manitou/output/pricing.json new file mode 100644 index 0000000000..6c9d48e6fa --- /dev/null +++ b/clients/manitou/output/pricing.json @@ -0,0 +1,1925 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "Pricing API", + "description": "Check the new [Pricing onboarding guide](https://developers.vtex.com/docs/guides/pricing-overview). This guide improves the onboarding experience for developers at VTEX by assembling all Pricing documentation on our Developer Portal and organizing it around the developer journey.\r\n\r\nPricing is the VTEX module responsible for the SKU price list. It stores each SKU’s base price, optional fixed prices by trade policy, and rules that dynamically generate final prices according to the purchase context and trade policy.\r\n\r\nFor details on how to use this module and its business logic, see the [Pricing onboarding guide](https://developers.vtex.com/docs/guides/pricing-overview).\r\n\r\n## Rate limits per route\r\n\r\nThe following table summarizes the rate limits per HTTP method and the available burst credits for each route:\r\n\r\n| Operation | Rate | Burst credits |\r\n| - | - | - |\r\n| `GET` | Rate limit under review. Usage may be restricted in cases of excessive use. | Under review |\r\n| `POST` and `PUT` | 2000 per minute![\"hoegaarden-kit\"](\"~/arquivos/ids/155489-#width#-#height#/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000\")
",
+ "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000",
+ "imageText": "hoegaarden-kit",
+ "imageLastModified": "2020-10-07T12:49:27.5800000Z"
+ }
+ ],
+ "sellers": [
+ {
+ "sellerId": "1",
+ "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE",
+ "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1",
+ "sellerDefault": true,
+ "commertialOffer": {
+ "DeliverySlaSamplesPerRegion": {
+ "0": {
+ "DeliverySlaPerTypes": [],
+ "Region": null
+ }
+ },
+ "Installments": [
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa à vista"
+ },
+ {
+ "Value": 21,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 2,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 2 vezes sem juros"
+ },
+ {
+ "Value": 14,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 3,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 3 vezes sem juros"
+ },
+ {
+ "Value": 10.5,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 4,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 4 vezes sem juros"
+ },
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Promissory",
+ "PaymentSystemGroupName": "promissoryPaymentGroup",
+ "Name": "Promissory à vista"
+ }
+ ],
+ "DiscountHighLight": [],
+ "GiftSkuIds": [],
+ "Teasers": [
+ {
+ "",
+ "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000",
+ "imageText": "hoegaarden-kit",
+ "imageLastModified": "2025-03-07T12:49:27.5800000Z"
+ }
+ ],
+ "sellers": [
+ {
+ "sellerId": "1",
+ "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE",
+ "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1",
+ "sellerDefault": true,
+ "commertialOffer": {
+ "DeliverySlaSamplesPerRegion": {
+ "0": {
+ "DeliverySlaPerTypes": [],
+ "Region": null
+ }
+ },
+ "Installments": [
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa à vista"
+ },
+ {
+ "Value": 21,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 2,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 2 vezes sem juros"
+ },
+ {
+ "Value": 14,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 3,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 3 vezes sem juros"
+ },
+ {
+ "Value": 10.5,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 4,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 4 vezes sem juros"
+ },
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Promissory",
+ "PaymentSystemGroupName": "promissoryPaymentGroup",
+ "Name": "Promissory à vista"
+ }
+ ],
+ "DiscountHighLight": [],
+ "GiftSkuIds": [],
+ "Teasers": [
+ {
+ "",
+ "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000",
+ "imageText": "hoegaarden-kit",
+ "imageLastModified": "2020-10-07T12:49:27.5800000Z"
+ }
+ ],
+ "sellers": [
+ {
+ "sellerId": "1",
+ "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE",
+ "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1",
+ "sellerDefault": true,
+ "commertialOffer": {
+ "DeliverySlaSamplesPerRegion": {
+ "0": {
+ "DeliverySlaPerTypes": [],
+ "Region": null
+ }
+ },
+ "Installments": [
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa à vista"
+ },
+ {
+ "Value": 21,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 2,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 2 vezes sem juros"
+ },
+ {
+ "Value": 14,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 3,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 3 vezes sem juros"
+ },
+ {
+ "Value": 10.5,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 4,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 4 vezes sem juros"
+ },
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Promissory",
+ "PaymentSystemGroupName": "promissoryPaymentGroup",
+ "Name": "Promissory à vista"
+ }
+ ],
+ "DiscountHighLight": [],
+ "GiftSkuIds": [],
+ "Teasers": [
+ {
+ "",
+ "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000",
+ "imageText": "hoegaarden-kit",
+ "imageLastModified": "2020-10-07T12:49:27.5800000Z"
+ }
+ ],
+ "sellers": [
+ {
+ "sellerId": "1",
+ "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE",
+ "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1",
+ "sellerDefault": true,
+ "commertialOffer": {
+ "DeliverySlaSamplesPerRegion": {
+ "0": {
+ "DeliverySlaPerTypes": [],
+ "Region": null
+ }
+ },
+ "Installments": [
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa à vista"
+ },
+ {
+ "Value": 21,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 2,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 2 vezes sem juros"
+ },
+ {
+ "Value": 14,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 3,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 3 vezes sem juros"
+ },
+ {
+ "Value": 10.5,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 4,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 4 vezes sem juros"
+ },
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Promissory",
+ "PaymentSystemGroupName": "promissoryPaymentGroup",
+ "Name": "Promissory à vista"
+ }
+ ],
+ "DiscountHighLight": [],
+ "GiftSkuIds": [],
+ "Teasers": [
+ {
+ "",
+ "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000",
+ "imageText": "hoegaarden-kit",
+ "imageLastModified": "2020-10-07T12:49:27.5800000Z"
+ }
+ ],
+ "sellers": [
+ {
+ "sellerId": "1",
+ "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE",
+ "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1",
+ "sellerDefault": true,
+ "commertialOffer": {
+ "DeliverySlaSamplesPerRegion": {
+ "0": {
+ "DeliverySlaPerTypes": [],
+ "Region": null
+ }
+ },
+ "Installments": [
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa à vista"
+ },
+ {
+ "Value": 21,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 2,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 2 vezes sem juros"
+ },
+ {
+ "Value": 14,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 3,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 3 vezes sem juros"
+ },
+ {
+ "Value": 10.5,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 4,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 4 vezes sem juros"
+ },
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Promissory",
+ "PaymentSystemGroupName": "promissoryPaymentGroup",
+ "Name": "Promissory à vista"
+ }
+ ],
+ "DiscountHighLight": [],
+ "GiftSkuIds": [],
+ "Teasers": [
+ {
+ "",
+ "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000",
+ "imageText": "hoegaarden-kit",
+ "imageLastModified": "2020-10-07T12:49:27.5800000Z"
+ }
+ ],
+ "items": {
+ "type": "object",
+ "example": {
+ "imageId": "155489",
+ "imageLabel": "",
+ "imageTag": "",
+ "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000",
+ "imageText": "hoegaarden-kit",
+ "imageLastModified": "2020-10-07T12:49:27.5800000Z"
+ },
+ "required": [
+ "imageId",
+ "imageLabel",
+ "imageTag",
+ "imageUrl",
+ "imageText",
+ "imageLastModified"
+ ],
+ "properties": {
+ "imageId": {
+ "type": "string",
+ "description": "Image ID.",
+ "example": "155489"
+ },
+ "imageLabel": {
+ "type": "string",
+ "description": "Image label.",
+ "example": "Label test"
+ },
+ "imageTag": {
+ "type": "string",
+ "description": "Image tag.",
+ "example": ""
+ },
+ "imageUrl": {
+ "type": "string",
+ "description": "Image URL.",
+ "example": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000"
+ },
+ "imageText": {
+ "type": "string",
+ "description": "Image text.",
+ "nullable": true,
+ "example": "hoegaarden-kit"
+ },
+ "imageLastModified": {
+ "type": "string",
+ "description": "Date and time of the last update of the image.",
+ "example": "2020-10-07T12:49:27.5800000Z"
+ }
+ }
+ }
+ },
+ "sellers": {
+ "type": "array",
+ "description": "Array of SKU sellers.",
+ "example": [
+ {
+ "sellerId": "1",
+ "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE",
+ "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1",
+ "sellerDefault": true,
+ "commertialOffer": {
+ "DeliverySlaSamplesPerRegion": {
+ "0": {
+ "DeliverySlaPerTypes": [],
+ "Region": null
+ }
+ },
+ "Installments": [
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa à vista"
+ },
+ {
+ "Value": 21,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 2,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 2 vezes sem juros"
+ },
+ {
+ "Value": 14,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 3,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 3 vezes sem juros"
+ },
+ {
+ "Value": 10.5,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 4,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 4 vezes sem juros"
+ },
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Promissory",
+ "PaymentSystemGroupName": "promissoryPaymentGroup",
+ "Name": "Promissory à vista"
+ }
+ ],
+ "DiscountHighLight": [],
+ "GiftSkuIds": [],
+ "Teasers": [
+ {
+ "",
+ "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000",
+ "imageText": "hoegaarden-kit",
+ "imageLastModified": "2020-10-07T12:49:27.5800000Z"
+ }
+ ],
+ "sellers": [
+ {
+ "sellerId": "1",
+ "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE",
+ "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1",
+ "sellerDefault": true,
+ "commertialOffer": {
+ "DeliverySlaSamplesPerRegion": {
+ "0": {
+ "DeliverySlaPerTypes": [],
+ "Region": null
+ }
+ },
+ "Installments": [
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa à vista"
+ },
+ {
+ "Value": 21,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 2,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 2 vezes sem juros"
+ },
+ {
+ "Value": 14,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 3,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 3 vezes sem juros"
+ },
+ {
+ "Value": 10.5,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 4,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 4 vezes sem juros"
+ },
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Promissory",
+ "PaymentSystemGroupName": "promissoryPaymentGroup",
+ "Name": "Promissory à vista"
+ }
+ ],
+ "DiscountHighLight": [],
+ "GiftSkuIds": [],
+ "Teasers": [
+ {
+ "",
+ "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000",
+ "imageText": "hoegaarden-kit",
+ "imageLastModified": "2020-10-07T12:49:27.5800000Z"
+ }
+ ],
+ "sellers": [
+ {
+ "sellerId": "1",
+ "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE",
+ "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1",
+ "sellerDefault": true,
+ "commertialOffer": {
+ "DeliverySlaSamplesPerRegion": {
+ "0": {
+ "DeliverySlaPerTypes": [],
+ "Region": null
+ }
+ },
+ "Installments": [
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa à vista"
+ },
+ {
+ "Value": 21,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 2,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 2 vezes sem juros"
+ },
+ {
+ "Value": 14,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 3,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 3 vezes sem juros"
+ },
+ {
+ "Value": 10.5,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 4,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 4 vezes sem juros"
+ },
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Promissory",
+ "PaymentSystemGroupName": "promissoryPaymentGroup",
+ "Name": "Promissory à vista"
+ }
+ ],
+ "DiscountHighLight": [],
+ "GiftSkuIds": [],
+ "Teasers": [
+ {
+ "",
+ "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000",
+ "imageText": "hoegaarden-kit",
+ "imageLastModified": "2020-10-07T12:49:27.5800000Z"
+ }
+ ],
+ "sellers": [
+ {
+ "sellerId": "1",
+ "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE",
+ "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1",
+ "sellerDefault": true,
+ "commertialOffer": {
+ "DeliverySlaSamplesPerRegion": {
+ "0": {
+ "DeliverySlaPerTypes": [],
+ "Region": null
+ }
+ },
+ "Installments": [
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa à vista"
+ },
+ {
+ "Value": 21,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 2,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 2 vezes sem juros"
+ },
+ {
+ "Value": 14,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 3,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 3 vezes sem juros"
+ },
+ {
+ "Value": 10.5,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 4,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 4 vezes sem juros"
+ },
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Promissory",
+ "PaymentSystemGroupName": "promissoryPaymentGroup",
+ "Name": "Promissory à vista"
+ }
+ ],
+ "DiscountHighLight": [],
+ "GiftSkuIds": [],
+ "Teasers": [
+ {
+ "",
+ "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000",
+ "imageText": "hoegaarden-kit",
+ "imageLastModified": "2020-10-07T12:49:27.5800000Z"
+ }
+ ],
+ "items": {
+ "type": "object",
+ "example": {
+ "imageId": "155489",
+ "imageLabel": "",
+ "imageTag": "",
+ "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000",
+ "imageText": "hoegaarden-kit",
+ "imageLastModified": "2020-10-07T12:49:27.5800000Z"
+ },
+ "required": [
+ "imageId",
+ "imageLabel",
+ "imageTag",
+ "imageUrl",
+ "imageText",
+ "imageLastModified"
+ ],
+ "properties": {
+ "imageId": {
+ "type": "string",
+ "description": "Image ID.",
+ "example": "155489"
+ },
+ "imageLabel": {
+ "type": "string",
+ "description": "Image label.",
+ "example": "Label test"
+ },
+ "imageTag": {
+ "type": "string",
+ "description": "Image tag.",
+ "example": ""
+ },
+ "imageUrl": {
+ "type": "string",
+ "description": "Image URL.",
+ "example": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000"
+ },
+ "imageText": {
+ "type": "string",
+ "description": "Image text.",
+ "nullable": true,
+ "example": "hoegaarden-kit"
+ },
+ "imageLastModified": {
+ "type": "string",
+ "description": "Date and time of the last update of the image.",
+ "example": "2020-10-07T12:49:27.5800000Z"
+ }
+ }
+ }
+ },
+ "sellers": {
+ "type": "array",
+ "description": "Array of SKU sellers.",
+ "example": [
+ {
+ "sellerId": "1",
+ "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE",
+ "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1",
+ "sellerDefault": true,
+ "commertialOffer": {
+ "DeliverySlaSamplesPerRegion": {
+ "0": {
+ "DeliverySlaPerTypes": [],
+ "Region": null
+ }
+ },
+ "Installments": [
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa à vista"
+ },
+ {
+ "Value": 21,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 2,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 2 vezes sem juros"
+ },
+ {
+ "Value": 14,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 3,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 3 vezes sem juros"
+ },
+ {
+ "Value": 10.5,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 4,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 4 vezes sem juros"
+ },
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Promissory",
+ "PaymentSystemGroupName": "promissoryPaymentGroup",
+ "Name": "Promissory à vista"
+ }
+ ],
+ "DiscountHighLight": [],
+ "GiftSkuIds": [],
+ "Teasers": [
+ {
+ "",
+ "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000",
+ "imageText": "hoegaarden-kit",
+ "imageLastModified": "2020-10-07T12:49:27.5800000Z"
+ }
+ ],
+ "sellers": [
+ {
+ "sellerId": "1",
+ "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE",
+ "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1",
+ "sellerDefault": true,
+ "commertialOffer": {
+ "DeliverySlaSamplesPerRegion": {
+ "0": {
+ "DeliverySlaPerTypes": [],
+ "Region": null
+ }
+ },
+ "Installments": [
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa à vista"
+ },
+ {
+ "Value": 21,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 2,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 2 vezes sem juros"
+ },
+ {
+ "Value": 14,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 3,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 3 vezes sem juros"
+ },
+ {
+ "Value": 10.5,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 4,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 4 vezes sem juros"
+ },
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Promissory",
+ "PaymentSystemGroupName": "promissoryPaymentGroup",
+ "Name": "Promissory à vista"
+ }
+ ],
+ "DiscountHighLight": [],
+ "GiftSkuIds": [],
+ "Teasers": [
+ {
+ "",
+ "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000",
+ "imageText": "hoegaarden-kit",
+ "imageLastModified": "2020-10-07T12:49:27.5800000Z"
+ }
+ ],
+ "sellers": [
+ {
+ "sellerId": "1",
+ "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE",
+ "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1",
+ "sellerDefault": true,
+ "commertialOffer": {
+ "DeliverySlaSamplesPerRegion": {
+ "0": {
+ "DeliverySlaPerTypes": [],
+ "Region": null
+ }
+ },
+ "Installments": [
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa à vista"
+ },
+ {
+ "Value": 21,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 2,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 2 vezes sem juros"
+ },
+ {
+ "Value": 14,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 3,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 3 vezes sem juros"
+ },
+ {
+ "Value": 10.5,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 4,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 4 vezes sem juros"
+ },
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Promissory",
+ "PaymentSystemGroupName": "promissoryPaymentGroup",
+ "Name": "Promissory à vista"
+ }
+ ],
+ "DiscountHighLight": [],
+ "GiftSkuIds": [],
+ "Teasers": [
+ {
+ "",
+ "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000",
+ "imageText": "hoegaarden-kit",
+ "imageLastModified": "2020-10-07T12:49:27.5800000Z"
+ }
+ ],
+ "sellers": [
+ {
+ "sellerId": "1",
+ "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE",
+ "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1",
+ "sellerDefault": true,
+ "commertialOffer": {
+ "DeliverySlaSamplesPerRegion": {
+ "0": {
+ "DeliverySlaPerTypes": [],
+ "Region": null
+ }
+ },
+ "Installments": [
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa à vista"
+ },
+ {
+ "Value": 21,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 2,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 2 vezes sem juros"
+ },
+ {
+ "Value": 14,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 3,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 3 vezes sem juros"
+ },
+ {
+ "Value": 10.5,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 4,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 4 vezes sem juros"
+ },
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Promissory",
+ "PaymentSystemGroupName": "promissoryPaymentGroup",
+ "Name": "Promissory à vista"
+ }
+ ],
+ "DiscountHighLight": [],
+ "GiftSkuIds": [],
+ "Teasers": [
+ {
+ "",
+ "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000",
+ "imageText": "hoegaarden-kit",
+ "imageLastModified": "2020-10-07T12:49:27.5800000Z"
+ }
+ ],
+ "items": {
+ "type": "object",
+ "example": {
+ "imageId": "155489",
+ "imageLabel": "",
+ "imageTag": "",
+ "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000",
+ "imageText": "hoegaarden-kit",
+ "imageLastModified": "2020-10-07T12:49:27.5800000Z"
+ },
+ "required": [
+ "imageId",
+ "imageLabel",
+ "imageTag",
+ "imageUrl",
+ "imageText",
+ "imageLastModified"
+ ],
+ "properties": {
+ "imageId": {
+ "type": "string",
+ "description": "Image ID.",
+ "example": "155489"
+ },
+ "imageLabel": {
+ "type": "string",
+ "description": "Image label.",
+ "example": "Label test"
+ },
+ "imageTag": {
+ "type": "string",
+ "description": "Image tag.",
+ "example": ""
+ },
+ "imageUrl": {
+ "type": "string",
+ "description": "Image URL.",
+ "example": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000"
+ },
+ "imageText": {
+ "type": "string",
+ "description": "Image text.",
+ "nullable": true,
+ "example": "hoegaarden-kit"
+ },
+ "imageLastModified": {
+ "type": "string",
+ "description": "Date and time of the last update of the image.",
+ "example": "2020-10-07T12:49:27.5800000Z"
+ }
+ }
+ }
+ },
+ "sellers": {
+ "type": "array",
+ "description": "Array of SKU sellers.",
+ "example": [
+ {
+ "sellerId": "1",
+ "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE",
+ "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1",
+ "sellerDefault": true,
+ "commertialOffer": {
+ "DeliverySlaSamplesPerRegion": {
+ "0": {
+ "DeliverySlaPerTypes": [],
+ "Region": null
+ }
+ },
+ "Installments": [
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa à vista"
+ },
+ {
+ "Value": 21,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 2,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 2 vezes sem juros"
+ },
+ {
+ "Value": 14,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 3,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 3 vezes sem juros"
+ },
+ {
+ "Value": 10.5,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 4,
+ "PaymentSystemName": "Visa",
+ "PaymentSystemGroupName": "creditCardPaymentGroup",
+ "Name": "Visa 4 vezes sem juros"
+ },
+ {
+ "Value": 42,
+ "InterestRate": 0,
+ "TotalValuePlusInterestRate": 42,
+ "NumberOfInstallments": 1,
+ "PaymentSystemName": "Promissory",
+ "PaymentSystemGroupName": "promissoryPaymentGroup",
+ "Name": "Promissory à vista"
+ }
+ ],
+ "DiscountHighLight": [],
+ "GiftSkuIds": [],
+ "Teasers": [
+ {
+ "