VTEX User Orders API

The User Orders API from VTEX — 2 operation(s) for user orders.

Operations 2

GET /api/oms/user/orders VTex Retrieve user's orders #
GET /api/oms/user/orders/{orderId} VTex Retrieve user order details #

Documentation

📖
Documentation
https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works
📖
Documentation
https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet
📖
Documentation
https://developers.vtex.com/docs/guides/catalog-api-seller-portal-overview
📖
Documentation
https://developers.vtex.com/docs/guides/catalog-overview
📖
Documentation
https://developers.vtex.com/docs/guides/checkout-overview
📖
Documentation
https://help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0
📖
Documentation
https://help.vtex.com/en/tutorial/data-subject-rights--6imchxTx09icupKMbzHVIM
📖
Documentation
https://developers.vtex.com/docs/api-reference/do-api
📖
Documentation
https://developers.vtex.com/docs/guides/managing-vtex-gift-cards
📖
Documentation
https://developers.vtex.com/docs/guides/gift-card-integration-guide
📖
Documentation
https://developers.vtex.com/docs/guides/faststore/headless-cms-overview
📖
Documentation
https://developers.vtex.com/docs/api-reference/vtex-id-api
📖
Documentation
https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/3qgT47zY08biLP3d5os3DG
📖
Documentation
https://developers.vtex.com/docs/apps/vtex.search@1.0.8
📖
Documentation
https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/1oN446gRGcR2s70RvBCAmj
📖
Documentation
https://developers.vtex.com/docs/guides/search-overview
📖
Documentation
https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3
📖
Documentation
https://developers.vtex.com/docs/guides/fulfillment
📖
Documentation
https://developers.vtex.com/docs/guides/marketplace-overview
📖
Documentation
https://developers.vtex.com/updates/release-notes/marketplace-protocol-documentation-update
📖
Documentation
https://developers.vtex.com/docs/guides/external-marketplace-integration-guide
📖
Documentation
https://developers.vtex.com/docs/guides/external-seller-integration-connector
📖
Documentation
https://developers.vtex.com/docs/guides/external-seller-integration-guide
📖
Documentation
https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw
📖
Documentation
https://help.vtex.com/en/tutorial/understanding-the-message-center--tutorials_84
📖
Documentation
https://developers.vtex.com/docs/guides/orders-overview
📖
Documentation
https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data
📖
Documentation
https://help.vtex.com/en/tutorial/payment-provider-protocol--RdsT2spdq80MMwwOeEq0m
📖
Documentation
https://developers.vtex.com/docs/guides/payments-integration-guide
📖
Documentation
https://help.vtex.com/en/tutorial/vtex-pick-and-pack-last-mile--HN7WKV0xoq2ssVjsJlfzr
📖
Documentation
https://developers.vtex.com/docs/guides/vtex-io-documentation-policies
📖
Documentation
https://developers.vtex.com/docs/guides/pricing-hub
📖
Documentation
https://developers.vtex.com/docs/guides/pricing-overview
📖
Documentation
https://developers.vtex.com/docs/guides/profile-system
📖
Documentation
https://developers.vtex.com/docs/guides/promotions-overview
📖
Documentation
https://developers.vtex.com/docs/apps/vtex.reviews-and-ratings
📖
Documentation
https://developers.vtex.com/docs/guides/sent-offers-integration-guide-connectors
📖
Documentation
https://developers.vtex.com/docs/guides/sessions-system-overview
📖
Documentation
https://developers.vtex.com/docs/guides/vtex-shipping-network
📖
Documentation
https://help.vtex.com/en/tutorial/sku-bindings--1SmrVgNwjJX17hdqwLa0TX
📖
Documentation
https://developers.vtex.com/docs/guides/subscriptions
📖
Documentation
https://developers.vtex.com/docs/apps/vtex.search/suggestions
📖
Documentation
https://developers.vtex.com/docs/guides/vtex-tracking

Specifications

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/vtex-user-orders-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

