{"files":{"SKILL.md":"---\nname: orders-api\ndescription: \"Orders API skill. Use when working with Orders for api. Covers 36 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# Orders API\nAPI version: 1.0\n\n## Auth\nApiKey X-VTEX-API-AppKey in header | ApiKey X-VTEX-API-AppToken in header | ApiKey VtexIdclientAutCookie in header\n\n## Base URL\nhttps://apiexamples.vtexcommercestable.com.br\n\n## Setup\n1. Set your API key in the appropriate header\n2. GET /api/oms/pvt/orders -- verify access\n3. POST /api/oms/pvt/orders/{orderId}/start-handling -- create first start-handling\n\n## Endpoints\n\n36 endpoints across 1 groups. See references/api-spec.lap for full details.\n\n### api\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /api/oms/pvt/orders/{orderId} | Get order |\n| GET | /api/oms/pvt/orders/order-group/{orderGroup} | Get orders by order group ID |\n| GET | /api/oms/pvt/orders | List orders |\n| POST | /api/oms/pvt/orders/{orderId}/start-handling | Start handling order |\n| POST | /api/oms/pvt/orders/{orderId}/cancel | Cancel order |\n| POST | /api/oms/pvt/orders/{orderId}/changes | Register modifications on order |\n| POST | /api/oms/pvt/orders/{orderId}/interactions | Add log in orders |\n| POST | /api/oms/pvt/orders/{orderId}/invoice | Order invoice notification |\n| PATCH | /api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber} | Update order's partial invoice (send tracking number) |\n| PUT | /api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber}/tracking | Update order tracking status |\n| GET | /api/oms/pvt/orders/{orderId}/conversation-message | Retrieve order conversation |\n| GET | /api/oms/pvt/orders/{orderId}/payment-transaction | Retrieve payment transaction |\n| POST | /api/oms/pvt/orders/{orderId}/payments/{paymentId}/payment-notification | Send payment notification |\n| GET | /api/oms/pvt/feed/orders/status | Get feed order status |\n| GET | /api/orders/feed/config | Get feed configuration |\n| POST | /api/orders/feed/config | Create or update feed configuration |\n| DELETE | /api/orders/feed/config | Delete feed configuration |\n| GET | /api/orders/feed | Retrieve feed items |\n| POST | /api/orders/feed | Commit feed items |\n| GET | /api/orders/hook/config | Get hook configuration |\n| POST | /api/orders/hook/config | Create or update hook configuration |\n| DELETE | /api/orders/hook/config | Delete hook configuration |\n| GET | /api/orders/pvt/document/{orderId}/change-summary | Get order modifications summary |\n| GET | /api/oms/user/orders | Retrieve user's orders |\n| GET | /api/oms/user/orders/{orderId} | Retrieve user order details |\n| POST | /api/orders/expressions/jsonata | Test JSONata expression |\n| GET | /api/checkout/pvt/configuration/window-to-change-seller | Get window to change seller |\n| POST | /api/checkout/pvt/configuration/window-to-change-seller | Update window to change seller |\n| PATCH | /api/order-system/orders/{changeOrderId}/changes | Create order modifications |\n| GET | /api/order-system/orders/{changeOrderId}/changes | Get order modifications history |\n| GET | /api/order-system/orders/{changeOrderId}/changes/{changeRequestId} | Get order modifications details |\n| POST | /api/order-system/orders/{changeOrderId}/changes/preview | Preview order modifications |\n| POST | /api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/retry | Retry order modifications |\n| POST | /api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/cancel | Cancel order modifications |\n| PUT | /api/order-system/orders/changes/settings | Update Order modifications settings |\n| GET | /api/order-system/orders/changes/settings | Get Order modifications settings |\n\n## Common Questions\n\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"Get order details?\" -> GET /api/oms/pvt/orders/{orderId}\n- \"Get order-group details?\" -> GET /api/oms/pvt/orders/order-group/{orderGroup}\n- \"Search orders?\" -> GET /api/oms/pvt/orders\n- \"Create a start-handling?\" -> POST /api/oms/pvt/orders/{orderId}/start-handling\n- \"Create a cancel?\" -> POST /api/oms/pvt/orders/{orderId}/cancel\n- \"Create a change?\" -> POST /api/oms/pvt/orders/{orderId}/changes\n- \"Create a interaction?\" -> POST /api/oms/pvt/orders/{orderId}/interactions\n- \"Create a invoice?\" -> POST /api/oms/pvt/orders/{orderId}/invoice\n- \"Partially update a invoice?\" -> PATCH /api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber}\n- \"List all conversation-message?\" -> GET /api/oms/pvt/orders/{orderId}/conversation-message\n- \"List all payment-transaction?\" -> GET /api/oms/pvt/orders/{orderId}/payment-transaction\n- \"Create a payment-notification?\" -> POST /api/oms/pvt/orders/{orderId}/payments/{paymentId}/payment-notification\n- \"List all status?\" -> GET /api/oms/pvt/feed/orders/status\n- \"List all config?\" -> GET /api/orders/feed/config\n- \"Create a config?\" -> POST /api/orders/feed/config\n- \"List all feed?\" -> GET /api/orders/feed\n- \"Create a feed?\" -> POST /api/orders/feed\n- \"List all config?\" -> GET /api/orders/hook/config\n- \"Create a config?\" -> POST /api/orders/hook/config\n- \"List all change-summary?\" -> GET /api/orders/pvt/document/{orderId}/change-summary\n- \"List all orders?\" -> GET /api/oms/user/orders\n- \"Get order details?\" -> GET /api/oms/user/orders/{orderId}\n- \"Create a jsonata?\" -> POST /api/orders/expressions/jsonata\n- \"List all window-to-change-seller?\" -> GET /api/checkout/pvt/configuration/window-to-change-seller\n- \"Create a window-to-change-seller?\" -> POST /api/checkout/pvt/configuration/window-to-change-seller\n- \"List all changes?\" -> GET /api/order-system/orders/{changeOrderId}/changes\n- \"Get change details?\" -> GET /api/order-system/orders/{changeOrderId}/changes/{changeRequestId}\n- \"Create a preview?\" -> POST /api/order-system/orders/{changeOrderId}/changes/preview\n- \"Create a retry?\" -> POST /api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/retry\n- \"Create a cancel?\" -> POST /api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/cancel\n- \"List all settings?\" -> GET /api/order-system/orders/changes/settings\n- \"How to authenticate?\" -> See Auth section\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- List endpoints may support pagination; check for limit, offset, or cursor params\n- Create/update endpoints typically return the created/updated object\n\n## CLI\n\n```bash\n# Update this spec to the latest version\nnpx @lap-platform/lapsh get orders-api -o references/api-spec.lap\n\n# Search for related APIs\nnpx @lap-platform/lapsh search orders-api\n```\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Orders API\n@base https://apiexamples.vtexcommercestable.com.br\n@version 1.0\n@auth ApiKey X-VTEX-API-AppKey in header | ApiKey X-VTEX-API-AppToken in header | ApiKey VtexIdclientAutCookie in header\n@common_fields {Accept: str=application/json # HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand., Content-Type: str=application/json # Type of the content being sent.}\n@endpoints 36\n@hint download_for_search\n@toc api(36)\n\n@endpoint GET /api/oms/pvt/orders/{orderId}\n@desc Get order\n@required {orderId: str # Order ID is a unique code that identifies an order. Instead of using `orderId`, you can also make the request using the sequence, a six-digit string that follows the order ID. For example, in order 1268540501456-01 (501456), the sequence is 501456. To use this parameter, replace the value between `{ }` keys in `seq{sequence-number}` with the sequence. For example: `seq501456`.}\n@returns(200) {orderId: str, sequence: str, marketplaceOrderId: str, marketplaceServicesEndpoint: str, sellerOrderId: str, origin: str, affiliateId: str, salesChannel: str, merchantName: str?, status: str, workflowIsInError: bool, statusDescription: str, value: int, creationDate: str, lastChange: str, orderGroup: str, followUpEmail: str, lastMessage: str?, hostname: str, isCompleted: bool, roundingError: int, orderFormId: str, allowCancellation: bool, allowEdition: bool, isCheckedIn: bool, authorizedDate: str?, invoicedDate: str?, cancelReason: str?, checkedInPickupPointId: str?, totals: [map], sellers: [map], clientPreferencesData: map{locale: str, optinNewsLetter: bool}, cancellationData: map?{RequestedByUser: bool?, RequestedBySystem: bool?, RequestedBySellerNotification: bool?, RequestedByPaymentNotification: bool?, Reason: str?, CancellationDate: str?}, taxData: map?{areTaxesDesignatedByMarketplace: bool, taxInfoCollection: [map]}, subscriptionData: map?{SubscriptionGroupId: str?, Subscriptions: [map]?}, itemMetadata: map{Items: [map]}, marketplace: map?{baseURL: str, isCertified: bool?, name: str}, storePreferencesData: map{countryCode: str, currencyCode: str, currencyFormatInfo: map{CurrencyDecimalDigits: int, CurrencyDecimalSeparator: str, CurrencyGroupSeparator: str, CurrencyGroupSize: int, StartsWithCurrencySymbol: bool}, currencyLocale: int, currencySymbol: str, timeZone: str}, customData: map?{customApps: [map]?, customFields: [map]}, commercialConditionData: str?, openTextField: map?, invoiceData: map?{address: map?{addressType: str?, receiverName: str?, addressId: str?, versionId: str?, entityId: str?, postalCode: str, city: str, state: str, country: str, street: str, number: str, neighborhood: str, complement: str?, reference: str?, geoCoordinates: [num], contactId: str?}, userPaymentInfo: map?{paymentMethods: [str]}, invoiceSubject: map?{id: str, email: str, firstName: str, lastName: str, phone: str}}, changesAttachment: map?{id: str, changesData: [map]}, callCenterOperatorData: map?{id: str, email: str, userName: str}, packageAttachment: map?{packages: [map]}, paymentData: map{giftCards: [map]?, transactions: [map]}, shippingData: map{id: str, address: map{addressType: str, receiverName: str, addressId: str, versionId: str?, entityId: str?, postalCode: str, city: str, state: str, country: str, street: str, number: str, neighborhood: str, complement: str, reference: str?, geoCoordinates: [num]}, logisticsInfo: [map], trackingHints: [map]?, selectedAddresses: [map], contactInformation: [map]}, ratesAndBenefitsData: map{id: str, rateAndBenefitsIdentifiers: [map]}, marketingData: map?{id: str, utmSource: str, utmPartner: str, utmMedium: str, utmCampaign: str, coupon: str, utmiCampaign: str, utmipage: str, utmiPart: str, marketingTags: [str]}, giftRegistryData: map?{giftRegistryId: str, giftRegistryType: str, giftRegistryTypeName: str, addressId: str, description: str}, clientProfileData: map{id: str, email: str, firstName: str, lastName: str, documentType: str, document: str, phone: str, corporateName: str?, tradeName: str?, corporateDocument: str?, stateInscription: str?, corporatePhone: str?, isCorporate: bool, userProfileId: str, userProfileVersion: str?, customerClass: str?, customerCode: str?}, items: [map], marketplaceItems: [str], authorizationPolicyData: [map]} # OK\n\n@endpoint GET /api/oms/pvt/orders/order-group/{orderGroup}\n@desc Get orders by order group ID\n@required {orderGroup: str # Order group ID is a part of the order ID that groups all orders related to the same purchase. For example, when an order is fullfilled by multiple sellers, each seller has its own order ID (`v71021570str-01` and `v71021570str-02`), but they share the same order group ID (`v71021570str`).}\n@returns(200) OK\n\n@endpoint GET /api/oms/pvt/orders\n@desc List orders\n@optional {orderBy: str # You can retrieve orders lists filtering by an `OrderField` combined with an `OrderType`. To do so, you have to concatenate them: `orderBy={{OrderField}},{{OrderType}}`. \r - `OrderField` values accepted: `creationDate`, `orderId`, `items`, `totalValue` and `origin`. \r - `OrderType` values accepted: `asc` and `desc`., page: int # Define the number of pages you wish to retrieve, restricted to the limit of 30 pages., per_page: int # Quantity of orders for each page, the default value is 15 and it goes up to 100 orders per page. Be aware that the limit of retrieval ofthis endpoint is 30 pages., f_hasInputInvoice: bool # Filters list to return only orders with non `null` values for the `invoiceInput` field., q: str # This parameter filters using Fulltext and accepts the values below. Be aware that the `+` caracter is not allowed in Fulltext Search. \r - Order Id \r - Client email \r - Client document \r - Client name \r \r  B2B Buyer Portal users can search for contact information fields, which includes the values below: \r - User email. \r - User first name. \r - User last name. \r - User phone number. \r - User document ID. \r - User document type., f_shippingEstimate: str # You can filter orders by shipping estimate time in days by concatenating the desired number of days with the sufix `.days`. For example: \r - Next 7 days: `7.days` \r - Tomorrow: `1.days` \r - Today: `0.days` \r - Late: `-1.days`, f_invoicedDate: str # You can filter orders by invoiced date by concatenating the sufix `invoicedDate:` with the range date in Timestamp format. For example: \r - 1 Day: `invoicedDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z]`\r - 1 Month: `invoicedDate:[2022-01-01T02:00:00.000Z TO 2022-02-01T01:59:59.999Z]` \r - 1 Year: `invoicedDate:[2022-01-01T02:00:00.000Z TO 2022-01-01T01:59:59.999Z]`, f_creationDate: str # You can filter orders by creation date by concatenating the sufix `creationDate:` with the range date in Timestamp format. For example: \r - 1 Day: `creationDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z]`\r - 1 Month: `creationDate:[2022-01-01T02:00:00.000Z TO 2022-02-01T01:59:59.999Z]` \r - 1 Year: `creationDate:[2022-01-01T02:00:00.000Z TO 2022-01-01T01:59:59.999Z]`, f_authorizedDate: str # You can filter orders by creation date by concatenating the sufix `authorizedDate:` with the range date in Timestamp format. For example: \r - 1 Day: `authorizedDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z]`\r - 1 Month: `authorizedDate:[2022-01-01T02:00:00.000Z TO 2022-02-01T01:59:59.999Z]` \r - 1 Year: `authorizedDate:[2022-01-01T02:00:00.000Z TO 2022-01-01T01:59:59.999Z]`, f_UtmSource: str # You can filter orders by Urchin Tracking Module (UTM) source., f_sellerNames: str # You can filter orders by using a seller's name., f_callCenterOperatorName: str # You can filter orders by using a Call Center Operator's identification., f_salesChannel: str # You can filter orders by sales channel's ([or trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) name., salesChannelId: str # You can filter orders by sales channel's ([or trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID., f_affiliateId: str # You can filter orders by affiliate ID., f_status: str # You can filter orders by the following [order status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196): \r - `waiting-for-sellers-confirmation` \r - `payment-pending` \r - `payment-approved` \r - `ready-for-handling` \r - `handling` \r - `invoiced` \r - `canceled`, incompleteOrders: bool # When set as `true`, you retrieve [incomplete orders](https://help.vtex.com/en/tutorial/understanding-incomplete-orders), when set as `false`, you retrieve orders that are not incomplete., f_paymentNames: str # You can filter orders by payment type., f_RnB: str # You can filter orders by rates and benefits (promotions)., searchField: str # You can search orders by using one of the following criterias: \r - SKU ID - `sku_Ids&sku_Ids` \r - Gift List ID - `listId&listId` \r - Transaction ID (TID) - `tid&tid` \r - PCI Connector's Transaction ID (TID) - `pci_tid&pci_tid` \r - Payment ID (PID) - `paymentId&paymentId` \r - Connector's NSU - `nsu&nsu`, f_isInstore: bool # When set as `true`, this parameter filters orders made via [inStore](https://help.vtex.com/en/tracks/what-is-instore--zav76TFEZlAjnyBVL5tRc), and when set as `false`, it filters orders that were not made via inStore.}\n@returns(200) OK\n\n@endpoint POST /api/oms/pvt/orders/{orderId}/start-handling\n@desc Start handling order\n@required {orderId: str # Order ID is a unique code that identifies an order.}\n@returns(204) No Content\n@errors {401: Unauthorized, 403: Forbidden, 404: Not Found, 409: Conflict, 429: Too Many Requests}\n\n@endpoint POST /api/oms/pvt/orders/{orderId}/cancel\n@desc Cancel order\n@required {orderId: str # ID that identifies the order in the seller.}\n@optional {reason: str # Reason for cancelling the order.}\n@returns(200) {date: str, orderId: str, receipt: str} # OK\n@errors {403: Forbidden    The credentials are not enabled to access the service., 404: Not Found    Value not found., 429: Too Many Requests}\n@example_request {\"reason\":\"Unexpected stock shortage\"}\n\n@endpoint POST /api/oms/pvt/orders/{orderId}/changes\n@desc Register modifications on order\n@required {orderId: str # ID that identifies the order in the seller., requestId: str # Request identification of the modification. Only the first modification made with each `requestId` will be effective on a given order. Use different IDs for different modifications to the same order., reason: str # Reason for order modification. This may be shown to the shopper in the UI or transactional emails., discountValue: int # This field can be used to apply a discount to the total value of the order. Value in cents., incrementValue: int # This field can be used to increment the total value of the order. Value in cents.}\n@optional {itemsRemoved: [map{id!: str, price!: int, quantity!: int}] # List of items that should be removed from the order., itemsAdded: [map{id!: str, price!: int, quantity!: int}] # List of items that should be added to the order.}\n@returns(200) {date: str, orderId: str, receipt: str} # OK\n@example_request {\"requestId\":\"change-request-0123\",\"reason\":\"Stock shortage\",\"discountValue\":100,\"incrementValue\":100,\"itemsRemoved\":[{\"id\":\"0\",\"price\":2499,\"quantity\":1}],\"itemsAdded\":[{\"id\":\"0\",\"price\":2499,\"quantity\":1}]}\n\n@endpoint POST /api/oms/pvt/orders/{orderId}/interactions\n@desc Add log in orders\n@required {orderId: str # Unique code that identifies an order., source: str # Source information., message: str # Interactions message.}\n@returns(200) OK\n@example_request {\"source\":\"Postman\",\"message\":\"Add interactions\"}\n\n@endpoint POST /api/oms/pvt/orders/{orderId}/invoice\n@desc Order invoice notification\n@required {orderId: str # Unique code that identifies the order whose invoice is being sent., type: str(Output/Input) # The type of invoice. There are two possible values: **Output** and **Input**. The Output type should be used when the invoice you are sending is a selling invoice. The Input type should be used when you send a return invoice., issuanceDate: str # The invoice date is when the order was [invoiced](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/2WgQrlHTyVo4hLjhUs1LMT) in the VTEX platform, and the `IssuanceDate` is the date when the merchant registers the order's invoice in the store's system. The `IssuanceDate` can be different from the invoice date, because the merchant can register the invoice days or even months after order invoicing. You must add date and time in this field., invoiceNumber: str # Unique code that identifies the invoice. When you call this endpoint using the same invoice number, you generate a new `receipt` code., invoiceValue: str # Total amount being invoiced in cents. Must be greater than 0. Do not use any decimal separator. For instance, `$24.99` should be represented as `2499`., items: [map{id!: str, price!: int, description: str, quantity!: int}] # Array containing the SKUs that are being invoiced.}\n@optional {invoiceKey: str # Information about invoice key., invoiceUrl: str # URL of the invoice. Can be used to send the URL of an XML file, for example, which is useful for some integrations., embeddedInvoice: str # XML text of the invoice, not the URL. This field is very important for external marketplace integrations such as Mercado Libre., courier: str # The name of the carrier responsible for delivering the order., trackingNumber: str # The number code that identifies the order tracking. *This field should only be used when sending the **tracking** information. When the request is used for sending the invoice, this field should be left empty (`\"\"`)*., trackingUrl: str # The URL used to track the order. *This field should only be used when sending the **tracking** information. When the request is used for sending the invoice, this field should be left empty (`\"\"`)*., dispatchedDate: str # Order dispatch date. May be `null`.}\n@returns(200) {date: str, orderId: str, receipt: str} # OK\n@example_request {\"type\":\"Output\",\"issuanceDate\":\"2024-01-31T18:25:43-05:00\",\"invoiceNumber\":\"DFG-v7731485plzv-01\",\"invoiceValue\":\"2499\",\"invoiceKey\":\"CFe35201100063960001504590006629690333214542150\",\"invoiceUrl\":\"https://luxstore.com/invoices/24382.pdf\",\"embeddedInvoice\":\"<NFe>\\r\\n<infNFe Id=\\\"NFe34687999999090910270550010000000015180000000000\\\" versao=\\\"1.10\\\">\\r\\n<ide>\\r\\n<cUF>37</cUF>\\r\\n<cNF>000005177</cNF>\\r\\n<natOp>Venda a vista</natOp>\\r\\n<indPag>0</indPag>\\r\\n<mod>55</mod>\\r\\n<serie>1</serie>\\r\\n<nNF>1</nNF>\\r\\n<dEmi>2018-07-06</dEmi>\\r\\n<dSaiEnt>2018-07-06</dSaiEnt>\\r\\n<tpNF>0</tpNF>\\r\\n<cMunFG>79950308</cMunFG>\\r\\n<tpImp>1</tpImp>\\r\\n<tpEmis>1</tpEmis>\\r\\n<cDV>3</cDV>\\r\\n<tpAmb>2</tpAmb>\\r\\n<finNFe>1</finNFe>\\r\\n<procEmi>0</procEmi>\\r\\n<verProc>NF-eletronica.com</verProc>\\r\\n</ide>\\r\\n<emit>\\r\\n<CNPJ>99999090998760</CNPJ>\\r\\n<xNome>NF-e Associacao NF-e</xNome>\\r\\n<xFant>NF-e</xFant>\\r\\n<enderEmit>\\r\\n<xLgr>Rua Central</xLgr>\\r\\n<nro>100</nro>\\r\\n<xCpl>Fundos</xCpl>\\r\\n<xBairro>Distrito Industrial</xBairro>\\r\\n<cMun>0000000</cMun>\\r\\n<xMun>Município</xMun>\\r\\n<UF>SP</UF>\\r\\n<CEP>0000000</CEP>\\r\\n<cPais>1058</cPais>\\r\\n<xPais>Brasil</xPais>\\r\\n<fone>1733021717</fone>\\r\\n</enderEmit>\\r\\n<IE>123456789012</IE>\\r\\n</emit>\\r\\n<dest>\\r\\n<CNPJ>00000000000000</CNPJ>\\r\\n<xNome>DISTRIBUIDORA DE AGUAS MINERAIS</xNome>\\r\\n<enderDest>\\r\\n<xLgr>AV DAS FONTES</xLgr>\\r\\n<nro>1777</nro>\\r\\n<xCpl>1001 ANDAR</xCpl>\\r\\n<xBairro>PARQUE</xBairro>\\r\\n<cMun>0000000</cMun>\\r\\n<xMun>Sao Paulo</xMun>\\r\\n<UF>SP</UF>\\r\\n<CEP>00000000</CEP>\\r\\n<cPais>1058</cPais>\\r\\n<xPais>BRASIL</xPais>\\r\\n<fone>3900000000</fone>\\r\\n</enderDest>\\r\\n<IE> </IE>\\r\\n</dest>\\r\\n<retirada>\\r\\n<CNPJ>000000000004</CNPJ>\\r\\n<xLgr>AV PAULISTA</xLgr>\\r\\n<nro>12345</nro>\\r\\n<xCpl>TERREO</xCpl>\\r\\n<xBairro>CERQUEIRA CESAR</xBairro>\\r\\n<cMun>0000000</cMun>\\r\\n<xMun>SAO PAULO</xMun>\\r\\n<UF>SP</UF>\\r\\n</retirada>\\r\\n<entrega>\\r\\n<CNPJ>00000000299000194</CNPJ>\\r\\n<xLgr>AV FARIA LIMA</xLgr>\\r\\n<nro>154400</nro>\\r\\n<xCpl>156 ANDAR</xCpl>\\r\\n<xBairro>PINHEIROS</xBairro>\\r\\n<cMun>0000308</cMun>\\r\\n<xMun>SAO PAULO</xMun>\\r\\n<UF>SP</UF>\\r\\n</entrega>\\r\\n<det nItem=\\\"1\\\">\\r\\n<prod>\\r\\n<cProd>00001</cProd>\\r\\n<cEAN/>\\r\\n<xProd>Agua Mineral</xProd>\\r\\n<CFOP>5101</CFOP>\\r\\n<uCom>dz</uCom>\\r\\n<qCom>1000000.0000</qCom>\\r\\n<vUnCom>1</vUnCom>\\r\\n<vProd>10000000.00</vProd>\\r\\n<cEANTrib/>\\r\\n<uTrib>und</uTrib>\\r\\n<qTrib>12000000.0000</qTrib>\\r\\n<vUnTrib>1</vUnTrib>\\r\\n</prod>\\r\\n<imposto>\\r\\n<ICMS>\\r\\n<ICMS00>\\r\\n<orig>0</orig>\\r\\n<CST>00</CST>\\r\\n<modBC>0</modBC>\\r\\n<vBC>10000000.00</vBC>\\r\\n<pICMS>18.00</pICMS>\\r\\n<vICMS>1800000.00</vICMS>\\r\\n</ICMS00>\\r\\n</ICMS>\\r\\n<PIS>\\r\\n<PISAliq>\\r\\n<CST>01</CST>\\r\\n<vBC>10000000.00</vBC>\\r\\n<pPIS>0.65</pPIS>\\r\\n<vPIS>65000</vPIS>\\r\\n</PISAliq>\\r\\n</PIS>\\r\\n<COFINS>\\r\\n<COFINSAliq>\\r\\n<CST>01</CST>\\r\\n<vBC>10000000.00</vBC>\\r\\n<pCOFINS>2.00</pCOFINS>\\r\\n<vCOFINS>200000.00</vCOFINS>\\r\\n</COFINSAliq>\\r\\n</COFINS>\\r\\n</imposto>\\r\\n</det>\\r\\n<det nItem=\\\"2\\\">\\r\\n<prod>\\r\\n<cProd>00002</cProd>\\r\\n<cEAN/>\\r\\n<xProd>Agua Mineral</xProd>\\r\\n<CFOP>5101</CFOP>\\r\\n<uCom>pack</uCom>\\r\\n<qCom>5000000.0000</qCom>\\r\\n<vUnCom>2</vUnCom>\\r\\n<vProd>10000000.00</vProd>\\r\\n<cEANTrib/>\\r\\n<uTrib>und</uTrib>\\r\\n<qTrib>3000000.0000</qTrib>\\r\\n<vUnTrib>0.3333</vUnTrib>\\r\\n</prod>\\r\\n<imposto>\\r\\n<ICMS>\\r\\n<ICMS00>\\r\\n<orig>0</orig>\\r\\n<CST>00</CST>\\r\\n<modBC>0</modBC>\\r\\n<vBC>10000000.00</vBC>\\r\\n<pICMS>18.00</pICMS>\\r\\n<vICMS>1800000.00</vICMS>\\r\\n</ICMS00>\\r\\n</ICMS>\\r\\n<PIS>\\r\\n<PISAliq>\\r\\n<CST>01</CST>\\r\\n<vBC>10000000.00</vBC>\\r\\n<pPIS>0.65</pPIS>\\r\\n<vPIS>65000</vPIS>\\r\\n</PISAliq>\\r\\n</PIS>\\r\\n<COFINS>\\r\\n<COFINSAliq>\\r\\n<CST>01</CST>\\r\\n<vBC>10000000.00</vBC>\\r\\n<pCOFINS>2.00</pCOFINS>\\r\\n<vCOFINS>200000.00</vCOFINS>\\r\\n</COFINSAliq>\\r\\n</COFINS>\\r\\n</imposto>\\r\\n</det>\\r\\n<total>\\r\\n<ICMSTot>\\r\\n<vBC>20000000.00</vBC>\\r\\n<vICMS>18.00</vICMS>\\r\\n<vBCST>0</vBCST>\\r\\n<vST>0</vST>\\r\\n<vProd>20000000.00</vProd>\\r\\n<vFrete>0</vFrete>\\r\\n<vSeg>0</vSeg>\\r\\n<vDesc>0</vDesc>\\r\\n<vII>0</vII>\\r\\n<vIPI>0</vIPI>\\r\\n<vPIS>130000.00</vPIS>\\r\\n<vCOFINS>400000.00</vCOFINS>\\r\\n<vOutro>0</vOutro>\\r\\n<vNF>20000000.00</vNF>\\r\\n</ICMSTot>\\r\\n</total>\\r\\n<transp>\\r\\n<modFrete>0</modFrete>\\r\\n<transporta>\\r\\n<CNPJ>00000000000000</CNPJ>\\r\\n<xNome>Distribuidora de Bebidas Fazenda de SP Ltda.</xNome>\\r\\n<IE>00000000999119</IE>\\r\\n<xEnder>Rua Central 100 - Fundos - Distrito Industrial</xEnder>\\r\\n<xMun>SAO PAULO</xMun>\\r\\n<UF>SP</UF>\\r\\n</transporta>\\r\\n<veicTransp>\\r\\n<placa>BXI1717</placa>\\r\\n<UF>SP</UF>\\r\\n<RNTC>123456789</RNTC>\\r\\n</veicTransp>\\r\\n<reboque>\\r\\n<placa>UUU0000</placa>\\r\\n<UF>SP</UF>\\r\\n<RNTC>123456789</RNTC>\\r\\n</reboque>\\r\\n<vol>\\r\\n<qVol>10000</qVol>\\r\\n<esp>CAIXA</esp>\\r\\n<marca>LINDOYA</marca>\\r\\n<nVol>500</nVol>\\r\\n<pesoL>1000000000.000</pesoL>\\r\\n<pesoB>1200000000.000</pesoB>\\r\\n<lacres>\\r\\n<nLacre>XYZ10231486</nLacre>\\r\\n</lacres>\\r\\n</vol>\\r\\n</transp>\\r\\n<infAdic>\\r\\n<infAdFisco>Nota Fiscal de exemplo NF-eletronica.com</infAdFisco>\\r\\n</infAdic>\\r\\n</infNFe>\\r\\n<Signature>\\r\\n<SignedInfo>\\r\\n<CanonicalizationMethod Algorithm=\\\"http://www.w3.org/TR/2001/REC-xml-c14n-0321120010315\\\"/>\\r\\n<SignatureMethod Algorithm=\\\"http://www.w3.org/2000/09/xmldsig#rsa-sha1\\\"/>\\r\\n<Reference URI=\\\"#NFe3508059999977777777705500100000000000000000\\\">\\r\\n<Transforms>\\r\\n<Transform Algorithm=\\\"http://www.w3.org/2000/09/xmldsig#enveloped-signature\\\"/>\\r\\n<Transform Algorithm=\\\"http://www.w3.org/TR/2001/REC-xml-c14n-66666615\\\"/>\\r\\n</Transforms>\\r\\n<DigestMethod Algorithm=\\\"http://www.w3.org/2000/09/xmldsig#sha1\\\"/>\\r\\n<DigestValue>xFzhgdgnhjSD1e9uqe04lnoHT4ZzLSY=</DigestValue>\\r\\n</Reference>\\r\\n</SignedInfo>\\r\\n<SignatureValue>\\r\\nIz5Z3PLQbzZt9jnBtr6xsmHZMOu/3plXG9xxfFjRCQYGnD1rjlhzBGrqt026Ca2VHHM/bHNepi6FuFkAi595GScKVuHREUotzifE2OIjgavvTOrMwbXG7+0LYgkwPFiPCao2S33UpZe7MneaxcmKQGKQZw1fP8fsWmaQ4cczZT8=\\r\\n</SignatureValue>\\r\\n<KeyInfo>\\r\\n<X509Data>\\r\\n<X509Certificate>\\r\\nMIIEuzCCA6OgAwIBAgIDMTMxMA0GasfFSDAGQUAMIGSMQswCQYDVQQGEwJCUjELMAkGA1UECBMCUlMxFTATBgNVBAcTDFBvcnRvIEFsZWdyZTEdMBsGA1UEChMUVGVzdGUgUHJvamV0byBORmUgUlMxHTAbBgNVBAsTFFRlc3RlIFByb2pldG8gTkZlIFJTMSEwHwYDVQQDExhORmUgLSBBQyBJbnRlcm1lZGlhcmlhIDEwHhcNMDgwNDI4MDkwMTAyWhcNMDkwNDMwMjM1OTU5WjCBnjELMAkGA1UECBMCUlMxHTAfvw4567DRhg76FByb2pldG8gTkZlIFJTMR0wGwYDVQQKExRUZXN0ZSBQcm9qZXRvIE5GZSBSUzEVMBMGA1UEBxMMUE9SVE8gQUxFR1JFMQswCQYDVQQGEwJCUjEtMCsGA1UEAxMkTkZlIC0gQXNzb2NpYWNhbyBORi1lOjk5OTk5MDkwOTEwMjcwMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDh6RRv0bj4RYX+tDQrZRb5opa77LBVVs+6LphIfSF3TSWPfnKh0+xLlBFdmnB5YGgbbW9Uon6pZQTfaC8jZhRhI5eFRRofY/Ugoeo0NGt6PcIQNZQd6lLQ/ASd1qWwjqJoEa7udriKjy3h351Mf1bng1VxS1urqC3Dn39ZWIEwQIDAQABo4IBjjCCAYowIgYDVR0jAQEABBgwFoAUPT5TqhNWAm+ZpcVsvB7malDBjEQwDwYDVR0TAQH/BAUwAwEBADAPBgNVHQ8BAf8EBQMDAOAAMAwGA1UdIAEBAAQCMAAwgbwGA1UdEQEBAASBsTCBrqA4BgVgTAEDBKAvBC0wNzA4MTk1MTE1MTk0NTMxMDg3MDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDCgHQYFYEwBAwKgFAQSRmVybmFuZG8gQ2FudG8gQWx0oBkGBWBMAQMDoBAEDjk5OTk5MDkwOTEwMjcwoBcGBWBMAQMHoA4EDDAwMDAwMDAwMDAwMIEfZmVybmFuZG8tYWx0QHByb2NlcmdzLnJzLmdvdi5icjAgBgNVHSUBAf8EFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwUwYDVR0fAQEABEkwRzBFoEOgQYY/aHR0cDovL25mZWNlcnRpZmljYWRvLnNlZmF6LnJzLmdvdi5ici9MQ1IvQUNJbnRlcm1lZGlhcmlhMzguY3JsMA0GCSqGSIb3DQEBBQUAA4IBAQCNPpaZ3Byu3/70nObXE8NiM53j1ddIFXsb+v2ghCVd4ffExv3hYc+/a3lfgV8H/WfQsdSCTzS2cHrd4Aasr/eXfclVDmf2hcWz+R7iysOHuT6B6r+DvV3JcMdJJCDdynR5REa+zViMnVZo1G3KuceQ7/y5X3WFNVq4kwHvonJ9oExsWyw8rTwUK5bsjz0A2yEwXkmkJIngnF41sP31+9jCImiqkXcmsesFhxzX7iurAQAQCZOm7iwMWxQKcAjXCZrgSZWRQy6mU224sX3HTArHahmLJ9Iw+WYAua5qBJsiN6PC7v5tfhdsgGD46DHMnOecxvkkPolDUyBa7d7xwgm\\r\\n</X509Certificate>\\r\\n</X509Data>\\r\\n</KeyInfo>\\r\\n</Signature>\\r\\n</NFe>\",\"courier\":\"carrierOne\",\"trackingNumber\":\"87658\",\"trackingUrl\":\"https://www.tracking.com/url\",\"dispatchedDate\":\"2019-02-08T13:16:13.4617653+00:00\",\"items\":[{\"id\":\"123\",\"price\":2499,\"description\":\"335\",\"quantity\":2}]}\n\n@endpoint PATCH /api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber}\n@desc Update order's partial invoice (send tracking number)\n@required {orderId: str # Unique code that identifies the order whose invoice is being sent., invoiceNumber: str # Number that identifies the invoice., trackingNumber: str # The number code that identifies the order tracking., trackingUrl: str # Package tracking URL., dispatchedDate: str # Date when the package was dispatched. For example, 2023-01-08T13:16:13.4617653+00:00., courier: str # The name of the carrier responsible for delivering the order.}\n@returns(200) {date: str, orderId: str, receipt: str} # OK\n@example_request {\"trackingNumber\":\"87658\",\"trackingUrl\":\"https://www.tracking.com/url\",\"courier\":\"carrierOne\",\"dispatchedDate\":\"2022-02-08T13:16:13.4617653+00:00\"}\n\n@endpoint PUT /api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber}/tracking\n@desc Update order tracking status\n@required {orderId: str # Order ID is a unique code that identifies an order., invoiceNumber: str # Number that identifies the invoice., isDelivered: bool # When set as `true`, it means the order got to its final shipping address, whether by delivery or pickup shipping type. When set as `false`, the order is still in transit to its shipping address., deliveredDate: str # Date and time of when the package was delivered. Note that it is different from the tracking date parameter. The `deliveredDate` format is `yyyy-mm-dd hh:mm`., events: [map{city!: str, state!: str, description!: str, date!: str}] # Array containing events information.}\n@returns(200) OK\n@example_request {\"isDelivered\":false,\"deliveredDate\":null,\"events\":[{\"city\":\"Rio de Janeiro\",\"state\":\"RJ\",\"description\":\"Coletado pela transportadora\",\"date\":\"2015-06-23\"},{\"city\":\"Sao Paulo\",\"state\":\"SP\",\"description\":\"A caminho de Curitiba\",\"date\":\"2015-06-24\"}]}\n\n@endpoint GET /api/oms/pvt/orders/{orderId}/conversation-message\n@desc Retrieve order conversation\n@required {orderId: str # Order ID is a unique code that identifies an order.}\n@returns(200) OK\n\n@endpoint GET /api/oms/pvt/orders/{orderId}/payment-transaction\n@desc Retrieve payment transaction\n@required {orderId: str # Order ID is a unique code that identifies an order.}\n@returns(200) {status: str, isActive: bool, transactionId: str, merchantName: str, payments: [map]} # OK\n\n@endpoint POST /api/oms/pvt/orders/{orderId}/payments/{paymentId}/payment-notification\n@desc Send payment notification\n@required {orderId: str # Order ID is a unique code that identifies an order., paymentId: str # VTEX payment identifier.}\n@returns(200) OK\n@errors {400: Bad Request, 403: Forbidden    The credentials are not enabled to access the service., 404: Not Found    Value not found., 429: Too Many Requests}\n\n@endpoint GET /api/oms/pvt/feed/orders/status\n@desc Get feed order status\n@required {maxLot: str # Maximum lot.}\n@returns(200) OK\n\n@endpoint GET /api/orders/feed/config\n@desc Get feed configuration\n@returns(200) {filter: map{type: str, status: [str], expression: str, disableSingleFire: bool}, queue: map{visibilityTimeoutInSeconds: int, MessageRetentionPeriodInSeconds: int}, quantity: int, approximateAgeOfOldestMessageInSeconds: num} # OK\n\n@endpoint POST /api/orders/feed/config\n@desc Create or update feed configuration\n@required {filter: map{type!: str, status: [str], expression: str, disableSingleFire: bool} # Object with type and status that will filter feed orders., queue: map{visibilityTimeoutInSeconds!: int, MessageRetentionPeriodInSeconds!: int} # Object with information about timeout and message retention.}\n@returns(200) OK\n@errors {403: Forbidden    The credentials are not enabled to access the service., 404: Not Found    Value not found., 429: Too Many Requests}\n@example_request {\"filter\":{\"type\":\"FromOrders\",\"expression\":\"value > 100\",\"disableSingleFire\":false},\"queue\":{\"visibilityTimeoutInSeconds\":250,\"MessageRetentionPeriodInSeconds\":345600}}\n\n@endpoint DELETE /api/orders/feed/config\n@desc Delete feed configuration\n@returns(200) OK\n@errors {400: Bad Request    Unable to check address / Only https scheme is accepted., 403: Forbidden    The credentials are not enabled to access the service., 404: Not Found    Value not found., 429: Too Many Requests}\n\n@endpoint GET /api/orders/feed\n@desc Retrieve feed items\n@required {maxlot: str # Lot quantity to retrieve. Maximum accepted value is 10.}\n@returns(200) OK\n\n@endpoint POST /api/orders/feed\n@desc Commit feed items\n@required {handles: [str] # List of item handles to commit.}\n@returns(200) OK\n@example_request {\"handles\":[\"AQEBSM/bSqonHYtx+UrHdbuJ0i7M9yMbI2jtYwMIPdEc4BenuneaCTC9VEJ3dgAy1XtfQvHBvgwZTO8LvGObIKNqiKXDZiMKY25vK+pblZEqf1pWdLMugu5XoHA5ZAd4IcBcXrBcrlr1GU8uvPEBoVLOsVBP9IAxIZkkeEedIDg3K6GPyEXVuPlTEYb/0OCunEGxWF+AZ1frFdXh7ulORTcuqO5oDlBGbpD+QYzCmF4mUZtQ0VVWh9icM1QBVh6PlJ0D/lfwnJKWpBn3jf8c+DTm7sD7wb1Lcz9uWMLhDtPwvH9vue4MvKU9sCahEQe7K5jWuwwb54szGbFKdfcACsTSQ9WlyBfMdbV83c27k68G3cnaBFExkC1MLHHE9UzpQ6l4s43BT4k95ocgMXffnj/HMUYXn+OCvlvjytY59x1OCRE=\"]}\n\n@endpoint GET /api/orders/hook/config\n@desc Get hook configuration\n@optional {clientEmail: str # Customer email., page: str # Page number for result pagination., per_page: str # Page quantity for result pagination.}\n@returns(200) OK\n\n@endpoint POST /api/orders/hook/config\n@desc Create or update hook configuration\n@required {filter: map{type!: str, status: [str], expression: str, disableSingleFire: bool}, hook: map{url!: str, headers!: map}}\n@returns(200) {Domain: str, OrderId: str, State: str, LastState: str, LastChange: str, CurrentChange: str, Origin: map{Account: str, Key: str}} # OK\n@example_request {\"filter\":{\"type\":\"FromOrders\",\"expression\":\"value > 100\",\"disableSingleFire\":false},\"hook\":{\"url\":\"https://endpoint.example/path\",\"headers\":{\"key\":\"value\"}}}\n\n@endpoint DELETE /api/orders/hook/config\n@desc Delete hook configuration\n@returns(200) OK\n@errors {403: Forbidden    The credentials are not enabled to access the service., 404: Not Found    Value not found., 429: Too Many Requests}\n\n@endpoint GET /api/orders/pvt/document/{orderId}/change-summary\n@desc Get order modifications summary\n@required {orderId: str # Order ID.}\n@returns(200) {original: [map], added: [map], removed: [map], replaced: [map], manualDiscountValueAggregated: int, manualIncrementValueAggregated: int, totalChangeValueAggregated: int, totals: any, lastChange: str} # OK\n@errors {401: Unauthorized    Invalid or missing authentication., 403: Forbidden    Insufficient permissions., 404: Not Found    Order not found.}\n\n@endpoint GET /api/oms/user/orders\n@desc Retrieve user's orders\n@optional {clientEmail: str # Customer email. This field is exclusive for B2C users., page: str # Page number for result pagination., per_page: str # Page quantity for result pagination., text: str # Filter by text in existing order fields, custom fields, and contact information fields. This field is exclusive for B2B Buyer Portal users., status: str # Order status. You can provide multiple values by repeating the query parameter. For example: \r \r  - `status=payment-pending&status=handling` \r \r  This field is exclusive for B2B Buyer Portal users., creation_date: str # You can filter orders by creation date by concatenating the sufix `creationDate` with the range date in Timestamp format. This field accepts the value `*` for open ranges. For example: \r \r  - `creationDate:[* TO 2025-04-08T23:59:59.999Z]` \r  - `creationDate:[2025-01-01T02:00:00.000Z TO *]` \r \r  This field is exclusive for B2B Buyer Portal users., purchase_agent_id: str # ID of the purchase agent. You can provide multiple values by repeating the query parameter. For example: \r \r  - `purchase_agent_id=848a994a-1b6b-4dbd-5555-0455af24e0f2&purchase_agent_id=848a994a-1b6b-4444-8498-0455af24e0f2` \r \r  This field is exclusive for B2B Buyer Portal users., my_pending_approvals: bool # You can filter orders that are pending approval by the current user or by an organizational unit associated with the current user if it has `ViewMyOrgUnitOrders` permission. This field is exclusive for B2B Buyer Portal users.}\n@returns(200) {list: [map], facets: [str], paging: map{total: int, pages: int, currentPage: int, perPage: int}, stats: map{stats: map{totalValue: map{Count: int, Max: int, Mean: int, Min: int, Missing: int, StdDev: int, Sum: int, SumOfSquares: int, Facets: map}, totalItems: map{Count: int, Max: int, Mean: int, Min: int, Missing: int, StdDev: int, Sum: int, SumOfSquares: int, Facets: map}}}} # OK\n\n@endpoint GET /api/oms/user/orders/{orderId}\n@desc Retrieve user order details\n@required {orderId: str # Order ID is a unique code that identifies an order.}\n@optional {clientEmail: str # Customer email. This field is exclusive for B2C users., text: str # Filter by text in existing order fields, custom fields, and contact information fields. This field is exclusive for B2B Buyer Portal users., status: str # Order status. You can provide multiple values by repeating the query parameter. For example: \r \r  - `status=payment-pending&status=handling` \r \r  This field is exclusive for B2B Buyer Portal users., creation_date: str # You can filter orders by creation date by concatenating the sufix `creationDate` with the range date in Timestamp format. This field accepts the value `*` for open ranges. For example: \r \r  - `creationDate:[* TO 2025-04-08T23:59:59.999Z]` \r  - `creationDate:[2025-01-01T02:00:00.000Z TO *]` \r \r  This field is exclusive for B2B Buyer Portal users., purchase_agent_id: str # ID of the purchase agent. You can provide multiple values by repeating the query parameter. For example: \r \r  - `purchase_agent_id=848a994a-1b6b-4dbd-5555-0455af24e0f2&purchase_agent_id=848a994a-1b6b-4444-8498-0455af24e0f2` \r \r  This field is exclusive for B2B Buyer Portal users., my_pending_approvals: bool # You can filter orders that are pending approval by the current user or by an organizational unit associated with the current user if it has `ViewMyOrgUnitOrders` permission. This field is exclusive for B2B Buyer Portal users.}\n@returns(200) {orderId: str, sequence: str, marketplaceOrderId: str, marketplaceServicesEndpoint: str, sellerOrderId: str, origin: str, affiliateId: str, salesChannel: str, merchantName: str, status: str, statusDescription: str, value: int, creationDate: str, lastChange: str, orderGroup: str, totals: [map], items: [map], marketplaceItems: [str], clientProfileData: map{id: str, email: str, firstName: str, lastName: str, documentType: str, document: str, phone: str, corporateName: str?, tradeName: str?, corporateDocument: str?, stateInscription: str?, corporatePhone: str?, isCorporate: bool, userProfileId: str, customerClass: str?}, giftRegistryData: str?, marketingData: map{id: str, utmSource: str, utmPartner: str, utmMedium: str, utmCampaign: str, coupon: str, utmiCampaign: str, utmipage: str, utmiPart: str, marketingTags: [str]}, ratesAndBenefitsData: map{id: str, rateAndBenefitsIdentifiers: [str]}, shippingData: map{id: str, address: map{addressType: str, receiverName: str, addressId: str, versionId: str?, entityId: str?, postalCode: str, city: str, state: str, country: str, street: str, number: str, neighborhood: str, complement: str, reference: str?, geoCoordinates: [num]}, logisticsInfo: [map], trackingHints: str?, selectedAddresses: [map]}, paymentData: map{giftCards: [str], transactions: [map]}, packageAttachment: map{packages: [str]}, sellers: [map], callCenterOperatorData: str?, followUpEmail: str, lastMessage: str?, hostname: str, invoiceData: map?, changesAttachment: map{id: str, changesData: [map]}, openTextField: str?, roundingError: int, orderFormId: str, commercialConditionData: str?, isCompleted: bool, customData: str?, storePreferencesData: map{countryCode: str, currencyCode: str, currencyFormatInfo: map{CurrencyDecimalDigits: int, CurrencyDecimalSeparator: str, CurrencyGroupSeparator: str, CurrencyGroupSize: int, StartsWithCurrencySymbol: bool}, currencyLocale: int, currencySymbol: str, timeZone: str}, allowCancellation: bool, allowEdition: bool, isCheckedIn: bool, marketplace: map{baseURL: str, isCertified: str?, name: str}, authorizedDate: str, invoicedDate: str?, cancelReason: str?, itemMetadata: map{Items: [map]}, subscriptionData: map?{SubscriptionGroupId: str, Subscriptions: [map]?}, taxData: map{areTaxesDesignatedByMarketplace: bool, taxInfoCollection: [map]}, checkedInPickupPointId: str, cancellationData: map{RequestedByUser: bool, RequestedBySystem: bool, RequestedBySellerNotification: bool, RequestedByPaymentNotification: bool, Reason: str, CancellationDate: str}, clientPreferencesData: map{locale: str, optinNewsLetter: bool}} # OK\n\n@endpoint POST /api/orders/expressions/jsonata\n@desc Test JSONata expression\n@required {Expression: str # JSONata expression to be tested., Document: str # JSON document to be evaluated by the expression.}\n@returns(200) OK\n@example_request {\"Expression\":\"status = \\\\\\\"canceled\\\\\\\"\",\"Document\":\"{\\\\\\\"status\\\\\\\":\\\\\\\"canceled\\\\\\\"}\"}\n\n@endpoint GET /api/checkout/pvt/configuration/window-to-change-seller\n@desc Get window to change seller\n@returns(200) OK\n\n@endpoint POST /api/checkout/pvt/configuration/window-to-change-seller\n@desc Update window to change seller\n@required {waitingTime: int # Number of days after order cancelation by a seller, during which another seller may be assigned to fulfill the order.}\n@returns(201) Created\n@example_request {\"waitingTime\":4}\n\n@endpoint PATCH /api/order-system/orders/{changeOrderId}/changes\n@desc Create order modifications\n@required {accountName: str # Name of the VTEX account that created the order., changeOrderId: str # Order ID of the order you wish to modify., reason: str # Reason why you wish to modify order. Since you can make several modifications to an order, filling this field with a clear explanation helps organize the order modifications history. The shopper can view this field value in [transactional emails](https://help.vtex.com/en/tutorial/order-transactional-email-templates--3g2S2kqBOoSGcCaqMYK2my) and [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh).}\n@optional {replace: [map{from!: map, to!: map}] # Array containing `replace` change information. Besides `replace`, you can `add` or `remove` items from an order.\r \r - `add`: the schema will correspond to the object `to` inside the `replace` array.\r \r - `remove`: the schema will correspond to the object `from` inside the `replace` array.\r \r You will find request body examples of both cases in the endpoint description on the top of the page. The successful response `202 - Accepted` schema is the same for all three operations, whether they are used separately or combined in the same request.}\n@returns(202) {requestId: str, workflowId: str, reason: str, manualDiscountValue: int, manualIncrementValue: int, totalChangeValue: int, totals: [str], add: [str]?, remove: [str]?, replace: [map]?, date: str, origin: map{account: str, orderId: str, component: str}, settings: map{customPaymentSystemsAllowed: [str]}} # Accepted\n@example_request {\"reason\":\"The client wants to change a weighable product.\",\"replace\":[{\"from\":{\"items\":[{\"id\":\"1\",\"quantity\":1,\"uniqueId\":\"1D6A12BD177140B2BAF0C042D2FAEE54\",\"price\":2499}],\"customData\":{\"customFields\":[{\"linkedEntity\":{\"type\":\"item\",\"id\":\"B2949D0A45244825B177D2F9F96DC711\"},\"fields\":[{\"name\":\"desktop\",\"value\":\"DSK-OLD\"}]}]}},\"to\":{\"items\":[{\"id\":\"2\",\"quantity\":1,\"uniqueId\":\"1D6A12BD177140B2BAF0C042D2FAEE54\",\"measurementUnit\":\"kg\",\"unitMultiplier\":3,\"manualDiscountValue\":0,\"manualIncrementValue\":0,\"clientProfileData\":[{\"firstName\":\"Jane\",\"lastName\":\"Earhart\",\"documentType\":\"cpf\",\"document\":\"123456789\",\"phone\":\"55110988887777\",\"corporateName\":null,\"tradeName\":null,\"corporateDocument\":null,\"stateInscription\":null,\"corporatePhone\":null,\"isCorporate\":false}]}],\"customData\":{\"customFields\":[{\"linkedEntity\":{\"type\":\"item\",\"id\":\"B2949D0A45244825B133D2F9F96DC713\"},\"fields\":[{\"name\":\"desktop\",\"value\":\"DSK-NEW\"}]}]},\"shippingData\":{\"logisticsInfo\":[{\"itemIndex\":0,\"selectedSla\":\"Normal\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"price\":1000}]}}}]}\n\n@endpoint GET /api/order-system/orders/{changeOrderId}/changes\n@desc Get order modifications history\n@required {an: str # Name of the VTEX account that created the order., changeOrderId: str # Order ID of the order you wish to get the modifications history.}\n@returns(200) {requests: [map], actions: [map]} # OK\n\n@endpoint GET /api/order-system/orders/{changeOrderId}/changes/{changeRequestId}\n@desc Get order modifications details\n@required {an: str # Name of the VTEX account that created the order., changeOrderId: str # Order ID of the order you wish to get the modification detail., changeRequestId: str # Once you make an order modification, you generate a `requestId` code that identifies the modifications made to that order. This field should be filled with that code. There are no limits to modifications you can perform using the same `changeRequestId`, and we recommend keeping all modifications of a given order grouped by the same `changeRequestId`, so you will have a unified modification history.}\n@returns(200) {requestId: str, workflowId: str, status: str, inProgress: bool, reason: str, manualDiscountValue: int, manualIncrementValue: int, totalChangeValue: int, totals: [map], add: [str]?, remove: [str]?, replace: [map], date: str, origin: map{account: str, orderId: str, component: str}, settings: map{customPaymentSystemsAllowed: [str]}} # OK\n\n@endpoint POST /api/order-system/orders/{changeOrderId}/changes/preview\n@desc Preview order modifications\n@required {an: str # Name of the VTEX account that created the order., changeOrderId: str # Order ID of the order you wish to preview modification., reason: str # Reason why you wish to modify the order. Since you can make several modifications to an order, filling this field with a clear explanation helps organize the order modifications history. The shopper can view this field value in [transactional emails](https://help.vtex.com/en/tutorial/order-transactional-email-templates--3g2S2kqBOoSGcCaqMYK2my) and [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh)., replace: [map{from!: map, to!: map}] # Name of the change operation you are performing, which can be `replace`, `add` or `remove`. If you want, you can combine all change operations in a single request.}\n@returns(200) {reason: str, manualDiscountValue: int, manualIncrementValue: int, totalChangeValue: int, totals: [map], add: [str]?, remove: [str]?, replace: [map], date: str, origin: map{account: str, orderId: str, component: str}, settings: map{customPaymentSystemsAllowed: [str]}} # OK\n@example_request {\"reason\":\"The client wants to change a weighable product.\",\"replace\":[{\"from\":{\"items\":[{\"id\":\"12345\",\"quantity\":2,\"uniqueId\":\"1D6A12BD177140B2BAF0C042D2FAEE54\",\"price\":2499}],\"customData\":{\"customFields\":[{\"linkedEntity\":{\"type\":\"item\",\"id\":\"B2949D0A45244825B177D2F9F96DC711\"},\"fields\":[{\"name\":\"desktop\",\"value\":\"DSK-OLD\"}]}]}},\"to\":{\"items\":[{\"id\":\"2\",\"quantity\":1,\"uniqueId\":\"1D6A12BD177140B2BAF0C042D2FAEE54\",\"measurementUnit\":\"kg\",\"unitMultiplier\":3,\"manualDiscountValue\":0,\"manualIncrementValue\":0,\"clientProfileData\":[{\"firstName\":\"Jane\",\"lastName\":\"Earhart\",\"documentType\":\"cpf\",\"document\":\"123456789\",\"phone\":\"55110988887777\",\"corporateName\":null,\"tradeName\":null,\"corporateDocument\":null,\"stateInscription\":null,\"corporatePhone\":null,\"isCorporate\":false}]}],\"customData\":{\"customFields\":[{\"linkedEntity\":{\"type\":\"item\",\"id\":\"B2949D0A45244825B133D2F9F96DC713\"},\"fields\":[{\"name\":\"desktop\",\"value\":\"DSK-NEW\"}]}]},\"shippingData\":{\"logisticsInfo\":[{\"itemIndex\":0,\"selectedSla\":\"Normal\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"price\":1000}]}}}]}\n\n@endpoint POST /api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/retry\n@desc Retry order modifications\n@required {an: str # Name of the VTEX account that created the order., changeOrderId: str # Order ID of the order you wish to retry modification., changeRequestId: str # Once you make an order modification, you generate a `requestId` code that identifies the modifications made to that order. This field should be filled with that code.\r \r There are no limits to modifications you can perform using the same `changeRequestId`, and we recommend keeping all modifications of a given order grouped by the same `changeRequestId`, so you will have a unified modification history., reason: str # Reason why you wish to modify order. Since you can make several modifications to an order, filling this field with a clear explanation helps organize the order modifications history. The shopper can view this field value in [transactional emails](https://help.vtex.com/en/tutorial/order-transactional-email-templates--3g2S2kqBOoSGcCaqMYK2my) and [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh).}\n@optional {replace: [map{from!: map, to!: map}] # Array containing `replace` change information. Besides `replace`, you can `add` or `remove` items from an order.\r \r - `add`: the schema will correspond to the object `to` inside the `replace` array.\r \r - `remove`: the schema will correspond to the object `from` inside the `replace` array.\r \r You will find request body examples of both cases in the endpoint description on the top of the page. The successful response `202 - Accepted` schema is the same for all three operations, whether they are used separately or combined in the same request.}\n@returns(204) No Content\n@example_request {\"reason\":\"The client wants to change a weighable product.\",\"replace\":[{\"from\":{\"items\":[{\"id\":\"1\",\"quantity\":1,\"uniqueId\":\"1D6A12BD177140B2BAF0C042D2FAEE54\",\"price\":2499}],\"customData\":{\"customFields\":[{\"linkedEntity\":{\"type\":\"item\",\"id\":\"B2949D0A45244825B177D2F9F96DC711\"},\"fields\":[{\"name\":\"desktop\",\"value\":\"DSK-OLD\"}]}]}},\"to\":{\"items\":[{\"id\":\"2\",\"quantity\":1,\"uniqueId\":\"1D6A12BD177140B2BAF0C042D2FAEE54\",\"measurementUnit\":\"kg\",\"unitMultiplier\":3,\"manualDiscountValue\":0,\"manualIncrementValue\":0,\"clientProfileData\":[{\"firstName\":\"Jane\",\"lastName\":\"Earhart\",\"documentType\":\"cpf\",\"document\":\"123456789\",\"phone\":\"55110988887777\",\"corporateName\":null,\"tradeName\":null,\"corporateDocument\":null,\"stateInscription\":null,\"corporatePhone\":null,\"isCorporate\":false}]}],\"customData\":{\"customFields\":[{\"linkedEntity\":{\"type\":\"item\",\"id\":\"B2949D0A45244825B133D2F9F96DC713\"},\"fields\":[{\"name\":\"desktop\",\"value\":\"DSK-NEW\"}]}]},\"shippingData\":{\"logisticsInfo\":[{\"itemIndex\":0,\"selectedSla\":\"Normal\",\"selectedDeliveryChannel\":\"delivery\",\"addressId\":\"9ec276fd3a604eb1aa151b5333ca5db6\",\"price\":1000}]}}}]}\n\n@endpoint POST /api/order-system/orders/{changeOrderId}/changes/{changeRequestId}/cancel\n@desc Cancel order modifications\n@required {an: str # Name of the VTEX account that created the order., changeOrderId: str # Order ID of the order with the modifications you wish to cancel., changeRequestId: str # Once you make an order modification, you generate a `requestId` code that identifies the modifications made to that order. This field should be filled with that code. After cancelling an order modification, the `changeRequestId` will no longer be valid., reason: str # Reason why you wish to cancel the order modification. The customer will not view the value inserted in this field.}\n@returns(200) OK\n\n@endpoint PUT /api/order-system/orders/changes/settings\n@desc Update Order modifications settings\n@required {an: str # VTEX [account name](https://help.vtex.com/en/tutorial/what-is-an-account-name--i0mIGLcg3QyEy8OCicEoC).}\n@optional {paymentConfiguration: map{customPaymentSystemsAllowed: [str]} # [Order modifications](https://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ) payment configurations., rolloutConfiguration: map{enableApi: bool, enableAdminOrders: map, enableMyOrders: map} # **Order modifications** settings regarding VTEX Admin, [Orders API](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes?endpoint=patch-/api/order-system/orders/-changeOrderId-/changes) and **My Account** feature., pipelineConfiguration: map{enableTaxHubRecalculation: bool, compensateShippingChanges: bool} # **Order modifications** settings related to taxes and shipping calculation.}\n@returns(200) {paymentConfiguration: map{customPaymentSystemsAllowed: [str]}, rolloutConfiguration: map{usingDefaultBehavior: bool, enableApi: bool, enableAdminOrders: map{enabledWorkspaces: [str]}, enableMyOrders: map{enabledWorkspaces: [str]}}, pipelineConfiguration: map{enableTaxHubRecalculation: bool, compensateShippingChanges: bool}} # OK\n\n@endpoint GET /api/order-system/orders/changes/settings\n@desc Get Order modifications settings\n@required {an: str # VTEX [account name](https://help.vtex.com/en/tutorial/what-is-an-account-name--i0mIGLcg3QyEy8OCicEoC).}\n@returns(200) {paymentConfiguration: map{customPaymentSystemsAllowed: [str]}, rolloutConfiguration: map{usingDefaultBehavior: bool, enableApi: bool, enableAdminOrders: map{enabledWorkspaces: [str]}, enableMyOrders: map{enabledWorkspaces: [str]}}, pipelineConfiguration: map{enableTaxHubRecalculation: bool, compensateShippingChanges: bool}} # OK\n\n@end\n"}}