openapi: 3.0.0 info: title: VTex Anti-fraud Provider Account User Orders API description: ">ℹ️ Onboarding guide\r\n>\r\n> Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.\r\n\r\nThe Anti-fraud Provider Protocol is a set of definitions to help you integrate your anti-fraud service API into VTEX platform.\r\n\r\nTo achieve this, you need to implement a web API (REST) following the specifications described in this documentation.\r\n\r\n>⚠️ You can also access our [template on GitHub](https://github.com/vtex-apps/antifraud-provider-example) to help you quickly develop your anti-fraud connector using the Anti-fraud Provider Protocol and VTEX IO.\r\n\r\nTo learn more about the Anti-fraud Provider Protocol, check our [developer guide](https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works).\r\n\r\n## Anti-fraud Provider API Index\r\n\r\n### Anti-fraud Flow\r\n\r\n- `POST` [Send Anti-fraud Pre-Analysis Data (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/pre-analysis)\r\n- `POST` [Send Anti-fraud Data](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/transactions)\r\n- `PUT` [Update Anti-fraud Transactions (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#put-/transactions/-transactionId-)\r\n- `GET` [List Anti-fraud Provider Manifest](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/manifest)\r\n- `GET` [Get Anti-fraud Status](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/transactions/-transactions.id-)\r\n- `DELETE` [Stop Anti-fraud Analysis (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#delete-/transactions/-transactions.Id-)\r\n\r\n### OAuth Flow\r\n\r\n1. `POST` [Retrieve Token](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/authorization/token)\r\n2. `GET` [Redirect](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/redirect)\r\n3. `GET` [Return to VTEX](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorizationCode)\r\n4. `GET` [Get Credentials](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorization/credentials)" version: '1.0' servers: - url: https://{providerApiEndpoint} description: Anti-fraud provider endpoint URL. variables: providerApiEndpoint: description: Anti-fraud provider endpoint URL. default: '{providerApiEndpoint}' tags: - name: User Orders paths: /api/oms/user/orders: get: tags: - User Orders summary: VTex Retrieve user's orders description: "Lists all orders from a given customer, filtering by their email. \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> Note that this request should be made by an [user](https://developers.vtex.com/docs/guides/user-authentication-and-login) or [an appKey / appToken pair](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) that is associated with the [Call center operator](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy#call-center-operator) role. Otherwise, it will return only orders from the same email informed in the `clientEmail` query parameter. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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\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| Call center operator | View order |\r\n| OMS - Read only | View 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-application-keys--7b6nD1VMHa49aI5brlOvJm). \r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)." operationId: Userorderslist parameters: - name: clientEmail in: query description: Customer email. required: true style: form explode: true schema: type: string example: customer@mail.com - name: page in: query description: Page number for result pagination. required: true style: form explode: true schema: type: string example: '15' - name: per_page in: query description: Page quantity for result pagination. required: true style: form explode: true schema: type: string example: '15' - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Userorderslist' example: list: - orderId: v502556llux-01 creationDate: '2019-01-28T20:09:43+00:00' clientName: Cunha VTEX items: null totalValue: 1160 paymentNames: Boleto Bancário status: handling statusDescription: Preparando Entrega marketPlaceOrderId: null sequence: '502556' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store Seu pedido foi alterado! Pedido realizado em: 28/01/2019 Olá, Rodrigo. Seu pedido foi alterado. Seguem informações abaixo: ' ShippingEstimatedDate: '2019-02-04T20:33:46+00:00' ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-01-28T20:33:04+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502449llux-02 creationDate: '2018-08-28T17:42:40+00:00' clientName: Cunha VTEX items: null totalValue: 118588 paymentNames: Promissory status: canceled statusDescription: Cancelado marketPlaceOrderId: null sequence: '502452' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502449llux-02 Resumo Itens R$ 1.178,98 Entrega R$ 6,90 Total R$ 1.185,88' ShippingEstimatedDate: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 12 currencyCode: BRL - orderId: v502449llux-01 creationDate: '2018-08-28T17:42:28.9171556+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Mangueira Reservatório Ao Cavalete ean: null refId: TE3121110 id: '195' productId: '134' sellingPrice: 7390 price: 7390 - seller: '1' quantity: 1 description: Mangueira Filtro ean: null refId: XC459N610CA id: '238' productId: '162' sellingPrice: 5190 price: 5190 totalValue: 21526180 paymentNames: null status: canceled statusDescription: Cancelado marketPlaceOrderId: '' sequence: '502449' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 0 currencyCode: null - orderId: v502058llux-01 creationDate: '2017-07-25T23:17:36.7963248+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Aquecedor Britania 1500 Branco ean: '1235567890143' refId: branquinho id: '1234568212' productId: '1000200' sellingPrice: 35599 price: 35599 totalValue: 35599 paymentNames: null status: invoiced statusDescription: Faturado marketPlaceOrderId: '' sequence: '502058' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: '2017-07-29T19:24:20.7444363+00:00' ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 0 currencyCode: null - orderId: v501538llux-01 creationDate: '2017-06-26T16:57:58.9986524+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Boneco do Mário ean: bonecomario refId: bonecomario id: '1234568183' productId: '1000257' sellingPrice: 150363 price: 150363 - seller: '1' quantity: 1 description: Camiseta GG ean: null refId: abc1234 id: '1234567894' productId: '1000187' sellingPrice: 899 price: 899 totalValue: 151262 paymentNames: null status: invoiced statusDescription: Faturado marketPlaceOrderId: '' sequence: '501538' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: '2017-06-27T13:59:49.7705236+00:00' ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 0 currencyCode: null - orderId: v501020llux-01 creationDate: '2016-11-21T19:57:54.0415289+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 2 description: Camiseta GG ean: null refId: abc1234 id: '1234567894' productId: '1000187' sellingPrice: 899 price: 899 totalValue: 3190 paymentNames: null status: canceled statusDescription: Cancelado marketPlaceOrderId: '' sequence: '501020' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: '2016-12-02T08:00:00+00:00' ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 0 currencyCode: null - orderId: v500973llux-01 creationDate: '2016-10-10T17:19:30.8562035+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: SMARTPHONE SAMSUNG GALAXY S7 FLAT SM-G930FZDLZTO 32GB DOURADO TELA 5.1" 4G CÂMERA 12 MP ean: null refId: testefnac id: '1234568028' productId: '1000203' sellingPrice: 299000 price: 299000 totalValue: 299900 paymentNames: null status: handling statusDescription: Preparando Entrega marketPlaceOrderId: '' sequence: '500973' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: '2016-10-10T14:23:17.1897068+00:00' ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 0 currencyCode: null - orderId: v500970llux-01 creationDate: '2016-10-10T17:07:59.0889392+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Camiseta GG ean: null refId: abc1234 id: '1234567894' productId: '1000187' sellingPrice: 899 price: 899 totalValue: 1799 paymentNames: null status: invoiced statusDescription: Faturado marketPlaceOrderId: '' sequence: '500970' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: '2016-10-10T14:13:34.4927265+00:00' ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 0 currencyCode: null - orderId: v500890llux-01 creationDate: '2016-08-17T18:35:04.8659804+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Botin Futbol Adidas 11Questra Fg Cesped Hombre Absolut - M ean: absolutm refId: null id: '549' productId: '9' sellingPrice: 1000 price: 1000 totalValue: 1000 paymentNames: null status: canceled statusDescription: Cancelado marketPlaceOrderId: '' sequence: '500890' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 0 currencyCode: null - orderId: v500838llux-01 creationDate: '2016-07-29T00:20:47.7736718+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Rooibos Lavanda - Pouch - 50gr ean: '198' refId: '10098' id: '98' productId: '1000025' sellingPrice: 5200 price: 5200 totalValue: 6200 paymentNames: null status: canceled statusDescription: Cancelado marketPlaceOrderId: '' sequence: '500838' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 0 currencyCode: null facets: [] paging: total: 19 pages: 10 currentPage: 1 perPage: 2 stats: stats: totalValue: Count: 19 Max: 0 Mean: 0 Min: 0 Missing: 0 StdDev: 0 Sum: 0 SumOfSquares: 0 Facets: {} totalItems: Count: 19 Max: 0 Mean: 0 Min: 0 Missing: 0 StdDev: 0 Sum: 0 SumOfSquares: 0 Facets: {} deprecated: false /api/oms/user/orders/{orderId}: get: tags: - User Orders summary: VTex Retrieve user order details description: "Lists all details from an order, through the perspective of the customer who placed the order. \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> Note that this request should be made by an [user](https://developers.vtex.com/docs/guides/user-authentication-and-login) or [an appKey / appToken pair](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) that is associated with the [Call center operator](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy#call-center-operator) role. Otherwise, it will return only orders from the same email informed in the `clientEmail` query parameter. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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\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| Call center operator | View order |\r\n| OMS - Read only | View 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-application-keys--7b6nD1VMHa49aI5brlOvJm). \r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)." operationId: Userorderdetails parameters: - name: clientEmail in: query description: Customer email. required: true style: form explode: true schema: type: string example: customer@mail.com - name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json - name: Accept in: header description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json - name: orderId in: path description: Order ID is a unique code that identifies an order. required: true style: simple schema: type: string example: 1172452900788-01 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Userorderdetails' example: orderId: 1172452900788-01 sequence: '502556' marketplaceOrderId: '' marketplaceServicesEndpoint: http://oms.vtexinternal.com.br/api/oms?an=luxstore sellerOrderId: 00-v502556llux-01 origin: Marketplace affiliateId: GHB salesChannel: '1' merchantName: luxstore status: handling statusDescription: Preparando Entrega value: 1160 creationDate: '2019-01-28T20:09:43.899958+00:00' lastChange: '2019-02-06T20:46:11.7010747+00:00' orderGroup: v502556lspt totals: - id: Items name: Total dos Itens value: 3290 - id: Discounts name: Total dos Descontos value: 0 - id: Shipping name: Total do Frete value: 1160 - id: Tax name: Total da Taxa value: 0 - id: Change name: Total das mudanças value: -3290 items: - uniqueId: 87F0945396994B349158C7D9C9941442 id: '1234568358' productId: '9429485' ean: '3256873' lockId: 00-v502556llux-01 itemAttachment: content: {} name: null attachments: [] quantity: 1 seller: '1' name: Bay Max L refId: BIGHEROBML price: 3290 listPrice: 3290 manualPrice: null priceTags: [] imageUrl: http://luxstore.vteximg.com.br/arquivos/ids/159263-55-55/image-cc1aed75cbfa424a85a94900be3eacec.jpg?v=636795432619830000 detailUrl: /bay-max-9429485/p components: [] bundleItems: [] params: [] offerings: [] attachmentOfferings: - name: vtex.subscription.weekly required: false schema: vtex.subscription.key.frequency: MaximumNumberOfCharacters: 7 Domain: - 1 week - ' 2 week' - ' 3 week' - ' 4 week' sellerSku: '1234568358' priceValidUntil: null commission: 0 tax: 0 preSaleDate: null additionalInfo: brandName: VTEX brandId: '2000023' categoriesIds: /1/ productClusterId: 135,142 commercialConditionId: '5' dimension: cubicweight: 0.7031 height: 15 length: 15 weight: 15 width: 15 offeringInfo: null offeringType: null offeringTypeId: null measurementUnit: un unitMultiplier: 1 sellingPrice: 3290 isGift: false shippingPrice: null rewardValue: 0 freightCommission: 0 priceDefinitions: sellingPrices: - value: 99 quantity: 1 calculatedSellingPrice: 99 total: 99 taxCode: null parentItemIndex: null parentAssemblyBinding: null callCenterOperator: callCenterOp5473869 serialNumbers: '3' assemblies: [] costPrice: 52 marketplaceItems: [] clientProfileData: id: clientProfileData email: rodrigo.cunha@vtex.com.br firstName: Rodrigo lastName: Cunha documentType: cpf document: '11047867702' phone: '+5521972321094' corporateName: null tradeName: null corporateDocument: null stateInscription: null corporatePhone: null isCorporate: false userProfileId: 5a3692de-358a-4bea-8885-044bce33bb93 customerClass: null giftRegistryData: null marketingData: id: marketingData utmSource: fb utmPartner: utm partner name utmMedium: utm medium name utmCampaign: christmas coupon: sale utmiCampaign: ' ' utmipage: ' ' utmiPart: ' ' marketingTags: - vtex-subscription ratesAndBenefitsData: id: ratesAndBenefitsData rateAndBenefitsIdentifiers: [] shippingData: id: shippingData address: addressType: residential receiverName: Rodrigo Cunha addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA street: Praia de Botafogo number: '518' neighborhood: Botafogo complement: '10' reference: null geoCoordinates: [] logisticsInfo: - itemIndex: 0 selectedSla: Normal lockTTL: 10d price: 1160 listPrice: 1160 sellingPrice: 1160 deliveryWindow: null deliveryCompany: Todos os CEPS shippingEstimate: 5bd shippingEstimateDate: '2019-02-04T20:33:46.4595004+00:00' slas: - id: Normal name: Normal shippingEstimate: 5bd deliveryWindow: null price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: region196 lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 3d pickupDistance: 0 - id: Expressa name: Expressa shippingEstimate: 5bd deliveryWindow: null price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: null lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 3d pickupDistance: 0 - id: Quebra Kit name: Quebra Kit shippingEstimate: 2bd deliveryWindow: null price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: null lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 3d pickupDistance: 0 - id: Sob Encomenda name: Sob Encomenda shippingEstimate: 32bd deliveryWindow: null price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: null lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 3d pickupDistance: 0 shipsTo: - BRA deliveryIds: - courierId: 197a56f courierName: Todos os CEPS dockId: '1' quantity: 1 warehouseId: '1_1' accountCarrierName: recorrenciaqa kitItemDetails: [] deliveryChannels: - id: delivery stockBalance: 0 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad polygonName: null pickupPointId: 1_VTEX-RJ transitTime: 3d trackingHints: null selectedAddresses: - addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad addressType: residential receiverName: Rodrigo Cunha street: Praia de Botafogo number: '518' complement: '10' neighborhood: Botafogo postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA reference: null geoCoordinates: [] paymentData: giftCards: [] transactions: - isActive: true transactionId: 418213DE29634837A63DD693A937A696 merchantName: luxstore payments: - id: D3DEECAB3C6C4B9EAF8EF4C1FE062FF3 paymentSystem: '6' paymentSystemName: Boleto Bancário value: 4450 installments: 1 referenceValue: 4450 cardHolder: null cardNumber: null firstDigits: null lastDigits: null cvv2: null expireMonth: null expireYear: null url: https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment} giftCardId: null giftCardName: null giftCardCaption: null redemptionCode: null group: bankInvoice tid: null dueDate: '2019-02-02' connectorResponses: Tid: '94857956' ReturnCode: '200' Message: logMessage authId: '857956' giftCardProvider: presentCard giftCardAsDiscount: false koinUrl: koinURL accountId: 5BC5C6B417FE432AB971B1D399F190C9 parentAccountId: 5BC5C6B417FE432AB971B1D399F190C9 bankIssuedInvoiceIdentificationNumber: '23797770100000019003099260100022107500729050' bankIssuedInvoiceIdentificationNumberFormatted: 32534.95739 75945.24534 54395.734214 5 bankIssuedInvoiceBarCodeNumber: '325349573975945245345439573421443986734065' bankIssuedInvoiceBarCodeType: i25 billingAddress: {} packageAttachment: packages: [] sellers: - id: '1' name: Lux Store logo: https://sellersLogo/images.png fulfillmentEndpoint: http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=accountName callCenterOperatorData: null followUpEmail: 7bf3a59bbc56402c810bda9521ba449e@ct.vtex.com.br lastMessage: null hostname: luxstore invoiceData: null changesAttachment: id: changeAttachment changesData: - reason: Blah 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 openTextField: null roundingError: 0 orderFormId: caae7471333e403f959fa5fd66951340 commercialConditionData: null isCompleted: true customData: null storePreferencesData: countryCode: BRA currencyCode: BRL currencyFormatInfo: CurrencyDecimalDigits: 2 CurrencyDecimalSeparator: ',' CurrencyGroupSeparator: . CurrencyGroupSize: 3 StartsWithCurrencySymbol: true currencyLocale: 1046 currencySymbol: R$ timeZone: E. South America Standard Time allowCancellation: true allowEdition: false isCheckedIn: false marketplace: baseURL: http://oms.vtexinternal.com.br/api/oms?an=luxstore isCertified: null name: luxstore authorizedDate: '2019-01-28T20:33:04+00:00' invoicedDate: null cancelReason: The size was too big. 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: {} subscriptionData: SubscriptionGroupId: A64AC73C0FB8693A7ADB4AC69CA4FD5F Subscriptions: - ExecutionCount: 724 PriceAtSubscriptionDate: 100 ItemIndex: 0 Plan: type: RECURRING_PAYMENT frequency: periodicity: DAILY interval: 1 validity: begin: '2022-01-10T00:00:00.0000000+00:00' end: '2024-02-03T00:00:00.0000000+00:00' taxData: areTaxesDesignatedByMarketplace: true taxInfoCollection: - itemIndex: 0 sku: COLOCAR_O_SKUID priceTags: - isPercentual: false name: Taxes (Magazine Luisa) rawValue: COLOCAR_O_VALOR_SEM_DECIMAL checkedInPickupPointId: storeNameExample_901 cancellationData: RequestedByUser: true RequestedBySystem: false RequestedBySellerNotification: false RequestedByPaymentNotification: false Reason: Item was too big in the client. CancellationDate: 2022-10--05T15:40:33 clientPreferencesData: locale: en-US optinNewsLetter: false deprecated: false components: schemas: ChangesAttachment: title: ChangesAttachment description: Information about changes in the order. required: - id - changesData type: object properties: id: type: string description: Object ID, the expect value is `changeAttachment`. changesData: type: array items: $ref: '#/components/schemas/ChangesDatum' description: Order change details. example: id: changeAttachment changesData: - reason: Blah 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: v5195004lux-01 receipt: 029f9ab8-751a-4b1e-bf81-7dd25d14b49b Transaction: title: Transaction description: Financial transaction details. required: - isActive - transactionId - merchantName - payments type: object properties: isActive: type: boolean description: When this field is set as `true`, the payment is active, and when it is `false`, the payment is inactive. transactionId: type: string description: ID of the transaction. merchantName: type: string description: Name of the merchant that will receive the payment. payments: type: array items: $ref: '#/components/schemas/Payment' description: Detailed information about payment. example: isActive: true transactionId: 418213DE29634837A63DD693A937A696 merchantName: luxstore payments: - id: D3DEECAB3C6C4B9EAF8EF4C1FE062FF3 paymentSystem: '6' paymentSystemName: Boleto Bancário value: 4450 installments: 1 referenceValue: 4450 cardHolder: null cardNumber: null firstDigits: null lastDigits: null cvv2: null expireMonth: null expireYear: null url: https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment} giftCardId: null giftCardName: null giftCardCaption: null redemptionCode: null group: bankInvoice tid: null dueDate: '2019-02-02' connectorResponses: Tid: '94857956' ReturnCode: '200' Message: logMessage authId: '857956' giftCardProvider: presentCard giftCardAsDiscount: false koinUrl: koinURL accountId: 5BC5C6B417FE432AB971B1D399F190C9 parentAccountId: 5BC5C6B417FE432AB971B1D399F190C9 bankIssuedInvoiceIdentificationNumber: '23797770100000019003099260100022107500729050' bankIssuedInvoiceIdentificationNumberFormatted: 32534.95739 75945.24534 54395.734214 5 bankIssuedInvoiceBarCodeNumber: '325349573975945245345439573421443986734065' bankIssuedInvoiceBarCodeType: i25 billingAddress: {} AdditionalInfo: title: AdditionalInfo description: Additional information about the item. required: - brandName - brandId - categoriesIds - productClusterId - commercialConditionId - dimension - offeringInfo - offeringType - offeringTypeId type: object 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. productClusterId: type: string description: All product clusters related to the item. commercialConditionId: type: string description: Commercial conditions ID. dimension: $ref: '#/components/schemas/Dimension' 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. example: brandName: VTEX brandId: '2000023' categoriesIds: /1/ productClusterId: 135,142 commercialConditionId: '5' dimension: cubicweight: 0.7031 height: 15 length: 15 weight: 15 width: 15 offeringInfo: null offeringType: null offeringTypeId: null List1: title: List1 required: - orderId - creationDate - clientName - items - totalValue - paymentNames - status - statusDescription - marketPlaceOrderId - sequence - salesChannel - affiliateId - origin - workflowInErrorState - workflowInRetry - lastMessageUnread - ShippingEstimatedDate - ShippingEstimatedDateMax - ShippingEstimatedDateMin - orderIsComplete - listId - listType - authorizedDate - callCenterOperatorName - totalItems - currencyCode type: object properties: orderId: type: string description: Order ID is a unique code that identifies an order. creationDate: type: string description: Order's creation date. clientName: type: string description: Order's customer name. items: type: array items: $ref: '#/components/schemas/Item2' description: Information about order's items. nullable: true deprecated: true totalValue: type: integer description: Total value amount. paymentNames: type: string nullable: true description: Payment system name. status: type: string description: Order [status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). statusDescription: type: string description: Status description which is displayed on the Admin panel. This field is deprecated and may not return any value. deprecated: true marketPlaceOrderId: type: string nullable: true description: Marketplace order ID. sequence: type: string description: Six-digit string that follows the order ID. For example, in order `1268540501456-01 (501456)`, the sequence is `501456`. salesChannel: type: string description: Sales channel (or [trade policy](https://help.vtex.com/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID related to the order. affiliateId: type: string description: Corresponds to the three-digits [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) identification code of the seller responsible for the order. origin: type: string description: Order's [origin in the order flow](https://developers.vtex.com/docs/guides/orders-overview#understanding-order-flow-types), which can be `Marketplace`, `Fulfillment` or `Chain`. workflowInErrorState: type: boolean description: If there is a work flow error (`true`) or not (`false`). workflowInRetry: type: boolean description: If the order is in a work flow retry (`true`) or not (`false`). lastMessageUnread: type: string nullable: true description: Last sent transactional message. ShippingEstimatedDate: type: string nullable: true description: Estimate shipping date. ShippingEstimatedDateMax: type: string nullable: true description: The most extended shipping estimation possible. ShippingEstimatedDateMin: type: string nullable: true description: The least extended shipping estimation possible. orderIsComplete: type: boolean description: If it is a completed order (`true`) or not (`false`). For more information, see [Order flow and status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). listId: type: string nullable: true description: Related Gift List ID. listType: type: string nullable: true description: Related Gift list type. authorizedDate: type: string nullable: true description: Authorized order date. callCenterOperatorName: type: string nullable: true description: Call center operator responsible for the order. totalItems: type: integer description: Order's total amount of items. currencyCode: type: string nullable: true description: Currency code in ISO 4217. For example, `BRL`. example: orderId: 1172452900788-01 creationDate: '2019-01-28T20:09:43+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Reservoir hose ean: null refId: TE3121110 id: '195' productId: '134' sellingPrice: 7390 price: 7390 - seller: '1' quantity: 1 description: Reservoir filter ean: null refId: XC459N610CA id: '238' productId: '162' sellingPrice: 5190 price: 5190 totalValue: 1160 paymentNames: Boleto Bancário status: handling statusDescription: Preparing for delivery marketPlaceOrderId: null sequence: '502556' salesChannel: '1' affiliateId: GTB origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store Seu pedido foi alterado! Pedido realizado em: 28/01/2019 Olá, Rodrigo. Seu pedido foi alterado. Seguem informações abaixo: ' ShippingEstimatedDate: '2019-02-04T20:33:46+00:00' ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-01-28T20:33:04+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL ItemsRemoved: title: ItemsRemoved required: - id - name - quantity - price - unitMultiplier type: object properties: id: type: string description: SKU ID of the item removed from the order. name: type: string description: Name of the item removed from the order. quantity: type: integer description: Quantity of items removed from the order. price: type: integer description: Total amount of items removed from the order. unitMultiplier: type: string nullable: true description: Unit multiplier of the item removed from the order. example: id: '1234568358' name: Bay Max L quantity: 1 price: 3290 unitMultiplier: null Userorderdetails: title: Userorderdetails required: - orderId - sequence - marketplaceOrderId - marketplaceServicesEndpoint - sellerOrderId - origin - affiliateId - salesChannel - merchantName - status - statusDescription - value - creationDate - lastChange - orderGroup - totals - items - marketplaceItems - clientProfileData - giftRegistryData - marketingData - ratesAndBenefitsData - shippingData - paymentData - packageAttachment - sellers - callCenterOperatorData - followUpEmail - lastMessage - hostname - invoiceData - changesAttachment - openTextField - roundingError - orderFormId - commercialConditionData - isCompleted - customData - storePreferencesData - allowCancellation - allowEdition - isCheckedIn - marketplace - authorizedDate - invoicedDate - cancelReason - itemMetadata - subscriptionData - taxData - checkedInPickupPointId - cancellationData - clientPreferencesData type: object properties: orderId: type: string description: Order ID is a unique code that identifies an order. sequence: type: string description: Sequence is a six-digit string that follows the order ID. For example, in order `1268540501456-01 (501456)`, the sequence is `501456`. marketplaceOrderId: type: string description: Marketplace order ID. marketplaceServicesEndpoint: type: string description: Marketplace services endpoint. sellerOrderId: type: string description: ID of the seller related to the order. It can be a VTEX seller or an external seller. origin: type: string description: Order's [origin in the order flow](https://developers.vtex.com/docs/guides/orders-overview#understanding-order-flow-types), which can be `Marketplace`, `Fulfillment` or `Chain`. affiliateId: type: string description: Corresponds to the three-digit [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) identification code of the seller responsible for the order. salesChannel: type: string description: Sales channel (or [trade policy](https://help.vtex.com/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID related to the order. merchantName: type: string description: Name of the merchant. status: type: string description: Order [status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). statusDescription: type: string description: '`Deprecated`. Status description which is displayed on the Admin panel. This field is obsolete and may not return any value.' deprecated: true value: type: integer description: Order's total amount. creationDate: type: string description: Order's creation date. lastChange: type: string description: Order's last change date. orderGroup: type: string description: Order's group ID. totals: type: array items: $ref: '#/components/schemas/Total' description: List with details about orders' totals. items: type: array items: $ref: '#/components/schemas/Item' description: Information about order's items. marketplaceItems: type: array items: type: string description: Marketplace details object. clientProfileData: $ref: '#/components/schemas/ClientProfileData' giftRegistryData: type: string nullable: true description: Information about gift list, when it applies. marketingData: type: object description: Information about promotions and marketing. For example, coupon tracking information and internal or external UTMs. required: - id - utmSource - utmPartner - utmMedium - utmCampaign - coupon - utmiCampaign - utmipage - utmiPart - marketingTags properties: id: type: string description: Object ID which 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's code information. 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 ratesAndBenefitsData: $ref: '#/components/schemas/RatesAndBenefitsData' shippingData: $ref: '#/components/schemas/ShippingData' paymentData: $ref: '#/components/schemas/PaymentData' packageAttachment: $ref: '#/components/schemas/PackageAttachment' sellers: type: array items: $ref: '#/components/schemas/Seller' description: List of all sellers associated with the order. callCenterOperatorData: type: string nullable: true description: Call center operator responsible for the order. followUpEmail: type: string description: Email of the store's employee responsible for managing the order. lastMessage: type: string nullable: true description: Last sent transactional message. hostname: type: string description: Account Hostname registered in License Manager. invoiceData: type: object description: Information pertinent to the order's invoice. nullable: true changesAttachment: $ref: '#/components/schemas/ChangesAttachment' openTextField: type: string description: "Optional field with order's additional information. This field must be filled in using the following format: \n\r```\n\r{\r\n \"fieldExample\": \"ValueExample\"\r\n }\n\r```\n\r." nullable: true roundingError: type: integer description: Rounding error total amount, if it applies. For example, in orders with a discount over non-integer multiplier items, the rounding price is performed per item, not after the sum of all items. That can cause a difference in the total discount amount, which is informed in this field. orderFormId: type: string description: '[Order form](https://developers.vtex.com/docs/guides/orderform-fields) ID.' commercialConditionData: type: string nullable: true description: Information about commercial conditions. isCompleted: type: boolean description: When set as `true`, the order's payment has been settled, and when set as `false`, it has not been settled yet. customData: type: string nullable: true description: Custom information in the order. 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. storePreferencesData: $ref: '#/components/schemas/StorePreferencesData' allowCancellation: type: boolean description: When set as `true`, the order can be canceled, and when set as `false`, it is no longer possible to cancel the order. allowEdition: type: boolean description: When set as `true`, the order can be edited, and when set as `false`, it is no longer possible to edit the order. isCheckedIn: type: boolean description: This field is set `true` when the order was made via inStore and `false` when it was not. marketplace: $ref: '#/components/schemas/Marketplace' authorizedDate: type: string description: Authorized order date. invoicedDate: type: string nullable: true description: Order's invoice date. cancelReason: type: string description: Reason for order cancellation. nullable: true itemMetadata: type: object description: Metadata information about the order's items. required: - Items properties: Items: type: array description: Metadata items. items: type: object required: - Id - Seller - Name - SkuName - ProductId - RefId - Ean - ImageUrl - DetailUrl - AssemblyOptions properties: Id: type: string description: Item's SKU ID, which is a unique numerical identifier. Seller: type: string description: Seller ID that identifies the seller the item belongs to. 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: Item's reference ID. Ean: type: string description: EAN of the item. ImageUrl: type: string description: Item's SKU image URL. DetailUrl: type: string description: URL slug of the item. AssemblyOptions: type: array description: Displays information about [assembly options](https://help.vtex.com/en/tutorial/assembly-options--5x5FhNr4f5RUGDEGWzV1nH) related to the item, if there are any. items: required: - Id - Name - Required - InputValues - Composition type: object properties: Id: type: string description: ID of the attachment related to the order. Name: type: string description: Name of the attachment related to the order. 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: Displays the attachment's content. nullable: true Composition: type: object description: Displays the attachment's composition. nullable: true subscriptionData: type: object description: Information about [subscriptions](https://help.vtex.com/tutorial/how-subscriptions-work--frequentlyAskedQuestions_4453). nullable: true required: - SubscriptionGroupId - Subscriptions properties: SubscriptionGroupId: type: string description: ID of the subscription's group. If this field returns `null` and the `executionCount` is `0`, the order is the first one with subscriptions. Subscriptions: type: array description: List with subscriptions and their details. nullable: true items: type: object required: - ExecutionCount - PriceAtSubscriptionDate - ItemIndex - Plan 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: Price of the order when the customer signed up for subscriptions. Subscriptions created from Admin UI 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. deprecated: true ItemIndex: type: integer description: Each item in the subscriptions' 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's validility and frequency. required: - type - frequency - validity properties: type: type: string description: Type of plan. frequency: type: object description: Information about subscriptions' recurrence. required: - periodicity - interval properties: periodicity: type: string description: Defines the subscriptions recurrence period. The possible values are `DAILY`,`WEEKLY`, `MONTHLY` and `YEARLY`. interval: type: integer description: Number of the time interval configured between subscription orders, which depends on the periodicity. For a `DAILY` periodicity, the field's value will correspond to days, for `MONTHLY` to months, and so on. validity: type: object description: Information about the period during which the subscription will be valid. required: - begin - end properties: begin: type: string description: Subscriptions' beginning date with the format `yyyy-mm-ddThh:mm:ss`. end: type: string description: Subscriptions' ending date with the format `yyyy-mm-ddThh:mm:ss`. taxData: type: object description: Order's tax information. required: - areTaxesDesignatedByMarketplace - taxInfoCollection properties: areTaxesDesignatedByMarketplace: type: boolean description: If the taxes were designated by the marketplace (`true`) or not (`false`). taxInfoCollection: type: array description: Array with taxes' details. items: type: object required: - itemIndex - sku - priceTags properties: itemIndex: type: integer description: Item's indexing number. sku: type: string description: Alphanumeric sequence that identifies an SKU. priceTags: type: array description: Price tag information. items: type: object required: - isPercentual - name - rawValue properties: isPercentual: type: boolean description: If the tax is a percentage (`true`) or note (`false`). name: type: string description: Name that identifies the tax. rawValue: type: string description: The amount that corresponds to the tax. checkedInPickupPointId: type: string description: If the field `isCheckedIn` is set as `true`, the `checkedInPickupPointId` will retrieve the ID of the physical store where the order was made. cancellationData: type: object description: Information about order cancellation, when it applies. required: - RequestedByUser - RequestedBySystem - RequestedBySellerNotification - RequestedByPaymentNotification - Reason - CancellationDate properties: RequestedByUser: type: boolean description: If the order cancellation was requested by the costumer (`true`) or not (`false`). RequestedBySystem: type: boolean description: 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. RequestedBySellerNotification: type: boolean description: If the order cancellation was requested by the seller (`true`) or not (`false`). RequestedByPaymentNotification: type: boolean description: If the order cancellation was requested by the payment gateway (`true`) or not (`false`). Reason: type: string description: The reason why the order was cancelled. CancellationDate: type: string description: The date when the order was cancelled. clientPreferencesData: type: object description: Information about customer's preferences. required: - locale - optinNewsLetter properties: locale: type: string description: Customer's prefered language while accessing the store. optinNewsLetter: type: boolean description: When set as `true`, this field indicates customers opted to receive the newsletters, and when set as `false`, it means they did not. example: orderId: v502556llux-01 sequence: '502556' marketplaceOrderId: '' marketplaceServicesEndpoint: http://oms.vtexinternal.com.br/api/oms?an=luxstore sellerOrderId: 00-v502556llux-01 origin: Marketplace affiliateId: '' salesChannel: '1' merchantName: luxstore status: handling statusDescription: Preparando Entrega value: 1160 creationDate: '2019-01-28T20:09:43.899958+00:00' lastChange: '2019-02-06T20:46:11.7010747+00:00' orderGroup: v502556lspt totals: - id: Items name: Total dos Itens value: 3290 - id: Discounts name: Total dos Descontos value: 0 - id: Shipping name: Total do Frete value: 1160 - id: Tax name: Total da Taxa value: 0 - id: Change name: Total das mudanças value: -3290 items: - uniqueId: 87F0945396994B349158C7D9C9941442 id: '1234568358' productId: '9429485' ean: null lockId: 00-v502556llux-01 itemAttachment: content: {} name: null attachments: [] quantity: 1 seller: '1' name: Bay Max L refId: BIGHEROBML price: 3290 listPrice: 3290 manualPrice: null priceTags: [] imageUrl: http://luxstore.vteximg.com.br/arquivos/ids/159263-55-55/image-cc1aed75cbfa424a85a94900be3eacec.jpg?v=636795432619830000 detailUrl: /bay-max-9429485/p components: [] bundleItems: [] params: [] offerings: [] attachmentOfferings: - name: vtex.subscription.weekly required: false schema: vtex.subscription.key.frequency: MaximumNumberOfCharacters: 7 Domain: - ' 1 week' - ' 2 week' - ' 3 week' - ' 4 week' sellerSku: '1234568358' priceValidUntil: null commission: 0 tax: 0 preSaleDate: null additionalInfo: brandName: VTEX brandId: '2000023' categoriesIds: /1/ productClusterId: 135,142 commercialConditionId: '5' dimension: cubicweight: 0.7031 height: 15 length: 15 weight: 15 width: 15 offeringInfo: null offeringType: null offeringTypeId: null measurementUnit: un unitMultiplier: 1 sellingPrice: 3290 isGift: false shippingPrice: null rewardValue: 0 freightCommission: 0 priceDefinitions: sellingPrices: - value: 99 quantity: 1 calculatedSellingPrice: 99 total: 99 taxCode: null parentItemIndex: null parentAssemblyBinding: null callCenterOperator: callCenterOp5473869 serialNumbers: '3' assemblies: [] costPrice: 52 marketplaceItems: [] clientProfileData: id: clientProfileData email: rodrigo.cunha@vtex.com.br firstName: Rodrigo lastName: Cunha documentType: cpf document: '11047867702' phone: '+5521972321094' corporateName: null tradeName: null corporateDocument: null stateInscription: null corporatePhone: null isCorporate: false userProfileId: 5a3692de-358a-4bea-8885-044bce33bb93 customerClass: null giftRegistryData: null marketingData: id: marketingData utmSource: fb utmPartner: utm partner utmMedium: utm medium utmCampaign: christmas coupon: sale utmiCampaign: ' ' utmipage: ' ' utmiPart: ' ' marketingTags: - vtex-subscription ratesAndBenefitsData: id: ratesAndBenefitsData rateAndBenefitsIdentifiers: [] shippingData: id: shippingData address: addressType: residential receiverName: Rodrigo Cunha addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA street: Praia de Botafogo number: '518' neighborhood: Botafogo complement: '10' reference: null geoCoordinates: [] logisticsInfo: - itemIndex: 0 selectedSla: Normal lockTTL: 10d price: 1160 listPrice: 1160 sellingPrice: 1160 deliveryWindow: null deliveryCompany: Todos os CEPS shippingEstimate: 5bd shippingEstimateDate: '2019-02-04T20:33:46.4595004+00:00' slas: - id: Normal name: Normal shippingEstimate: 5bd deliveryWindow: null price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: region13 lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 0d pickupDistance: 29.861602783203125 - id: Expressa name: Expressa shippingEstimate: 5bd deliveryWindow: null price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: region13 lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 0d pickupDistance: 29.861602783203125 - id: Quebra Kit name: Quebra Kit shippingEstimate: 2bd deliveryWindow: null price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: region13 lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 0d pickupDistance: 29.861602783203125 - id: Sob Encomenda name: Sob Encomenda shippingEstimate: 32bd deliveryWindow: null price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: region13 lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 0d pickupDistance: 29.861602783203125 shipsTo: - BRA deliveryIds: - courierId: 197a56f courierName: Todos os CEPS dockId: '1' quantity: 1 warehouseId: '1_1' accountCarrierName: recorrenciaqa kitItemDetails: [] deliveryChannels: - id: delivery stockBalance: 0 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad polygonName: region56 pickupPointId: 1_VTEX-RJ transitTime: 3d trackingHints: null selectedAddresses: - addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad addressType: residential receiverName: Rodrigo Cunha street: Praia de Botafogo number: '518' complement: '10' neighborhood: Botafogo postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA reference: null geoCoordinates: [] paymentData: transactions: - isActive: true transactionId: 418213DE29634837A63DD693A937A696 merchantName: luxstore payments: - id: D3DEECAB3C6C4B9EAF8EF4C1FE062FF3 paymentSystem: '6' paymentSystemName: Boleto Bancário value: 4450 installments: 1 referenceValue: 4450 cardHolder: null cardNumber: null firstDigits: null lastDigits: null cvv2: null expireMonth: null expireYear: null url: https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment} giftCardId: null giftCardName: null giftCardCaption: null redemptionCode: null group: bankInvoice tid: null dueDate: '2019-02-02' connectorResponses: Tid: '94857956' ReturnCode: '200' Message: logMessage authId: '857956' giftCardProvider: presentCard giftCardAsDiscount: false koinUrl: koinURL accountId: 5BC5C6B417FE432AB971B1D399F190C9 parentAccountId: 5BC5C6B417FE432AB971B1D399F190C9 bankIssuedInvoiceIdentificationNumber: '23797770100000019003099260100022107500729050' bankIssuedInvoiceIdentificationNumberFormatted: 32534.95739 75945.24534 54395.734214 5 bankIssuedInvoiceBarCodeNumber: '325349573975945245345439573421443986734065' bankIssuedInvoiceBarCodeType: i25 billingAddress: {} packageAttachment: packages: [] sellers: - id: '1' name: Lux Store logo: https://sellersLogo/images.png fulfillmentEndpoint: http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=accountName callCenterOperatorData: null followUpEmail: 7bf3a59bbc56402c810bda9521ba449e@ct.vtex.com.br lastMessage: null hostname: luxstore invoiceData: null changesAttachment: id: changeAttachment changesData: - reason: Blah 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 openTextField: null roundingError: 0 orderFormId: caae7471333e403f959fa5fd66951340 commercialConditionData: null isCompleted: true customData: null storePreferencesData: countryCode: BRA currencyCode: BRL currencyFormatInfo: CurrencyDecimalDigits: 2 CurrencyDecimalSeparator: ',' CurrencyGroupSeparator: . CurrencyGroupSize: 3 StartsWithCurrencySymbol: true currencyLocale: 1046 currencySymbol: R$ timeZone: E. South America Standard Time allowCancellation: true allowEdition: false isCheckedIn: false marketplace: baseURL: http://oms.vtexinternal.com.br/api/oms?an=luxstore isCertified: null name: luxstore authorizedDate: '2019-01-28T20:33:04+00:00' invoicedDate: null cancelReason: The size was too big. 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: {} subscriptionData: SubscriptionGroupId: A64AC73C0FB8693A7ADB4AC69CA4FD5F Subscriptions: - ExecutionCount: 724 PriceAtSubscriptionDate: 100 ItemIndex: 0 Plan: type: RECURRING_PAYMENT frequency: periodicity: DAILY interval: 1 validity: begin: '2022-01-10T00:00:00.0000000+00:00' end: '2024-02-03T00:00:00.0000000+00:00' taxData: areTaxesDesignatedByMarketplace: true taxInfoCollection: - itemIndex: 0 sku: COLOCAR_O_SKUID priceTags: - isPercentual: false name: Taxes (Magazine Luisa) rawValue: COLOCAR_O_VALOR_SEM_DECIMAL checkedInPickupPointId: storeNameExample_901 cancellationData: RequestedByUser: true RequestedBySystem: false RequestedBySellerNotification: false RequestedByPaymentNotification: false Reason: Item was too big in the client. CancellationDate: 2022-10--05T15:40:33 clientPreferencesData: locale: en-US optinNewsLetter: false Item: title: Item required: - uniqueId - id - productId - ean - lockId - itemAttachment - attachments - quantity - seller - name - refId - price - listPrice - manualPrice - priceTags - imageUrl - detailUrl - components - bundleItems - params - offerings - attachmentOfferings - sellerSku - priceValidUntil - commission - tax - preSaleDate - additionalInfo - measurementUnit - unitMultiplier - sellingPrice - isGift - shippingPrice - rewardValue - freightCommission - priceDefinitions - taxCode - parentItemIndex - parentAssemblyBinding - callCenterOperator - serialNumbers - assemblies - costPrice type: object properties: uniqueId: type: string description: Unique ID is an alphanumeric sequence that identifies an SKU in a given order. id: type: string description: Item's SKU ID, which is a unique numerical 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: $ref: '#/components/schemas/ItemAttachment' attachments: type: array items: type: string 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. manualPrice: type: string nullable: true description: Item's manual price. priceTags: type: array items: type: string description: List of objects with item's price modifiers. imageUrl: type: string description: Item's SKU image URL. detailUrl: type: string description: URL slug of the item. components: type: array items: type: string description: Item's components. bundleItems: type: array items: type: string description: Information on services sold along with the item's SKU. For example, a gift package. params: type: array items: type: string description: Information about params. offerings: type: array items: type: string description: Name of the service related to the item. For example, guarantee or installation. description: Item's offerings, which are services related to the item. For example, guarantee or installation. attachmentOfferings: type: array description: List of attachments details. nullable: true items: type: object required: - name - required - schema properties: name: type: string description: Name of the attachment. nullable: true required: type: boolean description: 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: $ref: '#/components/schemas/AdditionalInfo' 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. required: - sellingPrices - calculatedSellingPrice - total properties: sellingPrices: type: array items: required: - value - quantity properties: value: type: integer description: Total value of items in cents. quantity: type: integer description: Quantity of items. description: Details on item's selling price. 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: string nullable: true description: Parent item index. parentAssemblyBinding: type: string nullable: true description: Parent assembly binding. callCenterOperator: type: string description: 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: Retrieves information about orders item's customizations. nullable: true items: type: string costPrice: type: integer description: Item's cost price. example: uniqueId: 87F0945396994B349158C7D9C9941442 id: '1234568358' productId: '9429485' ean: null lockId: 00-v5195004lux-01 itemAttachment: content: {} name: null attachments: [] quantity: 1 seller: '1' name: Bay Max L refId: BIGHEROBML price: 3290 listPrice: 3290 manualPrice: null priceTags: [] imageUrl: http://luxstore.vteximg.com.br/arquivos/ids/159263-55-55/image-cc1aed75cbfa424a85a94900be3eacec.jpg?v=636795432619830000 detailUrl: /bay-max-9429485/p components: [] bundleItems: [] params: [] offerings: [] attachmentOfferings: - name: vtex.subscription.weekly required: false schema: vtex.subscription.key.frequency: MaximumNumberOfCharacters: 7 Domain: - ' 1 week' - ' 2 week' - ' 3 week' - ' 4 week' - name: vtex.subscription.daily required: false schema: vtex.subscription.key.frequency: MaximumNumberOfCharacters: 5 Domain: - 1 day sellerSku: '1234568358' priceValidUntil: null commission: 0 tax: 0 preSaleDate: null additionalInfo: brandName: VTEX brandId: '2000023' categoriesIds: /1/ productClusterId: 135,142 commercialConditionId: '5' dimension: cubicweight: 0.7031 height: 15 length: 15 weight: 15 width: 15 offeringInfo: null offeringType: null offeringTypeId: null measurementUnit: un unitMultiplier: 1 sellingPrice: 3290 isGift: false shippingPrice: null rewardValue: 0 freightCommission: 0 priceDefinitions: sellingPrices: - value: 99 quantity: 1 calculatedSellingPrice: 99 total: 99 taxCode: null parentItemIndex: null parentAssemblyBinding: null callCenterOperator: callCenterOp5473869 serialNumbers: '3' assemblies: [] costPrice: 52 TotalValue1: title: TotalValue1 required: - Count - Max - Mean - Min - Missing - StdDev - Sum - SumOfSquares - Facets type: object properties: Count: type: integer Max: type: integer Mean: type: integer Min: type: integer Missing: type: integer StdDev: type: integer Sum: type: integer SumOfSquares: type: integer Facets: type: object example: Count: 19 Max: 0 Mean: 0 Min: 0 Missing: 0 StdDev: 0 Sum: 0 SumOfSquares: 0 Facets: {} RatesAndBenefitsData: title: RatesAndBenefitsData description: Information on promotions and taxes that apply to the order. required: - id - rateAndBenefitsIdentifiers type: object properties: id: type: string description: ID of the rate or benefit. rateAndBenefitsIdentifiers: type: array items: type: string description: Information about order's promotions and taxes identifiers. example: id: ratesAndBenefitsData rateAndBenefitsIdentifiers: [] Marketplace: title: Marketplace description: Details about the marketplace related to the order. required: - baseURL - isCertified - name type: object properties: baseURL: type: string description: Marketplace base URL. isCertified: type: string nullable: true description: If is a certified marketplace. name: type: string description: Name of the marketplace. example: baseURL: http://oms.vtexinternal.com.br/api/oms?an=luxstore isCertified: null name: luxstore Stats2: title: Stats2 required: - stats type: object properties: stats: $ref: '#/components/schemas/Stats3' example: stats: totalValue: Count: 19 Max: 0 Mean: 0 Min: 0 Missing: 0 StdDev: 0 Sum: 0 SumOfSquares: 0 Facets: {} totalItems: Count: 19 Max: 0 Mean: 0 Min: 0 Missing: 0 StdDev: 0 Sum: 0 SumOfSquares: 0 Facets: {} TotalItems1: title: TotalItems1 required: - Count - Max - Mean - Min - Missing - StdDev - Sum - SumOfSquares - Facets type: object properties: Count: type: integer Max: type: integer Mean: type: integer Min: type: integer Missing: type: integer StdDev: type: integer Sum: type: integer SumOfSquares: type: integer Facets: type: object example: Count: 19 Max: 0 Mean: 0 Min: 0 Missing: 0 StdDev: 0 Sum: 0 SumOfSquares: 0 Facets: {} Paging: title: Paging required: - total - pages - currentPage - perPage type: object properties: total: type: integer pages: type: integer currentPage: type: integer perPage: type: integer example: total: 84 pages: 6 currentPage: 1 perPage: 15 PackageAttachment: title: PackageAttachment description: Package object populated after order invoiced. required: - packages type: object properties: packages: type: array items: type: string description: Packages details. example: packages: [] Address: title: Address description: Shipping address details. required: - addressType - receiverName - addressId - versionId - entityId - postalCode - city - state - country - street - number - neighborhood - complement - reference - geoCoordinates type: object properties: addressType: type: string description: Type of address. For example, `Residential` or `Pickup`, among others. receiverName: type: string description: Name of the person who is going to receive the order. 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: Postal code of the shipping address. city: type: string description: City of the shipping address. state: type: string description: State of the shipping address. country: type: string description: Three letters ISO code of the country of the shipping address (ISO 3166 ALPHA-3). street: type: string description: Street of the shipping address. number: type: string description: Number of the building, house or apartment in the shipping address. neighborhood: type: string description: Neighborhood of the shipping address. complement: type: string description: Complement to the shipping address when it applies. reference: type: string nullable: true description: Complement to help locate the shipping address, in case of delivery. geoCoordinates: type: array items: type: number description: Array with two numbers with geocoordinates, first longitude then latitude. example: addressType: residential receiverName: Rodrigo Cunha addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA street: Praia de Botafogo number: '300' neighborhood: Botafogo complement: '3' reference: null geoCoordinates: [] Userorderslist: title: Userorderslist required: - list - facets - paging - stats type: object description: Order list object. properties: list: type: array items: $ref: '#/components/schemas/List1' description: List with user's orders details. facets: type: array items: type: string description: Array containing facets information. paging: $ref: '#/components/schemas/Paging' stats: $ref: '#/components/schemas/Stats2' example: list: - orderId: v502556llux-01 creationDate: '2019-01-28T20:09:43+00:00' clientName: Cunha VTEX items: null totalValue: 1160 paymentNames: Boleto Bancário status: handling statusDescription: Preparando Entrega marketPlaceOrderId: null sequence: '502556' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store Seu pedido foi alterado! Pedido realizado em: 28/01/2019 Olá, Rodrigo. Seu pedido foi alterado. Seguem informações abaixo: ' ShippingEstimatedDate: '2019-02-04T20:33:46+00:00' ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: '2019-01-28T20:33:04+00:00' callCenterOperatorName: null totalItems: 1 currencyCode: BRL - orderId: v502449llux-02 creationDate: '2018-08-28T17:42:40+00:00' clientName: Cunha VTEX items: null totalValue: 118588 paymentNames: Promissory status: canceled statusDescription: Cancelado marketPlaceOrderId: null sequence: '502452' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: ' Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502449llux-02 Resumo Itens R$ 1.178,98 Entrega R$ 6,90 Total R$ 1.185,88' ShippingEstimatedDate: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 12 currencyCode: BRL - orderId: v502449llux-01 creationDate: '2018-08-28T17:42:28.9171556+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Mangueira Reservatório Ao Cavalete ean: null refId: TE3121110 id: '195' productId: '134' sellingPrice: 7390 price: 7390 - seller: '1' quantity: 1 description: Mangueira Filtro ean: null refId: XC459N610CA id: '238' productId: '162' sellingPrice: 5190 price: 5190 totalValue: 21526180 paymentNames: null status: canceled statusDescription: Cancelado marketPlaceOrderId: '' sequence: '502449' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 0 currencyCode: null - orderId: v502058llux-01 creationDate: '2017-07-25T23:17:36.7963248+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Aquecedor Britania 1500 Branco ean: '1235567890143' refId: branquinho id: '1234568212' productId: '1000200' sellingPrice: 35599 price: 35599 totalValue: 35599 paymentNames: null status: invoiced statusDescription: Faturado marketPlaceOrderId: '' sequence: '502058' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: '2017-07-29T19:24:20.7444363+00:00' ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 0 currencyCode: null - orderId: v501538llux-01 creationDate: '2017-06-26T16:57:58.9986524+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Boneco do Mário ean: bonecomario refId: bonecomario id: '1234568183' productId: '1000257' sellingPrice: 150363 price: 150363 - seller: '1' quantity: 1 description: Camiseta GG ean: null refId: abc1234 id: '1234567894' productId: '1000187' sellingPrice: 899 price: 899 totalValue: 151262 paymentNames: null status: invoiced statusDescription: Faturado marketPlaceOrderId: '' sequence: '501538' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: '2017-06-27T13:59:49.7705236+00:00' ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 0 currencyCode: null - orderId: v501020llux-01 creationDate: '2016-11-21T19:57:54.0415289+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 2 description: Camiseta GG ean: null refId: abc1234 id: '1234567894' productId: '1000187' sellingPrice: 899 price: 899 totalValue: 3190 paymentNames: null status: canceled statusDescription: Cancelado marketPlaceOrderId: '' sequence: '501020' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: '2016-12-02T08:00:00+00:00' ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 0 currencyCode: null - orderId: v500973llux-01 creationDate: '2016-10-10T17:19:30.8562035+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: SMARTPHONE SAMSUNG GALAXY S7 FLAT SM-G930FZDLZTO 32GB DOURADO TELA 5.1" 4G CÂMERA 12 MP ean: null refId: testefnac id: '1234568028' productId: '1000203' sellingPrice: 299000 price: 299000 totalValue: 299900 paymentNames: null status: handling statusDescription: Preparando Entrega marketPlaceOrderId: '' sequence: '500973' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: '2016-10-10T14:23:17.1897068+00:00' ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 0 currencyCode: null - orderId: v500970llux-01 creationDate: '2016-10-10T17:07:59.0889392+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Camiseta GG ean: null refId: abc1234 id: '1234567894' productId: '1000187' sellingPrice: 899 price: 899 totalValue: 1799 paymentNames: null status: invoiced statusDescription: Faturado marketPlaceOrderId: '' sequence: '500970' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: '2016-10-10T14:13:34.4927265+00:00' ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 0 currencyCode: null - orderId: v500890llux-01 creationDate: '2016-08-17T18:35:04.8659804+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Botin Futbol Adidas 11Questra Fg Cesped Hombre Absolut - M ean: absolutm refId: null id: '549' productId: '9' sellingPrice: 1000 price: 1000 totalValue: 1000 paymentNames: null status: canceled statusDescription: Cancelado marketPlaceOrderId: '' sequence: '500890' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 0 currencyCode: null - orderId: v500838llux-01 creationDate: '2016-07-29T00:20:47.7736718+00:00' clientName: Cunha VTEX items: - seller: '1' quantity: 1 description: Rooibos Lavanda - Pouch - 50gr ean: '198' refId: '10098' id: '98' productId: '1000025' sellingPrice: 5200 price: 5200 totalValue: 6200 paymentNames: null status: canceled statusDescription: Cancelado marketPlaceOrderId: '' sequence: '500838' salesChannel: '1' affiliateId: '' origin: Marketplace workflowInErrorState: false workflowInRetry: false lastMessageUnread: null ShippingEstimatedDate: null ShippingEstimatedDateMax: null ShippingEstimatedDateMin: null orderIsComplete: true listId: null listType: null authorizedDate: null callCenterOperatorName: null totalItems: 0 currencyCode: null facets: [] paging: total: 19 pages: 10 currentPage: 1 perPage: 2 stats: stats: totalValue: Count: 19 Max: 0 Mean: 0 Min: 0 Missing: 0 StdDev: 0 Sum: 0 SumOfSquares: 0 Facets: {} totalItems: Count: 19 Max: 0 Mean: 0 Min: 0 Missing: 0 StdDev: 0 Sum: 0 SumOfSquares: 0 Facets: {} ItemAttachment: title: ItemAttachment description: Information about attachments, if it applies. required: - content - name type: object properties: content: type: object description: Attachment's custom field for content. name: type: string nullable: true description: Attachment's name. example: content: {} name: null PickupStoreInfo: title: PickupStoreInfo description: Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R). required: - additionalInfo - address - dockId - friendlyName - isPickupStore type: object 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: If this field is set `true`, it means the type of shipping is pickup, and if set as `false`, it is not. example: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false Receipt: title: Receipt description: Information about the receipt for changed orders. required: - date - orderId - receipt type: object properties: date: type: string description: Date when the receipt was created. orderId: type: string description: ID of the order. receipt: type: string description: Receipt's unique identifier code. example: date: '2019-02-06T20:46:04.4003606+00:00' orderId: v5195004lux-01 receipt: 029f9ab8-751a-4b1e-bf81-7dd25d14b49b PaymentData: title: PaymentData description: Object with information about the payment. required: - transactions type: object properties: giftCards: type: array description: Array with information about Gift Cards. items: type: string transactions: type: array items: $ref: '#/components/schemas/Transaction' description: Information about financial transactions. example: giftCards: [] transactions: - isActive: true transactionId: 418213DE29634837A63DD693A937A696 merchantName: luxstore payments: - id: D3DEECAB3C6C4B9EAF8EF4C1FE062FF3 paymentSystem: '6' paymentSystemName: Boleto Bancário value: 4450 installments: 1 referenceValue: 4450 cardHolder: null cardNumber: null firstDigits: null lastDigits: null cvv2: null expireMonth: null expireYear: null url: https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment} giftCardId: null giftCardName: null giftCardCaption: null redemptionCode: null group: bankInvoice tid: null dueDate: '2019-02-02' connectorResponses: Tid: '94857956' ReturnCode: '200' Message: logMessage authId: '857956' giftCardProvider: presentCard giftCardAsDiscount: false koinUrl: koinURL accountId: 5BC5C6B417FE432AB971B1D399F190C9 parentAccountId: 5BC5C6B417FE432AB971B1D399F190C9 bankIssuedInvoiceIdentificationNumber: '23797770100000019003099260100022107500729050' bankIssuedInvoiceIdentificationNumberFormatted: 32534.95739 75945.24534 54395.734214 5 bankIssuedInvoiceBarCodeNumber: '325349573975945245345439573421443986734065' bankIssuedInvoiceBarCodeType: i25 billingAddress: {} Seller: title: Seller description: Information about the seller associated with the order. required: - id - name - logo - fulfillmentEndpoint type: object properties: id: type: string description: Seller ID that identifies the seller. name: type: string description: Seller's name. logo: type: string description: URL of the seller's logo. fulfillmentEndpoint: type: string description: URL of the endpoint for fulfillment of seller's orders. example: id: '1' name: Loja do Suporte logo: https://sellersLogo/images.png fulfillmentEndpoint: http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=accountName Total: title: Total required: - id - name - value type: object properties: id: type: string description: Code that identifies if the information is about `Items`, `Discounts`, `Shipping`, `Tax` or `Change`. name: type: string description: Name of `Items`, `Discounts`, `Shipping`, `Tax` or `Change`. value: type: integer description: Total amount of `Items`, `Discounts`, `Shipping`, `Tax` or `Change`. example: id: Items name: Total dos Itens value: 3290 DeliveryId: title: DeliveryId description: Information about delivery IDs. required: - courierId - courierName - dockId - quantity - warehouseId - accountCarrierName - kitItemDetails type: object properties: courierId: type: string description: '[Carrier](https://help.vtex.com/en/tutorial/transportadoras-na-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 example: courierId: 197a56f courierName: Todos os CEPS dockId: '1' quantity: 1 warehouseId: '1_1' accountCarrierName: recorrenciaqa kitItemDetails: [] StorePreferencesData: title: StorePreferencesData description: Object with data from the store's configuration - stored in VTEX's License Manager. required: - countryCode - currencyCode - currencyFormatInfo - currencyLocale - currencySymbol - timeZone type: object properties: countryCode: type: string description: Three letters ISO code of the country (ISO 3166 ALPHA-3). currencyCode: type: string description: Currency code in ISO 4217. For example, `BRL`. currencyFormatInfo: $ref: '#/components/schemas/CurrencyFormatInfo' currencyLocale: type: integer description: Currency Locale Code in LCID in decimal. currencySymbol: type: string description: Currency symbol. timeZone: type: string description: Time zone from where the order was made. example: countryCode: BRA currencyCode: BRL currencyFormatInfo: CurrencyDecimalDigits: 2 CurrencyDecimalSeparator: ',' CurrencyGroupSeparator: . CurrencyGroupSize: 3 StartsWithCurrencySymbol: true currencyLocale: 1046 currencySymbol: R$ timeZone: E. South America Standard Time Payment: title: Payment description: Payment details. required: - id - paymentSystem - paymentSystemName - value - installments - referenceValue - cardHolder - cardNumber - firstDigits - lastDigits - cvv2 - expireMonth - expireYear - url - giftCardId - giftCardName - giftCardCaption - redemptionCode - group - tid - dueDate - connectorResponses - giftCardProvider - giftCardAsDiscount - koinUrl - accountId - parentAccountId - bankIssuedInvoiceIdentificationNumber - bankIssuedInvoiceIdentificationNumberFormatted - bankIssuedInvoiceBarCodeNumber - bankIssuedInvoiceBarCodeType - billingAddress type: object properties: id: type: string description: VTEX payment ID that can be used as unique identifier. paymentSystem: type: string description: Payment system's ID. paymentSystemName: type: string description: Payment system's name. value: type: integer description: Payment's final amount in cents. installments: type: integer description: Number of payment installments. referenceValue: type: integer description: Payment's reference value in cents. cardHolder: type: string nullable: true description: Name of the person who owns the card. cardNumber: type: string nullable: true description: Numeric sequence of the card used in the transaction. firstDigits: type: string nullable: true description: Fist digits of the card used in the transaction. lastDigits: type: string nullable: true description: Last digits of the card used in the transaction. cvv2: type: string nullable: true description: Card Verification Value (CVV2) is a security code used by payment processors to reduce fraudulent credit and debit card transactions. expireMonth: type: string nullable: true description: Expire month of the card used in the transaction (2-digits). expireYear: type: string nullable: true description: Expire year of the card used in the transaction (4-digits). url: type: string description: Payment's URL. giftCardId: type: string nullable: true description: Gift Card's ID. giftCardName: type: string nullable: true description: Gift Card's name. giftCardCaption: type: string nullable: true description: Gift Card's caption. redemptionCode: type: string nullable: true description: Code for the customer to use the Gift Card. group: type: string description: Name of the collection the Gift Card belongs to. tid: type: string nullable: true description: Provider's unique identifier for the transaction. dueDate: type: string description: Payment due date, with the format `yyyy-mm-dd`. connectorResponses: type: object description: Information about the connector responses. required: - Tid - ReturnCode - Message - authId properties: Tid: type: string description: Provider's unique identifier for the transaction. ReturnCode: type: string description: Provider's operation/error code to be logged. Message: type: string description: Provider's operation/error message to be logged. authId: type: string description: Connector's authorization ID. giftCardProvider: type: string description: Gift Card provider's ID. giftCardAsDiscount: type: boolean description: When this field is set as `true`, the Gift Card is a discount over the price, and when set as `false`, it is not a discount. koinUrl: type: string description: Payment's account ID. accountId: type: string description: Payment's account ID. parentAccountId: type: string description: This field retrieves the main account if the payment was made in a subaccount. bankIssuedInvoiceIdentificationNumber: type: string description: Numeric sequence that identifies the bank issued invoice. bankIssuedInvoiceIdentificationNumberFormatted: type: string description: Bank issued invoice ID formatted. bankIssuedInvoiceBarCodeNumber: type: string description: Number of the bank issued invoice bar code. bankIssuedInvoiceBarCodeType: type: string description: Type of the bank issued invoice bar code. billingAddress: type: object description: Billing address information. example: id: D3DEECAB3C6C4B9EAF8EF4C1FE062FF3 paymentSystem: '6' paymentSystemName: Boleto Bancário value: 4450 installments: 1 referenceValue: 4450 cardHolder: null cardNumber: null firstDigits: null lastDigits: null cvv2: null expireMonth: null expireYear: null url: https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment} giftCardId: null giftCardName: null giftCardCaption: null redemptionCode: null group: bankInvoice tid: null dueDate: '2019-02-02' connectorResponses: Tid: '94857956' ReturnCode: '200' Message: logMessage authId: '857956' giftCardProvider: presentCard giftCardAsDiscount: false koinUrl: koinURL accountId: 5BC5C6B417FE432AB971B1D399F190C9 parentAccountId: 5BC5C6B417FE432AB971B1D399F190C9 bankIssuedInvoiceIdentificationNumber: '23797770100000019003099260100022107500729050' bankIssuedInvoiceIdentificationNumberFormatted: 32534.95739 75945.24534 54395.734214 5 bankIssuedInvoiceBarCodeNumber: '325349573975945245345439573421443986734065' bankIssuedInvoiceBarCodeType: i25 billingAddress: {} Item2: title: Item2 required: - seller - quantity - description - ean - refId - id - productId - sellingPrice - price type: object properties: seller: type: string description: Seller related to the order. quantity: type: integer description: Quantity of SKUs. description: type: string description: Description of items. ean: type: string nullable: true description: EAN of the SKU. refId: type: string nullable: true description: Item's reference ID. id: type: string description: Item's SKU ID, which is a unique numerical identifier. productId: type: string description: ID of the Product associated with the item. sellingPrice: type: integer description: Details on item's selling price. price: type: integer description: Item's price. example: seller: '1' quantity: 1 description: Mangueira Reservatório Ao Cavalete ean: null refId: TE3121110 id: '195' productId: '134' sellingPrice: 7390 price: 7390 CurrencyFormatInfo: title: CurrencyFormatInfo description: Object with currency format details. required: - CurrencyDecimalDigits - CurrencyDecimalSeparator - CurrencyGroupSeparator - CurrencyGroupSize - StartsWithCurrencySymbol type: object properties: CurrencyDecimalDigits: type: integer description: Quantity of currency decimal digits. CurrencyDecimalSeparator: type: string description: Defines what currency decimal separator will be applied. CurrencyGroupSeparator: type: string description: Defines what currency group separator will be applied. CurrencyGroupSize: type: integer description: Defines how many characters will be grouped. StartsWithCurrencySymbol: type: boolean description: Defines if all prices will be initiated with the currency symbol (`true`) or not (`false`). example: CurrencyDecimalDigits: 2 CurrencyDecimalSeparator: ',' CurrencyGroupSeparator: . CurrencyGroupSize: 3 StartsWithCurrencySymbol: true Stats3: title: Stats3 required: - totalValue - totalItems type: object properties: totalValue: $ref: '#/components/schemas/TotalValue1' totalItems: $ref: '#/components/schemas/TotalItems1' example: totalValue: Count: 19 Max: 0 Mean: 0 Min: 0 Missing: 0 StdDev: 0 Sum: 0 SumOfSquares: 0 Facets: {} totalItems: Count: 19 Max: 0 Mean: 0 Min: 0 Missing: 0 StdDev: 0 Sum: 0 SumOfSquares: 0 Facets: {} ChangesDatum: title: ChangesDatum required: - reason - discountValue - incrementValue - itemsAdded - itemsRemoved - receipt type: object properties: reason: type: string description: Text explaining why there was a change in the order. This information may be shown to the customer in the UI or transactional emails. discountValue: type: integer description: Order change discount value. incrementValue: type: integer description: Order change increment value. itemsAdded: type: array items: type: string description: List of items added to the order. itemsRemoved: type: array items: $ref: '#/components/schemas/ItemsRemoved' description: List of items removed from the order. receipt: $ref: '#/components/schemas/Receipt' example: reason: Blah 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: v5195004lux-01 receipt: 029f9ab8-751a-4b1e-bf81-7dd25d14b49b SelectedAddress: title: SelectedAddress required: - addressId - versionId - entityId - addressType - receiverName - street - number - complement - neighborhood - postalCode - city - state - country - reference - geoCoordinates type: object 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: 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 letters ISO code of the country of the selected address (ISO 3166 ALPHA-3). reference: type: string nullable: true description: Complement to help locate the selected address. geoCoordinates: type: array items: type: number description: Array with two numbers with the selected address's geocoordinates, first longitude then latitude. example: addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad addressType: residential receiverName: Rodrigo Cunha street: Praia de Botafogo number: '518' complement: '10' neighborhood: Botafogo postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA reference: null geoCoordinates: [] LogisticsInfo: title: LogisticsInfo required: - itemIndex - selectedSla - lockTTL - price - listPrice - sellingPrice - deliveryWindow - deliveryCompany - shippingEstimate - shippingEstimateDate - slas - shipsTo - deliveryIds - deliveryChannels - deliveryChannel - pickupStoreInfo - addressId - versionId - entityId - polygonName - pickupPointId - transitTime type: object 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: SKU's optional price for a specific trade policy. 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/transportadoras-na-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. It is defined only after the confirmation of the order. slas: type: array items: $ref: '#/components/schemas/Sla' description: Information on Service Level Agreement (SLA), corresponding to [shipping policies](https://help.vtex.com/tutorial/shipping-policy--tutorials_140). shipsTo: type: array items: type: string description: Three letters ISO code of the country of the shipping address (ISO 3166 ALPHA-3). deliveryIds: type: array items: $ref: '#/components/schemas/DeliveryId' description: Information about delivery IDs. deliveryChannels: type: array description: List of delivery channels associated with the trade policy. items: type: object required: - id - stockBalance 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. deliveryChannel: type: string description: If the delivery channel is `delivery` or `pickup-in-point`. pickupStoreInfo: $ref: '#/components/schemas/PickupStoreInfo' addressId: type: string description: Address ID. versionId: type: string description: Shipping address version ID. nullable: true entityId: type: string description: Shipping address entity ID. 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.' 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`. example: itemIndex: 0 selectedSla: Normal lockTTL: 10d price: 1160 listPrice: 1160 sellingPrice: 1160 deliveryWindow: null deliveryCompany: Todos os CEPS shippingEstimate: 5bd shippingEstimateDate: '2019-02-04T20:33:46.4595004+00:00' slas: - id: Normal name: Normal shippingEstimate: 5bd deliveryWindow: null price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: region196 lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 3d pickupDistance: 0 - id: Expressa name: Expressa shippingEstimate: 5bd deliveryWindow: null price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: region196 lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 3d pickupDistance: 0 - id: Quebra Kit name: Quebra Kit shippingEstimate: 2bd deliveryWindow: null price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: region196 lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 3d pickupDistance: 0 - id: Sob Encomenda name: Sob Encomenda shippingEstimate: 32bd deliveryWindow: null price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: region196 lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 3d pickupDistance: 0 shipsTo: - BRA deliveryIds: - courierId: 197a56f courierName: Todos os CEPS dockId: '1' quantity: 1 warehouseId: '1_1' accountCarrierName: recorrenciaqa kitItemDetails: [] deliveryChannels: - id: delivery stockBalance: 0 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad polygonName: null pickupPointId: 1_VTEX-RJ transitTime: 3d Sla: title: Sla required: - id - name - shippingEstimate - deliveryWindow - price - deliveryChannel - pickupStoreInfo - polygonName - lockTTL - pickupPointId - transitTime - pickupDistance type: object 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. deliveryChannel: type: string description: If the delivery channel is `delivery` or `pickup-in-point`. pickupStoreInfo: $ref: '#/components/schemas/PickupStoreInfo' 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. example: id: Normal name: Normal shippingEstimate: 5bd deliveryWindow: null price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: null lockTTL: 12d pickupPointId: 1_VTEX-RJ transitTime: 3d pickupDistance: 0 Dimension: title: Dimension required: - cubicweight - height - length - weight - width type: object 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. example: cubicweight: 0.7031 height: 15 length: 15 weight: 15 width: 15 ClientProfileData: title: ClientProfileData description: Object with information on the client's profile. required: - id - email - firstName - lastName - documentType - document - phone - corporateName - tradeName - corporateDocument - stateInscription - corporatePhone - isCorporate - userProfileId - customerClass type: object properties: id: type: string description: Object ID, the expected value is `clientProfileData`. email: type: string description: Customer's email. 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 identification code informed by the customer. phone: type: string description: Customers's phone number. corporateName: type: string nullable: true description: If the customer is a legal entity, here goes the corporate name. tradeName: type: string nullable: true description: If the customer is a legal entity, here goes the trade name. corporateDocument: type: string nullable: true description: If the customer is a legal entity, here goes the corporate document. stateInscription: type: string nullable: true description: If the customer is a legal entity, here goes the state inscription. corporatePhone: type: string nullable: true description: If the customer is a legal entity, here goes the corpany's phone number. isCorporate: type: boolean description: The value is `true` when the customer is a legal entity and `false` when not. userProfileId: type: string description: Customer user profile ID. customerClass: type: string nullable: true description: Identification of the class the customer belongs to. example: id: clientProfileData email: rodrigo.cunha@vtex.com.br firstName: Rodrigo lastName: VTEX documentType: cpf document: '11047867702' phone: '+5521972321094' corporateName: null tradeName: null corporateDocument: null stateInscription: null corporatePhone: null isCorporate: false userProfileId: 5a3692de-358a-4bea-8885-044bce33bb93 customerClass: null ShippingData: title: ShippingData description: Object containing shipping data. required: - id - address - logisticsInfo - trackingHints - selectedAddresses type: object properties: id: type: string description: Object ID, the expected value is `shippingData`. address: $ref: '#/components/schemas/Address' logisticsInfo: type: array items: $ref: '#/components/schemas/LogisticsInfo' description: Array of objects containing item's logistics information. trackingHints: type: string nullable: true selectedAddresses: type: array items: $ref: '#/components/schemas/SelectedAddress' description: Information about selected adresses. example: id: shippingData address: addressType: residential receiverName: Rodrigo Cunha addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA street: Praia de Botafogo number: '300' neighborhood: Botafogo complement: '3' reference: null geoCoordinates: [] logisticsInfo: - itemIndex: 0 selectedSla: Normal lockTTL: 10d price: 1160 listPrice: 1160 sellingPrice: 1160 deliveryWindow: null deliveryCompany: Todos os CEPS shippingEstimate: 5bd shippingEstimateDate: '2019-02-04T20:33:46.4595004+00:00' slas: - id: Normal name: Normal shippingEstimate: 5bd deliveryWindow: null price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: '' lockTTL: 12d pickupPointId: store35 transitTime: 3d pickupDistance: 0 - id: Expressa name: Expressa shippingEstimate: 5bd deliveryWindow: null price: 1160 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: '' lockTTL: 12d pickupPointId: store45 transitTime: 3d pickupDistance: 0 - id: Quebra Kit name: Quebra Kit shippingEstimate: 2bd deliveryWindow: null price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: '' lockTTL: 12d pickupPointId: store45 transitTime: 3d pickupDistance: 0 - id: Sob Encomenda name: Sob Encomenda shippingEstimate: 32bd deliveryWindow: null price: 1392 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false polygonName: '' lockTTL: 12d pickupPointId: store46 transitTime: 3d pickupDistance: 0 shipsTo: - BRA deliveryIds: - courierId: 197a56f courierName: Todos os CEPS dockId: '1' quantity: 1 warehouseId: '1_1' accountCarrierName: recorrenciaqa kitItemDetails: [] deliveryChannels: - id: delivery stockBalance: 0 deliveryChannel: delivery pickupStoreInfo: additionalInfo: null address: null dockId: null friendlyName: null isPickupStore: false addressId: '4791759472332' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad polygonName: '' pickupPointId: store67 transitTime: 3d trackingHints: null selectedAddresses: - addressId: '-1425945657910' versionId: e9c3bec2-125d-4b96-a021-316c3aa9f14f entityId: eabfb564-99d6-40d8-bd6c-bddbd4990aad addressType: residential receiverName: Rodrigo Cunha street: Praia de Botafogo number: '518' complement: '10' neighborhood: Botafogo postalCode: 22250-040 city: Rio de Janeiro state: RJ country: BRA reference: null geoCoordinates: [] securitySchemes: VtexIdclientAutCookie: type: apiKey in: header name: VtexIdclientAutCookie description: '[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.'