vtex-user-orders-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: VTex Orders User Orders API
  description: 'Each purchase a customer makes in your store generates an [order](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) on VTEX. With the Orders API, you can view orders statuses and manage multiple aspects involved in order fulfillment, such as financial transactions, invoicing, shipping, and subscriptions. You can also [change orders](https://help.vtex.com/en/tutorial/changing-items-from-a-complete-order--tutorials_190) and make configurations to allow or forbid marketplaces and sellers to change or cancel orders.


    ### Order integration


    To automate actions related to order processing, you can [integrate orders](https://developers.vtex.com/docs/guides/erp-integration-guide) with systems like ERP (Enterprise Resource Planning) and WMS (Warehouse Management System) using [Feed and Hook](https://developers.vtex.com/docs/guides/orders-feed).


    ## Orders API Index


    ### Orders


    - `GET` [Get order](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders/-orderId-)

    - `GET` [List orders](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders)

    - `POST` [Start handling order](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/start-handling)

    - `POST` [Cancel order](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/cancel)

    - `POST` [Register change on order](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/changes)


    ### Invoice


    - `POST` [Order invoice notification](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/invoice)

    - `PATCH` [Update order''s partial invoice (send tracking number)](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-)


    ### Tracking


    - `PUT` [Update order tracking status](https://developers.vtex.com/docs/api-reference/orders-api#put-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-/tracking)


    ### Conversation


    - `GET` [Retrieve order conversation](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders/-orderId-/conversation-message)


    ### Payment


    - `GET` [Retrieve payment transaction](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/orders/-orderId-/payment-transaction)

    - `POST` [Send payment notification](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/payments/-paymentId-/payment-notification)


    ### Feed v2 (deprecated)


    - `GET` [Get feed order status](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/pvt/feed/orders/status)


    ### Feed v3


    - `GET` [Get feed configuration](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/orders/feed/config)

    - `POST` [Create or update feed configuration](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/feed/config)

    - `DELETE` [Delete feed configuration](https://developers.vtex.com/docs/api-reference/orders-api#delete-/api/orders/feed/config)

    - `GET` [Retrieve feed items](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/orders/feed)

    - `POST` [Commit feed items](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/feed)

    - `POST` [Test JSONata expression](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/expressions/jsonata)


    ### Order hook


    - `GET` [Get hook configuration](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/orders/hook/config)

    - `POST` [Create or update hook configuration](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/orders/hook/config)

    - `DELETE` [Delete hook configuration](https://developers.vtex.com/docs/api-reference/orders-api#delete-/api/orders/hook/config)


    ### User orders


    - `GET` [Retrieve user''s orders](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/user/orders)

    - `GET` [Retrieve user order details](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/oms/user/orders/-orderId-)


    ### Change seller


    - `GET` [Get window to change seller](https://developers.vtex.com/docs/api-reference/orders-api#get-/api/checkout/pvt/configuration/window-to-change-seller)

    - `POST` [Update window to change seller](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/checkout/pvt/configuration/window-to-change-seller)'
  contact: {}
  version: '1.0'
servers:
- url: https://{accountName}.{environment}.com.br
  description: VTEX server URL.
  variables:
    accountName:
      description: Name of the VTEX account. Used as part of the URL.
      default: apiexamples
    environment:
      description: Environment to use. Used as part of the URL.
      enum:
      - vtexcommercestable
      default: vtexcommercestable
security:
- appKey:
  - '{{appKey}}'
  appToken:
  - '{{appToken}}'
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. \n\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). \n\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. \n\n## Permissions\n\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:\n\n| **Product** | **Category** | **Resource** |\n| --------------- | ----------------- | ----------------- |\n| OMS | OMS access | **View order** |\n\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):\n\n| **Role** | **Resource** | \n| --------------- | ----------------- | \n| Call center operator | View order |\n| OMS - Read only | View order |\n\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). \n\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. \n\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). \n\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. \n\n## Permissions\n\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:\n\n| **Product** | **Category** | **Resource** |\n| --------------- | ----------------- | ----------------- |\n| OMS | OMS access | **View order** |\n\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):\n\n| **Role** | **Resource** | \n| --------------- | ----------------- | \n| Call center operator | View order |\n| OMS - Read only | View order |\n\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). \n\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
   

# --- truncated at 32 KB (162 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vtex/refs/heads/main/openapi/vtex-user-orders-api-openapi.yml