{ "opencollection": "1.0.0", "info": { "name": "VTex Anti-fraud Provider Account Orders API", "version": "1.0" }, "items": [ { "info": { "name": "Orders", "type": "folder" }, "items": [ { "info": { "name": "VTex Get order", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/oms/pvt/orders/:orderId", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "orderId", "value": "1172452900788-01 or seq501456", "type": "path", "description": "Order ID is a unique code that identifies an order. Instead of using `orderId`, you can also make the request using the sequence, a six-digit string that follows the order ID. For example, in order 1268540501456-01 (501456), the sequence is 501456. To use this parameter, replace the value between `{ }` keys in `seq{sequence-number}` with the sequence. For example: `seq501456`." } ] }, "docs": "This endpoint retrieves order details by searching a specific order ID or sequence number. \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> **Onboarding guide** \r\n>\r\n> Check the new [Orders onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/orders-overview). We created this guide to improve the onboar" }, { "info": { "name": "VTex List orders", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/oms/pvt/orders", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "orderBy", "value": "", "type": "query", "description": "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\n- `OrderField` values accepted: `creationDate`, `orderId`, `items`, `totalValue` and `origin`. \r\n- `OrderType` values accepted: `asc` and `desc`." }, { "name": "page", "value": "", "type": "query", "description": "Define the number of pages you wish to retrieve, restricted to the limit of 30 pages." }, { "name": "per_page", "value": "", "type": "query", "description": "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." }, { "name": "f_hasInputInvoice", "value": "", "type": "query", "description": "Filters list to return only orders with non `null` values for the `invoiceInput` field." }, { "name": "q", "value": "", "type": "query", "description": "This parameter filters using Fulltext and accepts the values below. Be aware that the `+` caracter is not allowed in Fulltext Search. \r\n- Order Id \r\n- Client email \r\n- Client document \r\n- Client name" }, { "name": "f_shippingEstimate", "value": "", "type": "query", "description": "You can filter orders by shipping estimate time in days by concatenating the desired number of days with the sufix `.days`. For example: \r\n- Next 7 days: `7.days` \r\n- Tomorrow: `1.days` \r\n- Today: `0.days` \r\n- Late: `-1.days`" }, { "name": "f_invoicedDate", "value": "", "type": "query", "description": "You can filter orders by invoiced date by concatenating the sufix `invoicedDate:` with the range date in Timestamp format. For example: \r\n- 1 Day: `invoicedDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z]`\r\n- 1 Month: `invoicedDate:[2022-01-01T02:00:00.000Z TO 2022-02-01T01:59:59.999Z]` \r\n- 1 Year: `invoicedDate:[2022-01-01T02:00:00.000Z TO 2022-01-01T01:59:59.999Z]`" }, { "name": "f_creationDate", "value": "", "type": "query", "description": "You can filter orders by creation date by concatenating the sufix `creationDate:` with the range date in Timestamp format. For example: \r\n- 1 Day: `creationDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z]`\r\n- 1 Month: `creationDate:[2022-01-01T02:00:00.000Z TO 2022-02-01T01:59:59.999Z]` \r\n- 1 Year: `creationDate:[2022-01-01T02:00:00.000Z TO 2022-01-01T01:59:59.999Z]`" }, { "name": "f_authorizedDate", "value": "", "type": "query", "description": "You can filter orders by creation date by concatenating the sufix `authorizedDate:` with the range date in Timestamp format. For example: \r\n- 1 Day: `authorizedDate:[2022-01-01T02:00:00.000Z TO 2022-01-02T01:59:59.999Z]`\r\n- 1 Month: `authorizedDate:[2022-01-01T02:00:00.000Z TO 2022-02-01T01:59:59.999Z]` \r\n- 1 Year: `authorizedDate:[2022-01-01T02:00:00.000Z TO 2022-01-01T01:59:59.999Z]`" }, { "name": "f_UtmSource", "value": "", "type": "query", "description": "You can filter orders by Urchin Tracking Module (UTM) source." }, { "name": "f_sellerNames", "value": "", "type": "query", "description": "You can filter orders by using a seller's name." }, { "name": "f_callCenterOperatorName", "value": "", "type": "query", "description": "You can filter orders by using a Call Center Operator's identification." }, { "name": "f_salesChannel", "value": "", "type": "query", "description": "You can filter orders by sales channel's ([or trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) name." }, { "name": "salesChannelId", "value": "", "type": "query", "description": "You can filter orders by sales channel's ([or trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID." }, { "name": "f_affiliateId", "value": "", "type": "query", "description": "You can filter orders by affiliate ID." }, { "name": "f_status", "value": "", "type": "query", "description": "You can filter orders by the following [order status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196): \r\n- `waiting-for-sellers-confirmation` \r\n- `payment-pending` \r\n- `payment-approved` \r\n- `ready-for-handling` \r\n- `handling` \r\n- `invoiced` \r\n- `canceled`" }, { "name": "incompleteOrders", "value": "", "type": "query", "description": "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." }, { "name": "f_paymentNames", "value": "", "type": "query", "description": "You can filter orders by payment type." }, { "name": "f_RnB", "value": "", "type": "query", "description": "You can filter orders by rates and benefits (promotions)." }, { "name": "searchField", "value": "", "type": "query", "description": "You can search orders by using one of the following criterias: \r\n- SKU ID - `sku_Ids&sku_Ids` \r\n- Gift List ID - `listId&listId` \r\n- Transaction ID (TID) - `tid&tid` \r\n- PCI Connector's Transaction ID (TID) - `pci_tid&pci_tid` \r\n- Payment ID (PID) - `paymentId&paymentId` \r\n- Connector's NSU - `nsu&nsu`" }, { "name": "f_isInstore", "value": "", "type": "query", "description": "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." } ] }, "docs": "Retrieves a list of orders according to the filters described below. \r\n\r\nThe limit of information retrieval is 30 pages, the default number of orders per page is 15 and it is possible to configure it up to 100 using the `per_page` parameter. \r\n\r\nBe aware that since October 3rd, 2018, this endpoint does not return the `items` property. \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" }, { "info": { "name": "VTex Start handling order", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/oms/pvt/orders/:orderId/start-handling", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "orderId", "value": "1172452900788-01", "type": "path", "description": "Order ID is a unique code that identifies an order." } ] }, "docs": "Changes the status of an order to indicate that it is in `handling`.\n\r\n\r> Expect a `status 204` response with no content in case of a successful request. The store must validate this response to retry the call if the response differs from the `204` code, making this flow the store's responsibility. This endpoint can also respond with `status 500`. \n\r\n\r> The `Change order workflow status` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile -" }, { "info": { "name": "VTex Cancel order", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/oms/pvt/orders/:orderId/cancel", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "orderId", "value": "1172452900788-01", "type": "path", "description": "ID that identifies the order in the seller." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancels an order using its identification code (`orderId`). A common scenario is when the seller has a problem fulfilling the order and requests the marketplace to cancel it. \r\n\r\n## Orders that cannot be canceled \r\n\r\nThe following situations do not allow order cancellation: \r\n\r\n- **Partial invoices:** [Partially invoiced](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) orders cannot be canceled. However, the customer can [change the order](https://developers" }, { "info": { "name": "VTex Register change on order", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/oms/pvt/orders/:orderId/changes", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "orderId", "value": "1172452900788-01", "type": "path", "description": "ID that identifies the order in the seller." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This request allows [changing an order](https://help.vtex.com/en/tutorial/changing-items-from-a-completed-order--tutorials_190) by:\r\n\r\n- Adding items to an order.\r\n\r\n- Removing items from an order.\r\n\r\n- Applying discounts to the total value of the order.\r\n\r\n- Incrementing the total value of the order. \r\n\r\n> **Timeout settings:** This is a synchronous API, which means the application requests data and waits until a value is returned. This behavior can cause timeout errors. To avoid them, we recom" }, { "info": { "name": "VTex Add log in orders", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/oms/pvt/orders/:orderId/interactions", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "orderId", "value": "1172452900788-01", "type": "path", "description": "Unique code that identifies an order." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a Log in Interactions Order Array." }, { "info": { "name": "VTex Get order", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/orders/pvt/document/:orderId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "orderId", "value": "", "type": "path", "description": "ID of the order." }, { "name": "reason", "value": "", "type": "query", "description": "Reason for requesting unmasked data." } ] }, "docs": "Retrieves order details by searching a specific order ID.\n\r\n\r>If you wish to retrieve unmasked data, use the `reason` parameter.\n\r\n\r> The `View order` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#).\n\r\n\r> Check the new [Orders onboarding guide](" }, { "info": { "name": "VTex List orders", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/orders/extendsearch/orders", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "f_hasInputInvoice", "value": "", "type": "query", "description": "Filters list to return only orders with non `null` values for the `invoiceInput` field." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieves a list of orders according to the filters described below.\n\r\n\r> This endpoint returns masked order data.\n\r\n\r> This should **not** be used for integrations. Use the [orders Feed or hook](https://developers.vtex.com/vtex-rest-api/docs/feed-v3-1) for this purpose.\n\r\n\rThis endpoint returns only orders that already have been indexed, which takes aproximately four minutes. Because of this, the data retrieved may present inconsistencies. To get live up to date information and [build order int" }, { "info": { "name": "VTex Start handling order", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/orders/pvt/document/:orderId/actions/start-handling", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "orderId", "value": "", "type": "path", "description": "ID of the order." } ] }, "docs": "Change the status of an order to indicate that is is in `handling`.\n\r\n\r> Expect a `status 204` response with no content in case of a successful request.\n\r\n\r> The `Change order workflow status` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#)." }, { "info": { "name": "VTex Cancel order", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/orders/pvt/document/:orderId/cancel", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "orderId", "value": "", "type": "path", "description": "ID of the order." } ], "body": { "type": "json", "data": "{}" } }, "docs": "You should use this endpoint to cancel an order by its `orderId`.\n\nA common scenario is one where the seller has a problem with the order fulfillment and needs to request the order cancellation to the marketplace. To do this, the seller would need to make this request, passing the `orderId` in the URL.\n\nYou should expect a response with the date when the notification was received, the orderId, and a receipt protocol code.\n\nBe aware that if the order status is already `Invoiced`, the order can on" } ] } ], "bundled": true }