AmbienteQA

{"info":{"_postman_id":"3c5450a8-ab9c-496e-8a84-a56352753397","name":"VTEX - Orders API","description":"

VTEX OMS is the module in charge of Order Management, Affiliate configuration and Recurring Orders.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1464335","collectionId":"3c5450a8-ab9c-496e-8a84-a56352753397","publishedId":"Szezcre4","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-04-13T13:55:12.000Z"},"item":[{"name":"Orders","item":[{"name":"Get Order","id":"2e986649-9efe-4090-8b34-ce5ceca72807","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"INVZFNFDYQKGSGYUQWPFXMYGGOSIVUPXCICPFLYUABYOTDRJDVUBKMJVPOSQVWHEAMEKEJPFYUEWOJMCWIFZZOMPYHZQSHZDTTOHYHFTGPDPHMGFCQTNRIEMZPLXJZNQ"},{"key":"X-VTEX-API-AppKey","value":"vtexappkey-bazarhorizonte-INQSQG"}],"url":"https://bazarhorizonte.vtexcommercestable.com.br/api/oms/pvt/orders/1042532285830-01","description":"

Retrieve a order details by it Id

\n
know more about Orders in VTEX Help
\n

Throttling: Each account can make up to 5000 requests per minute.\n

\n\n

Request object has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`orderId`	string	Order Id

Response object has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`affiliateId`	string	Seller Name who was responsible for the order
`allowCancellation`	boolean	If Cancellation is allowed
`allowEdition`	boolean	If Order Edition is allowed
`approvedBy`	string	User who approved the order
`authorizedDate`	string	Authorized Order Date
`callCenterOperatorData`	string	Call Center Operator responsible for the order
`cancelReason`	string	Cancel Reason
`cancelledBy`	string	User who Cancelled the order
`changesAttachment`	object	Change details object
`changesData`	object	Array with each change
`discountValue`	integer	Change Discount Value
`incrementValue`	integer	Change Increment Value
`itemsAdded`	object	Added items details
`itemsRemoved`	object	Removed items details
`id`	integer	Changed SKU ID
`name`	string	Changed SKU Name
`price`	integer	Changed SKU Price
`quantity`	integer	Changed SKU Quantity
`unitMultiplier`	integer	Changed SKU Unit Multiplier
`reason`	string	Change Reason
`receipt`	object	Change receipt details object
`date`	string	Change receipt date
`orderId`	string	Change receipt order Id
`receipt`	object	Change receipt ID
`id`	string	Object Id, expect value \"changeAttachment\"
`clientProfileData`	object	Object with all Cliente Profile Data
`corporateDocument`	string	Client Corporate Document
`corporateName`	string	Client Corporate Name
`corporatePhone`	string	Cliente Corporate Telephone
`customerClass`	string	???
`document`	string	Client Document
`documentType`	string	Client Document Type
`email`	string	Client e-mail
`firstName`	string	Client First Name
`id`	string	Object ID, expected value \"clientProfileData\"
`isCorporate`	string	If the Client is a Corporate Client
`lastName`	string	Client Last Name
`phone`	string	Client Telephone
`stateInscription`	string	Client Corporate Inscription
`tradeName`	string	Client Corporate Trade Name
`userProfileId`	string	Client User Profile ID
`commercialConditionData`	string	???
`creationDate`	string	Order Creation Date
`customData`	object	Custom Data Object
`customApps`	object	Custom Apps details Object
`fields`	object	Custom App Fields
`id`	string	Custom App Id
`major`	integer	???
`emailTracked`	string	Client Conversation Tracker E-mail
`followUpEmail`	string	Responsible store e-mail
`giftRegistryData`	string	???
`hostname`	string	Account Hostname registered in License Manager
`invoiceData`	string	???
`invoicedDate`	string	Invoice Date
`isCheckedIn`	string	???
`isCompleted`	boolean	If is a Order Completed
`items`	object	Order Items Object
`additionalInfo`	string	Order Item Additional Info
`brandId`	string	Brand ID
`brandName`	string	Brand Name
`categoriesIds`	string	Item Category ID
`commercialConditionId`	string	Invoice Date
`dimension`	string	Item Dimension Object
`cubicweight`	string	Item Cubic Weight
`height`	string	Item Height
`length`	string	Item Length
`weight`	string	Item Weight
`width`	string	Item Width
`offeringInfo`	string	???
`offeringType`	string	???
`offeringTypeId`	string	???
`productClusterId`	string	All releated Product Clusters
`attachments`	object	Attachents Array
`content`	object	Attachment Content Custom Field
`name`	string	Attachment Name
`bundleItems`	object	Invoice Date
`commission`	string	Comission value registered to Seller
`components`	object	???
`detailUrl`	string	Product Slug URL
`ean`	string	SKU EAN
`freightCommission`	integer	Comission value registered to Seller
`id`	string	SKU Id
`imageUrl`	string	SKU Image URL
`isGift`	string	If this item is a gift in order context
`itemAttachment`	object	Attachment Object
`content`	object	Attachment Content Array
`name`	string	Attachment Name
`listPrice`	integer	Item List Price
`lockId`	string	Reservation ID
`manualPrice`	string	???
`measurementUnit`	string	Item Measurement Unit
`name`	string	Item Name
`offerings`	object	???
`params`	object	???
`preSaleDate`	string	Item Pre Sale Date
`price`	integer	Item Price
`priceDefinitions`	string	???
`priceTags`	object	Object with all price modifier
`identifier`	string	Price Tag ID
`isPercentual`	boolean	If the Price Tag is a Percentual modifier
`name`	string	Price Tag Name
`rawValue`	string	Price Tag Raw Value
`value`	string	Price Tag Value
`priceValidUntil`	object	???
`productId`	string	Item Product ID
`quantity`	integer	Item Quantity
`refId`	string	Item Reference ID
`rewardValue`	integer	Item Reward value
`seller`	string	Item Seller
`sellerSku`	string	Invoice Date
`sellingPrice`	integer	Item Selling Price
`shippingPrice`	string	Item Shipping Price
`tax`	integer	Item Tax
`taxCode`	string	Item Tax Code
`uniqueId`	string	Item Order Unique ID
`unitMultiplier`	integer	Item Unit Multipler
`lastChange`	string	Order Last Change Date
`lastMessage`	string	???
`marketingData`	string	Marketing Data Object
`coupon`	string	Order Disccount Coupon
`id`	string	Object ID, expected value \"marketingData\"
`marketingTags`	object	Marketing Tags Array
`utmCampaign`	string	UTM Campaign Parameters
`utmMedium`	string	UTM Medium Parameters
`utmPartner`	string	UTM Source Parameters
`utmSource`	string	UTM Source Parameters
`utmiCampaign`	string	UTMI Campaign Internal Parameters
`utmiPart`	string	UTMI Part Internal Parameters
`utmipage`	string	UTMI Page Internal Parameters
`marketplace`	object	Marketplace Details Object
`baseURL`	string	Marketplace Base URL
`isCertified`	string	If is a Certified Marketplace
`name`	string	Marketplace Name
`marketplaceItems`	object	Marketplace Details Object
`marketplaceOrderId`	string	Marketplace Order Id
`marketplaceServicesEndpoint`	string	Marketplace Services Endpoint
`merchantName`	string	Merchant Name
`openTextField`	object	Open Text Field Object
`value`	string	Open Text Field Value
`orderFormId`	string	Order Form Id
`orderGroup`	string	Order Group Id
`orderId`	string	Order Id
`origin`	string	Order Origin: \"Marketplace\" or \"Fulfillment\"
`packageAttachment`	object	Package Object
`packages`	object	Packages Details Object, populated after order invoiced
`cfop`	string	???
`courier`	string	Package selected Courier
`courierStatus`	string	Package Tracking Status
`data`	object	Package Tracking Timeline
`finished`	string	If the delivery are finished
`status`	string	Courier Status
`embeddedInvoice`	???
`invoiceKey`	string	Invoice Credencial Key
`invoiceNumber`	string	Package Invoice Number
`invoiceUrl`	string	Package Invoice URL
`invoiceValue`	string	Package Invoice Value
`issuanceDate`	string	Package Issuance Date
`items`	string	Items Package Array
`description`	string	Item Desciprtion
`itemIndex`	string	Item Index
`price`	string	Item Price
`quantity`	string	Item Quantity
`unitMultiplier`	string	Unit Multiplier
`trackingNumber`	string	Package Tracking Number
`trackingUrl`	string	Tracking Order URL
`type`	string	Invoice Type, expected values \"Output\" and \"Input\"
`paymentData`	object	Payment Object
`transactions`	object	Transactions Object
`isActive`	boolean	If the payment is Active
`merchantName`	string	Merchant Name
`payments`	object	Payment Object
`cardHolder`	string	Payment Card Holder
`cardNumber`	string	Payment Card Number
`connectorResponses`	object	Connector Responses Object
`Message`	string	Connector Responses Message
`ReturnCode`	string	Connector Return Code
`Tid`	string	Connector Transaction Id
`acquirer`	string	Connector Acquirer
`authId`	string	Connector Authorization Id
`cvv2`	string	???
`dueDate`	string	Payment Due Date
`expireMonth`	string	Payment Card expire Month
`expireYear`	string	Payment Card expire Year
`firstDigits`	string	Payment Card First Digits
`giftCardCaption`	string	Gift Card Caption
`giftCardId`	string	Gift Card Id
`giftCardName`	string	Gift Card Name
`group`	string	Payment Group
`id`	string	Payment Id
`installments`	string	Payment Installments Quantity
`lastDigits`	string	Payment Card Last Digits
`paymentSystem`	string	Payment System Type Id
`paymentSystemName`	string	Payment System Name
`redemptionCode`	string	Gift Card Redemption Code
`referenceValue`	string	Payment Reference Value
`tid`	string	Payment Transaction Id
`url`	string	Payment URL
`value`	string	Payment Value
`transactionId`	string	Transaction Id
`ratesAndBenefitsData`	string	Rates and Benefits Data Object
`id`	string	Object ID, expected value \"ratesAndBenefitsData\"
`rateAndBenefitsIdentifiers`	object	Rates and Benefits Details Object
`additionalInfo`	string	Rates and Benefits Additional Info
`description`	string	Rates and Benefits Description
`featured`	string	If is allowed to acumulate the Rates and Benefits
`matchedParameters`	object	March Parameters Array
`name`	string	Rates and Benefits Name
`roundingError`	integer	Rounding Error Total Amount
`salesChannel`	string	Order Sales Channel Id
`sellerOrderId`	string	Order Seller Id
`sellers`	object	Sellers Array
`id`	string	Seller Id
`logo`	string	URL Seller Logo
`name`	string	Seller Name
`sequence`	string	Order Sequence ID
`shippingData`	object	Shipping Data Object
`address`	object	Shipping Address
`addressId`	string	Shipping Address Id
`addressType`	string	Shipping Address Type
`city`	string	Shipping City
`complement`	string	Shipping Complement
`country`	string	Shipping Country in ISO 3166 ALPHA-3 abbreviation
`geoCoordinates`	object	Shipping Geo Coordinates Array
`neighborhood`	string	Shipping Neighborhood
`number`	string	Shipping Number
`postalCode`	string	Shipping Postal Code
`receiverName`	string	Shipping Receiver Name
`reference`	string	Shipping Reference
`state`	string	Shipping State
`street`	string	Shipping Street
`id`	string	Object ID, expected value \"shippingData\"
`logisticsInfo`	object	Logistics Info Object
`addressId`	string	Adress Id
`deliveryChannel`	string	Delivery Channel, allowed values \"delivery\" or \"pickup-in-point\"
`deliveryCompany`	string	Courier Company Name
`deliveryIds`	object	Delivery Ids Object
`courierId`	string	Courier Id
`courierName`	string	Courier Name
`dockId`	string	Releated Dock Id
`quantity`	integer	Items Quantity
`warehouseId`	string	Releated Warehouse Id
`deliveryWindow`	object	Delivery Window Object
`endDateUtc`	string	Delivery Date End in UTC
`price`	string	Delivery Window Cost
`startDateUtc`	string	Delivery Date Starts in UTC
`itemIndex`	integer	Logistic Info Item Index
`listPrice`	integer	Logistic Info Item List Price
`lockTTL`	string	???
`pickupStoreInfo`	object	Pickup Store Info Object
`additionalInfo`	string	Pickup Store Additional Info
`address`	string	Pickup Store Address
`dockId`	string	Pickup Store Releated Dock Id
`friendlyName`	string	Pickup Store Friendly Name
`isPickupStore`	boolean	If is a Pickup Store
`polygonName`	string	Releated Polygom Name
`price`	integer	Logistic Info Item Price
`selectedSla`	string	Selected SLA
`sellingPrice`	integer	Logistic Info Item Selling Price
`shippingEstimate`	string	Estimate Shipping Duration
`shippingEstimateDate`	string	Estimate Shipping Date
`shipsTo`	object	Shipping Country in ISO 3166 ALPHA-3 abbreviation
`slas`	object	SLAs Object
`deliveryChannel`	string	Delivery Channel, allowed values \"delivery\" or \"pickup-in-point\"
`deliveryWindow`	object	Delivery Window Object
`endDateUtc`	string	Delivery Date End in UTC
`price`	string	Delivery Window Cost
`startDateUtc`	string	Delivery Date Starts in UTC
`id`	string	SLA Id
`pickupStoreInfo`	object	Pickup Store Details Object
`additionalInfo`	string	Pickup Store Additional Info
`address`	string	Pickup Store Address
`dockId`	string	Pickup Store releated Dock Id
`friendlyName`	string	Pickup Store Friendly Name
`isPickupStore`	boolean	If is a Pickup Store
`polygonName`	string	Releated Polygon Name
`price`	integer	SLA Price
`shippingEstimate`	string	SLA Shipping Estimate
`selectedAddresses`	object	Selected Address Details Object
`addressId`	string	Shipping Address Id
`addressType`	string	Shipping Address Type
`city`	string	Shipping City
`complement`	string	Shipping Complement
`country`	string	Shipping Country in ISO 3166 ALPHA-3 abbreviation
`geoCoordinates`	object	Shipping Geo Coordinates Array
`neighborhood`	string	Shipping Neighborhood
`number`	string	Shipping Number
`postalCode`	string	Shipping Postal Code
`receiverName`	string	Shipping Receiver Name
`reference`	string	Shipping Reference
`state`	string	Shipping State
`street`	string	Shipping Street
`trackingHints`	string	???
`status`	string	Order Status
`statusDescription`	string	Status Description
`storePreferencesData`	object	Store Preferences Data Object
`countryCode`	string	Country Code in ISO 3166 ALPHA-3 abbreviation
`currencyCode`	string	Currency Code in ISO 4217
`currencyFormatInfo`	object	Currency Format Info Object
`CurrencyDecimalDigits`	integer	Currency Decimal Digits
`CurrencyDecimalSeparator`	string	Currency Decimal Separator
`CurrencyGroupSeparator`	string	Currency Group Separator
`CurrencyGroupSize`	integer	Currency Group Size
`StartsWithCurrencySymbol`	boolean	If Starts With Currency Symbol
`currencyLocale`	integer	LCID Decimal
`currencySymbol`	string	Currency Symbol
`timeZone`	string	Order Time Zone
`totals`	object	Totals Object
`id`	string	Totals Ids, expected values: \"Items\", \"Discounts\", \"Shipping\" and \"Tax\"
`name`	string	Totals ID Description
`value`	integer	Totals Value
`value`	integer	Order Value

Authentication

This is a private API and need a appKey and appToken with admin access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","oms","pvt","orders","1042532285830-01"],"host":["bazarhorizonte","vtexcommercestable","com","br"],"query":[],"variable":[]}},"response":[{"id":"09fd8bff-9500-464e-b380-de455fc66717","name":"Get Order","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"url":"https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders/v5195004lux-01"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"emailTracked\": \"a27499cad31f42b7a771ae34f57c8358@ct.vtex.com.br\",\n \"approvedBy\": null,\n \"cancelledBy\": null,\n \"cancelReason\": null,\n \"orderId\": \"v5195004lux-01\",\n \"sequence\": \"502556\",\n \"marketplaceOrderId\": \"\",\n \"marketplaceServicesEndpoint\": \"http://oms.vtexinternal.com.br/api/oms?an=luxstore\",\n \"sellerOrderId\": \"00-v5195004lux-01\",\n \"origin\": \"Marketplace\",\n \"affiliateId\": \"\",\n \"salesChannel\": \"1\",\n \"merchantName\": null,\n \"status\": \"handling\",\n \"statusDescription\": \"Preparando Entrega\",\n \"value\": 1160,\n \"creationDate\": \"2019-01-28T20:09:43.8999580+00:00\",\n \"lastChange\": \"2019-02-06T20:46:11.7010747+00:00\",\n \"orderGroup\": null,\n \"totals\": [\n {\n \"id\": \"Items\",\n \"name\": \"Total dos Itens\",\n \"value\": 3290\n },\n {\n \"id\": \"Discounts\",\n \"name\": \"Total dos Descontos\",\n \"value\": 0\n },\n {\n \"id\": \"Shipping\",\n \"name\": \"Total do Frete\",\n \"value\": 1160\n },\n {\n \"id\": \"Tax\",\n \"name\": \"Total da Taxa\",\n \"value\": 0\n },\n {\n \"id\": \"Change\",\n \"name\": \"Total das mudanças\",\n \"value\": -3290\n }\n ],\n \"items\": [\n {\n \"uniqueId\": \"87F0945396994B349158C7D9C9941442\",\n \"id\": \"1234568358\",\n \"productId\": \"9429485\",\n \"ean\": null,\n \"lockId\": \"00-v5195004lux-01\",\n \"itemAttachment\": {\n \"content\": {},\n \"name\": null\n },\n \"attachments\": [],\n \"quantity\": 1,\n \"seller\": \"1\",\n \"name\": \"Bay Max L\",\n \"refId\": \"BIGHEROBML\",\n \"price\": 3290,\n \"listPrice\": 3290,\n \"manualPrice\": null,\n \"priceTags\": [],\n \"imageUrl\": \"http://luxstore.vteximg.com.br/arquivos/ids/159263-55-55/image-cc1aed75cbfa424a85a94900be3eacec.jpg?v=636795432619830000\",\n \"detailUrl\": \"/bay-max-9429485/p\",\n \"components\": [],\n \"bundleItems\": [],\n \"params\": [],\n \"offerings\": [],\n \"sellerSku\": \"1234568358\",\n \"priceValidUntil\": null,\n \"commission\": 0,\n \"tax\": 0,\n \"preSaleDate\": null,\n \"additionalInfo\": {\n \"brandName\": \"VTEX\",\n \"brandId\": \"2000023\",\n \"categoriesIds\": \"/1/\",\n \"productClusterId\": \"135,142\",\n \"commercialConditionId\": \"5\",\n \"dimension\": {\n \"cubicweight\": 0.7031,\n \"height\": 15,\n \"length\": 15,\n \"weight\": 15,\n \"width\": 15\n },\n \"offeringInfo\": null,\n \"offeringType\": null,\n \"offeringTypeId\": null\n },\n \"measurementUnit\": \"un\",\n \"unitMultiplier\": 1,\n \"sellingPrice\": 3290,\n \"isGift\": false,\n \"shippingPrice\": null,\n \"rewardValue\": 0,\n \"freightCommission\": 0,\n \"priceDefinitions\": null,\n \"taxCode\": null,\n \"parentItemIndex\": null,\n \"parentAssemblyBinding\": null\n }\n ],\n \"marketplaceItems\": [],\n \"clientProfileData\": {\n \"id\": \"clientProfileData\",\n \"email\": \"rodrigo.cunha@vtex.com.br\",\n \"firstName\": \"Rodrigo\",\n \"lastName\": \"VTEX\",\n \"documentType\": \"cpf\",\n \"document\": \"11047867702\",\n \"phone\": \"+5521972321094\",\n \"corporateName\": null,\n \"tradeName\": null,\n \"corporateDocument\": null,\n \"stateInscription\": null,\n \"corporatePhone\": null,\n \"isCorporate\": false,\n \"userProfileId\": \"5a3692de-358a-4bea-8885-044bce33bb93\",\n \"customerClass\": null\n },\n \"giftRegistryData\": null,\n \"marketingData\": null,\n \"ratesAndBenefitsData\": {\n \"id\": \"ratesAndBenefitsData\",\n \"rateAndBenefitsIdentifiers\": []\n },\n \"shippingData\": {\n \"id\": \"shippingData\",\n \"address\": {\n \"addressType\": \"residential\",\n \"receiverName\": \"Rodrigo Cunha\",\n \"addressId\": \"-1425945657910\",\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Praia de Botafogo\",\n \"number\": \"300\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"3\",\n \"reference\": null,\n \"geoCoordinates\": []\n },\n \"logisticsInfo\": [\n {\n \"itemIndex\": 0,\n \"selectedSla\": \"Normal\",\n \"lockTTL\": \"10d\",\n \"price\": 1160,\n \"listPrice\": 1160,\n \"sellingPrice\": 1160,\n \"deliveryWindow\": null,\n \"deliveryCompany\": \"Todos os CEPS\",\n \"shippingEstimate\": \"5bd\",\n \"shippingEstimateDate\": \"2019-02-04T20:33:46.4595004+00:00\",\n \"slas\": [\n {\n \"id\": \"Normal\",\n \"name\": \"Normal\",\n \"shippingEstimate\": \"5bd\",\n \"deliveryWindow\": null,\n \"price\": 1160,\n \"deliveryChannel\": \"delivery\",\n \"pickupStoreInfo\": {\n \"additionalInfo\": null,\n \"address\": null,\n \"dockId\": null,\n \"friendlyName\": null,\n \"isPickupStore\": false\n },\n \"polygonName\": null\n },\n {\n \"id\": \"Expressa\",\n \"name\": \"Expressa\",\n \"shippingEstimate\": \"5bd\",\n \"deliveryWindow\": null,\n \"price\": 1160,\n \"deliveryChannel\": \"delivery\",\n \"pickupStoreInfo\": {\n \"additionalInfo\": null,\n \"address\": null,\n \"dockId\": null,\n \"friendlyName\": null,\n \"isPickupStore\": false\n },\n \"polygonName\": null\n },\n {\n \"id\": \"Quebra Kit\",\n \"name\": \"Quebra Kit\",\n \"shippingEstimate\": \"2bd\",\n \"deliveryWindow\": null,\n \"price\": 1392,\n \"deliveryChannel\": \"delivery\",\n \"pickupStoreInfo\": {\n \"additionalInfo\": null,\n \"address\": null,\n \"dockId\": null,\n \"friendlyName\": null,\n \"isPickupStore\": false\n },\n \"polygonName\": null\n },\n {\n \"id\": \"Sob Encomenda\",\n \"name\": \"Sob Encomenda\",\n \"shippingEstimate\": \"32bd\",\n \"deliveryWindow\": null,\n \"price\": 1392,\n \"deliveryChannel\": \"delivery\",\n \"pickupStoreInfo\": {\n \"additionalInfo\": null,\n \"address\": null,\n \"dockId\": null,\n \"friendlyName\": null,\n \"isPickupStore\": false\n },\n \"polygonName\": null\n }\n ],\n \"shipsTo\": [\n \"BRA\"\n ],\n \"deliveryIds\": [\n {\n \"courierId\": \"197a56f\",\n \"courierName\": \"Todos os CEPS\",\n \"dockId\": \"1\",\n \"quantity\": 1,\n \"warehouseId\": \"1_1\"\n }\n ],\n \"deliveryChannel\": \"delivery\",\n \"pickupStoreInfo\": {\n \"additionalInfo\": null,\n \"address\": null,\n \"dockId\": null,\n \"friendlyName\": null,\n \"isPickupStore\": false\n },\n \"addressId\": \"-1425945657910\",\n \"polygonName\": null\n }\n ],\n \"trackingHints\": null,\n \"selectedAddresses\": [\n {\n \"addressId\": \"-1425945657910\",\n \"addressType\": \"residential\",\n \"receiverName\": \"Rodrigo Cunha\",\n \"street\": \"Praia de Botafogo\",\n \"number\": \"518\",\n \"complement\": \"10\",\n \"neighborhood\": \"Botafogo\",\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"reference\": null,\n \"geoCoordinates\": []\n }\n ]\n },\n \"paymentData\": {\n \"transactions\": [\n {\n \"isActive\": true,\n \"transactionId\": \"418213DE29634837A63DD693A937A696\",\n \"merchantName\": \"luxstore\",\n \"payments\": [\n {\n \"id\": \"D3DEECAB3C6C4B9EAF8EF4C1FE062FF3\",\n \"paymentSystem\": \"6\",\n \"paymentSystemName\": \"Boleto Bancário\",\n \"value\": 4450,\n \"installments\": 1,\n \"referenceValue\": 4450,\n \"cardHolder\": null,\n \"cardNumber\": null,\n \"firstDigits\": null,\n \"lastDigits\": null,\n \"cvv2\": null,\n \"expireMonth\": null,\n \"expireYear\": null,\n \"url\": \"https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}\",\n \"giftCardId\": null,\n \"giftCardName\": null,\n \"giftCardCaption\": null,\n \"redemptionCode\": null,\n \"group\": \"bankInvoice\",\n \"tid\": null,\n \"dueDate\": \"2019-02-02\",\n \"connectorResponses\": {}\n }\n ]\n }\n ]\n },\n \"packageAttachment\": {\n \"packages\": []\n },\n \"sellers\": [\n {\n \"id\": \"1\",\n \"name\": \"Loja do Suporte\",\n \"logo\": \"\"\n }\n ],\n \"callCenterOperatorData\": null,\n \"followUpEmail\": \"7bf3a59bbc56402c810bda9521ba449e@ct.vtex.com.br\",\n \"lastMessage\": null,\n \"hostname\": \"luxstore\",\n \"invoiceData\": null,\n \"changesAttachment\": {\n \"id\": \"changeAttachment\",\n \"changesData\": [\n {\n \"reason\": \"Blah\",\n \"discountValue\": 3290,\n \"incrementValue\": 0,\n \"itemsAdded\": [],\n \"itemsRemoved\": [\n {\n \"id\": \"1234568358\",\n \"name\": \"Bay Max L\",\n \"quantity\": 1,\n \"price\": 3290,\n \"unitMultiplier\": null\n }\n ],\n \"receipt\": {\n \"date\": \"2019-02-06T20:46:04.4003606+00:00\",\n \"orderId\": \"v5195004lux-01\",\n \"receipt\": \"029f9ab8-751a-4b1e-bf81-7dd25d14b49b\"\n }\n }\n ]\n },\n \"openTextField\": null,\n \"roundingError\": 0,\n \"orderFormId\": \"caae7471333e403f959fa5fd66951340\",\n \"commercialConditionData\": null,\n \"isCompleted\": true,\n \"customData\": null,\n \"storePreferencesData\": {\n \"countryCode\": \"BRA\",\n \"currencyCode\": \"BRL\",\n \"currencyFormatInfo\": {\n \"CurrencyDecimalDigits\": 2,\n \"CurrencyDecimalSeparator\": \",\",\n \"CurrencyGroupSeparator\": \".\",\n \"CurrencyGroupSize\": 3,\n \"StartsWithCurrencySymbol\": true\n },\n \"currencyLocale\": 1046,\n \"currencySymbol\": \"R$\",\n \"timeZone\": \"E. South America Standard Time\"\n },\n \"allowCancellation\": false,\n \"allowEdition\": false,\n \"isCheckedIn\": false,\n \"marketplace\": {\n \"baseURL\": \"http://oms.vtexinternal.com.br/api/oms?an=luxstore\",\n \"isCertified\": null,\n \"name\": \"luxstore\"\n },\n \"authorizedDate\": \"2019-01-28T20:33:04.0000000+00:00\",\n \"invoicedDate\": null\n}"}],"_postman_id":"2e986649-9efe-4090-8b34-ce5ceca72807"},{"name":"List Orders","id":"632238d0-6695-4cf0-9951-9b9c3e4ddd70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"url":"https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders","description":"

Retrieve a list of orders according to the filters

\n
know more about Orders in VTEX Help
\n

Throttling: Each account can make up to 5000 requests per minute.\n

\n\n

Request parameters allowed:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`orderBy`	string	Order Field and Order Type concatenated `orderBy={{OrderField}},{{OrderType}}`
`OrderField`	string	Order Field expected values: `creationDate`,`orderId`,`items`,`totalValue` and `origin`
`OrderType`	string	Order Type expected values: `asc` and `desc`

Sorting Examples

CreationDate:

/api/oms/pvt/orders?orderBy=creationDate,desc\n

OrderID:

/api/oms/pvt/orders?orderBy=orderId,desc\n

Items:

/api/oms/pvt/orders?orderBy=items,asc\n

TotalValue:

/api/oms/pvt/orders?orderBy=totalValue,desc\n

Origin:

/api/oms/pvt/orders?orderBy=origin,asc\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`page`	integer	Page Number

Pagination Examples:

/api/oms/pvt/orders?page=3\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`per_page`	integer	Quantity orders per page

Quantity per Page Examples:

/api/oms/pvt/orders?per_page=15\n

Pagination Limit: The limit of pages that can be requested is 30.\n

\n\n\n\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`utc`	integer	Time Zone

Time Zone Example:

/api/oms/pvt/orders?per_page=15\n

Request filters

Fulltext

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`q`	string	Fulltext accepts Order Ids, Client E-mail, Client Document and Client Name

\n
The \"+\" caracter isn't allowed in Fulltext Search
\n

Fulltext filter Examples:

OrderID:

/api/oms/pvt/orders?q=v212333lux-02\n

Email:

/api/oms/pvt/orders?q=rodrigo.cunha@vtex.com\n

Document:

/api/oms/pvt/orders?q=21133355524\n

ClientName:

/api/oms/pvt/orders?q=Cunha\n

Shipping Estimate

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`f_shippingEstimate`	string	Concatened value of quantity days and sufix `.days`

Shipping Estimate filter Examples:

Next 7 days:

/api/oms/pvt/orders?f_shippingEstimate=7.days\n

Tomorrow:

/api/oms/pvt/orders?f_shippingEstimate=1.days\n

Today:

/api/oms/pvt/orders?f_shippingEstimate=0.days\n

Late:

/api/oms/pvt/orders?f_shippingEstimate=-1.days\n

Invoiced Date

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`f_invoicedDate`	string	Concatened value sufix `invoicedDate` and range date in Timestamp format

Invoiced Date filter Examples:

1 Day:

/api/oms/pvt/orders?f_invoicedDate=invoicedDate:[2017-01-01T02:00:00.000Z TO 2017-01-02T01:59:59.999Z]\n

1 Month:

/api/oms/pvt/orders?f_invoicedDate=invoicedDate:[2017-01-01T02:00:00.000Z TO 2017-02-01T01:59:59.999Z]\n

1 Year:

/api/oms/pvt/orders?f_invoicedDate=invoicedDate:[2016-01-01T02:00:00.000Z TO 2017-01-01T01:59:59.999Z]\n

Order Date

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`f_creationDate`	string	Concatened value sufix `creationDate` and range date in Timestamp format

Order Date filter Examples:

1 Day:

/api/oms/pvt/orders?f_creationDate=creationDate:[2017-01-01T02:00:00.000Z TO 2017-01-02T01:59:59.999Z]\n

1 Month:

/api/oms/pvt/orders?f_creationDate=creationDate:[2017-01-01T02:00:00.000Z TO 2017-02-01T01:59:59.999Z]\n

1 Year:

/api/oms/pvt/orders?f_creationDate=creationDate:[2016-01-01T02:00:00.000Z TO 2017-01-01T01:59:59.999Z]\n

Authorized Date

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`f_authorizedDate`	string	Concatened value sufix `authorizedDate` and range date in Timestamp format

Authorized Date filter Examples:

1 Day:

/api/oms/pvt/orders?f_authorizedDate=authorizedDate:[2017-01-01T02:00:00.000Z TO 2017-01-02T01:59:59.999Z]\n

1 Month:

/api/oms/pvt/orders?f_authorizedDate=authorizedDate:[2017-01-01T02:00:00.000Z TO 2017-02-01T01:59:59.999Z]\n

1 Year:

/api/oms/pvt/orders?f_authorizedDate=authorizedDate:[2016-01-01T02:00:00.000Z TO 2017-01-01T01:59:59.999Z]\n

UTMs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`f_UtmSource`	string	UTM Source value

Channels filter Examples:

/api/oms/pvt/orders?f_UtmSource=buscape_campaign\n

Seller

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`f_sellerNames`	string	Seller Name value

Seller filter Examples:

/api/oms/pvt/orders?f_sellerNames=Fast+Shop\n

Call Center Operator

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`f_callCenterOperatorName`	string	Call Center Operator Value

Call Center Operator filter Examples:

/api/oms/pvt/orders?f_callCenterOperatorName=Operator%20Name\n

Sales Channel Name

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`f_salesChannel`	string	Sales Channel Name Value

Sales Channel Name filter Examples:

/api/oms/pvt/orders?f_salesChannel=Main\n

Sales Channel ID

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`salesChannelId`	string	Sales Channel ID Value

Sales Channel ID filter Examples:

/api/oms/pvt/orders?salesChannelId=1\n

Affiliate ID

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`f_affiliateId`	string	Affiliate ID Value

Affiliate ID filter Examples:

/api/oms/pvt/orders?f_affiliateId=WLM\n

Order Status

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`f_status`	string	Order Status Value

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Order Status avaible to filter
`waiting-for-sellers-confirmation`
`payment-pending`
`payment-approved`
`ready-for-handling`
`handling`
`invoiced`
`canceled`

Order Status filter Examples:

/api/oms/pvt/orders?f_status=ready-for-handling\n

Order Status Description

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`f_statusDescription`	string	Order Status Description Value

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Order Status Description avaible to filter
`Aguardando+autorização+para+despachar`
`Pagamento+Pendente`
`Pagamento+Aprovado`
`Pronto+para+o+manuseio`
`Preparando+Entrega`
`Faturado`
`Cancelado`

Order Status Description filter Examples:

/api/oms/pvt/orders?f_statusDescription=Pronto+para+o+manuseio\n

Order Situation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`incompleteOrders`	boolean	If is a Incomplete Order

\n
know more about Incomplete Orders in VTEX Help
\n

Order Situation filter Examples:

/api/oms/pvt/orders?incompleteOrders=true\n

Error Situation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`incompleteOrders`	boolean	Error Situation Type

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Situation Values avaible to filter
`all`
`perm`
`temp`

Error Situation filter Examples:

/api/oms/pvt/orders?filterError=all\n

Payment Type Name

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`f_paymentNames`	string	Payment Type Value

Payment Type Name filter Examples:

/api/oms/pvt/orders?f_paymentNames=Visa\n

Rates and Benefits Name

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`f_RnB`	string	Rates and Benefits Name

Rates and Benefits filter Examples:

/api/oms/pvt/orders?f_RnB=\"Free+Shipping\"\n

Search Field

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`searchField`	string	Affiliate ID Value
`sku_Ids&sku_Ids`	integer	SKU ID
`listId&listId`	integer	Gift List ID
`tid&tid`	integer	Transaction ID (TID)
`pci_tid&pci_tid`	integer	PCI Connector's Transaction ID (TID)
`paymentId&paymentId`	integer	Payment ID (PID)
`nsu&nsu`	integer	Connector's NSU

Search Field filter Examples:

SKU ID:

/api/oms/pvt/orders?searchField=sku_Ids&sku_Ids=11223\n

Gift List ID:

/api/oms/pvt/orders?searchField=listId&listId=11223\n

Transaction ID (TID):

/api/oms/pvt/orders?searchField=tid&tid=54546300238810034995829230012\n

PCI Connector's Transaction ID (TID):

/api/oms/pvt/orders?searchField=pci_tid&pci_tid=7032909234899834298423209\n

Payment ID (PID):

/api/oms/pvt/orders?searchField=paymentId&paymentId=2\n

Connector's NSU:

/api/oms/pvt/orders?searchField=nsu&nsu=2437281\n

Response object has the following properties:

Attribute	Type	Description
`list`	object	Order List Object
`shippingEstimateDate`	string	Estimate Shipping Date
`affiliateId`	string	Seller Name who was responsible for the order
`authorizedDate`	string	Authorized Order Date
`callCenterOperatorData`	string	Call Center Operator responsible for the order
`name`	string	Client Name
`creationDate`	string	Order Creation Date
`currencyCode`	string	Currency Code in ISO 4217
`items`	object	Obsolete Field
`lastMessageUnread`	string	Last sent transactional message
`listId`	string	Releated Gift List Id
`listType`	string	Releated Gift List Type
`marketplaceOrderId`	string	Marketplace Order Id
`orderId`	string	Change receipt order Id
`orderIsComplete`	boolean	If is a Order Completed
`origin`	string	Order Origin: \"Marketplace\" or \"Fulfillment\"
`paymentNames`	string	Payment System Name
`salesChannel`	string	Order Sales Channel Id
`sequence`	string	Order Sequence ID
`status`	string	Order Status
`statusDescription`	string	Status Description
`totalItems`	integer	Total Order Items
`totalValue`	integer	Total Value Amount
`workflowInErrorState`	boolean	If is a Work Flow Error
`workflowInRetry`	boolean	If is in a Work Flow Retry
`paging`	object	Paging Details Object
`pages`	integer	Paging Total Pages
`perPage`	integer	Paging total per Page
`total`	integer	Total Result
`stats`	object	Results segmented by `totalItems` and `totalValue`
`totalItems`	integer	Total Order Items segmeted by `currencyCode` and `origin`
`totalValue`	integer	Total Value Amount segmeted by `currencyCode` and `origin`
`currencyCode`	string	Currency Code in ISO 4217
`origin`	string	Order Origin: \"Marketplace\" or \"Fulfillment\"
`Count`	integer	Orders Count
`Facets`	object	Grouping Object
`Max`	object	Paging Details Object
`Mean`	object	Paging Details Object
`Min`	object	Paging Details Object
`Missing`	object	Paging Details Object
`StdDev`	object	Paging Details Object
`Sum`	object	Paging Details Object
`SumOfSquares`	object	Paging Details Object

As of October 3, 2018, this API will not return the \"items\" property.\n

\n\n

Authentication

This is a private API and need a appKey and appToken with admin access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","oms","pvt","orders"],"host":["{{accountName}}","{{environment}}","com","br"],"query":[],"variable":[]}},"response":[{"id":"677dfa30-ead1-451c-9809-6c60fb538835","name":"List Orders","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","description":"The mime type of this content"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"url":{"raw":"https://luxstore.{{environment}}.com.br/api/oms/pvt/orders?_stats=1&f_creationDate=creationDate:%5B2018-08-08T03:00:00.000Z+TO+2019-02-09T01:59:59.999Z%5D&orderBy=creationDate,desc&page=1&utc=-0200","protocol":"https","host":["luxstore","{{environment}}","com","br"],"path":["api","oms","pvt","orders"],"query":[{"key":"_stats","value":"1"},{"key":"f_creationDate","value":"creationDate:%5B2018-08-08T03:00:00.000Z+TO+2019-02-09T01:59:59.999Z%5D"},{"key":"orderBy","value":"creationDate,desc"},{"key":"page","value":"1"},{"key":"utc","value":"-0200"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 13 Feb 2017 15:25:12 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx","name":"Server","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-CDNIgnore","value":"1","name":"X-CDNIgnore","description":""},{"key":"X-Powered-by-VTEX-Janus-Edge","value":"v1.35.3","name":"X-Powered-by-VTEX-Janus-Edge","description":""},{"key":"X-Track","value":"stable","name":"X-Track","description":""},{"key":"X-VTEX-Janus-Router-Backend-App","value":"omsapi-v1.5.135","name":"X-VTEX-Janus-Router-Backend-App","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"list\": [\r\n {\r\n \"orderId\": \"v502559llux-01\",\r\n \"creationDate\": \"2019-02-04T10:29:11.0000000+00:00\",\r\n \"clientName\": \"J C\",\r\n \"items\": null,\r\n \"totalValue\": 7453,\r\n \"paymentNames\": \"Boleto Bancário\",\r\n \"status\": \"invoiced\",\r\n \"statusDescription\": \"Faturado\",\r\n \"marketPlaceOrderId\": null,\r\n \"sequence\": \"502559\",\r\n \"salesChannel\": \"1\",\r\n \"affiliateId\": \"\",\r\n \"origin\": \"Marketplace\",\r\n \"workflowInErrorState\": false,\r\n \"workflowInRetry\": false,\r\n \"lastMessageUnread\": \" Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502559llux-01 Olá, J. Estamos empacotando seu produto para providenci\",\r\n \"ShippingEstimatedDate\": null,\r\n \"ShippingEstimatedDateMax\": null,\r\n \"ShippingEstimatedDateMin\": null,\r\n \"orderIsComplete\": true,\r\n \"listId\": null,\r\n \"listType\": null,\r\n \"authorizedDate\": \"2019-02-07T21:29:54.0000000+00:00\",\r\n \"callCenterOperatorName\": null,\r\n \"totalItems\": 1,\r\n \"currencyCode\": \"BRL\"\r\n },\r\n {\r\n \"orderId\": \"v502556llux-01\",\r\n \"creationDate\": \"2019-01-28T20:09:43.0000000+00:00\",\r\n \"clientName\": \"Rodrigo VTEX\",\r\n \"items\": null,\r\n \"totalValue\": 1160,\r\n \"paymentNames\": \"Boleto Bancário\",\r\n \"status\": \"handling\",\r\n \"statusDescription\": \"Preparando Entrega\",\r\n \"marketPlaceOrderId\": null,\r\n \"sequence\": \"502556\",\r\n \"salesChannel\": \"1\",\r\n \"affiliateId\": \"\",\r\n \"origin\": \"Marketplace\",\r\n \"workflowInErrorState\": false,\r\n \"workflowInRetry\": false,\r\n \"lastMessageUnread\": \" Lux Store Seu pedido foi alterado! Pedido realizado em: 28/01/2019 Olá, Rodrigo. Seu pedido foi alterado. Seguem informações abaixo: \",\r\n \"ShippingEstimatedDate\": \"2019-02-04T20:33:46.0000000+00:00\",\r\n \"ShippingEstimatedDateMax\": null,\r\n \"ShippingEstimatedDateMin\": null,\r\n \"orderIsComplete\": true,\r\n \"listId\": null,\r\n \"listType\": null,\r\n \"authorizedDate\": \"2019-01-28T20:33:04.0000000+00:00\",\r\n \"callCenterOperatorName\": null,\r\n \"totalItems\": 1,\r\n \"currencyCode\": \"BRL\"\r\n },\r\n {\r\n \"orderId\": \"v502553llux-01\",\r\n \"creationDate\": \"2019-01-24T12:35:19.0000000+00:00\",\r\n \"clientName\": \"test test\",\r\n \"items\": null,\r\n \"totalValue\": 10150,\r\n \"paymentNames\": \"Mastercard\",\r\n \"status\": \"ready-for-handling\",\r\n \"statusDescription\": \"Pronto para o manuseio\",\r\n \"marketPlaceOrderId\": null,\r\n \"sequence\": \"502554\",\r\n \"salesChannel\": \"1\",\r\n \"affiliateId\": \"\",\r\n \"origin\": \"Marketplace\",\r\n \"workflowInErrorState\": false,\r\n \"workflowInRetry\": false,\r\n \"lastMessageUnread\": \" Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502553llux-01 Olá, test. Estamos empacotando seu produto para provide\",\r\n \"ShippingEstimatedDate\": \"2019-01-31T12:36:30.0000000+00:00\",\r\n \"ShippingEstimatedDateMax\": null,\r\n \"ShippingEstimatedDateMin\": null,\r\n \"orderIsComplete\": true,\r\n \"listId\": null,\r\n \"listType\": null,\r\n \"authorizedDate\": \"2019-01-24T12:36:01.0000000+00:00\",\r\n \"callCenterOperatorName\": null,\r\n \"totalItems\": 1,\r\n \"currencyCode\": \"BRL\"\r\n },\r\n {\r\n \"orderId\": \"v502550llux-01\",\r\n \"creationDate\": \"2019-01-23T16:39:45.0000000+00:00\",\r\n \"clientName\": \"test test\",\r\n \"items\": null,\r\n \"totalValue\": 10150,\r\n \"paymentNames\": \"Mastercard\",\r\n \"status\": \"ready-for-handling\",\r\n \"statusDescription\": \"Pronto para o manuseio\",\r\n \"marketPlaceOrderId\": null,\r\n \"sequence\": \"502551\",\r\n \"salesChannel\": \"1\",\r\n \"affiliateId\": \"\",\r\n \"origin\": \"Marketplace\",\r\n \"workflowInErrorState\": false,\r\n \"workflowInRetry\": false,\r\n \"lastMessageUnread\": \" Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502550llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc\",\r\n \"ShippingEstimatedDate\": \"2019-01-30T16:40:55.0000000+00:00\",\r\n \"ShippingEstimatedDateMax\": null,\r\n \"ShippingEstimatedDateMin\": null,\r\n \"orderIsComplete\": true,\r\n \"listId\": null,\r\n \"listType\": null,\r\n \"authorizedDate\": \"2019-01-23T16:40:27.0000000+00:00\",\r\n \"callCenterOperatorName\": null,\r\n \"totalItems\": 1,\r\n \"currencyCode\": \"BRL\"\r\n },\r\n {\r\n \"orderId\": \"v502547llux-01\",\r\n \"creationDate\": \"2019-01-23T16:34:20.0000000+00:00\",\r\n \"clientName\": \"test test\",\r\n \"items\": null,\r\n \"totalValue\": 10150,\r\n \"paymentNames\": \"Mastercard\",\r\n \"status\": \"ready-for-handling\",\r\n \"statusDescription\": \"Pronto para o manuseio\",\r\n \"marketPlaceOrderId\": null,\r\n \"sequence\": \"502548\",\r\n \"salesChannel\": \"1\",\r\n \"affiliateId\": \"\",\r\n \"origin\": \"Marketplace\",\r\n \"workflowInErrorState\": false,\r\n \"workflowInRetry\": false,\r\n \"lastMessageUnread\": \" Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502547llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc\",\r\n \"ShippingEstimatedDate\": \"2019-01-30T16:35:30.0000000+00:00\",\r\n \"ShippingEstimatedDateMax\": null,\r\n \"ShippingEstimatedDateMin\": null,\r\n \"orderIsComplete\": true,\r\n \"listId\": null,\r\n \"listType\": null,\r\n \"authorizedDate\": \"2019-01-23T16:35:04.0000000+00:00\",\r\n \"callCenterOperatorName\": null,\r\n \"totalItems\": 1,\r\n \"currencyCode\": \"BRL\"\r\n },\r\n {\r\n \"orderId\": \"v502544llux-01\",\r\n \"creationDate\": \"2018-12-28T18:15:28.0000000+00:00\",\r\n \"clientName\": \"test test\",\r\n \"items\": null,\r\n \"totalValue\": 8990,\r\n \"paymentNames\": \"Boleto Bancário\",\r\n \"status\": \"canceled\",\r\n \"statusDescription\": \"Cancelado\",\r\n \"marketPlaceOrderId\": null,\r\n \"sequence\": \"502544\",\r\n \"salesChannel\": \"1\",\r\n \"affiliateId\": \"\",\r\n \"origin\": \"Marketplace\",\r\n \"workflowInErrorState\": false,\r\n \"workflowInRetry\": false,\r\n \"lastMessageUnread\": \" Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502544llux-01 Resumo Itens R$ 89,90 Total R$ 89,90 Produto Alavanca De M\",\r\n \"ShippingEstimatedDate\": null,\r\n \"ShippingEstimatedDateMax\": null,\r\n \"ShippingEstimatedDateMin\": null,\r\n \"orderIsComplete\": true,\r\n \"listId\": null,\r\n \"listType\": null,\r\n \"authorizedDate\": null,\r\n \"callCenterOperatorName\": null,\r\n \"totalItems\": 1,\r\n \"currencyCode\": \"BRL\"\r\n },\r\n {\r\n \"orderId\": \"v502541llux-01\",\r\n \"creationDate\": \"2018-12-18T18:48:17.0000000+00:00\",\r\n \"clientName\": \"Douglas Rodrigues\",\r\n \"items\": null,\r\n \"totalValue\": 3290,\r\n \"paymentNames\": \"Boleto Bancário\",\r\n \"status\": \"canceled\",\r\n \"statusDescription\": \"Cancelado\",\r\n \"marketPlaceOrderId\": null,\r\n \"sequence\": \"502541\",\r\n \"salesChannel\": \"1\",\r\n \"affiliateId\": \"\",\r\n \"origin\": \"Marketplace\",\r\n \"workflowInErrorState\": false,\r\n \"workflowInRetry\": false,\r\n \"lastMessageUnread\": \" Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502541llux-01 Resumo Itens R$ 32,90 Total R$ 32,90 Produto Bay Max L 1 u\",\r\n \"ShippingEstimatedDate\": null,\r\n \"ShippingEstimatedDateMax\": null,\r\n \"ShippingEstimatedDateMin\": null,\r\n \"orderIsComplete\": true,\r\n \"listId\": null,\r\n \"listType\": null,\r\n \"authorizedDate\": null,\r\n \"callCenterOperatorName\": null,\r\n \"totalItems\": 1,\r\n \"currencyCode\": \"BRL\"\r\n },\r\n {\r\n \"orderId\": \"v502538llux-01\",\r\n \"creationDate\": \"2018-12-12T18:21:47.0000000+00:00\",\r\n \"clientName\": \"test test\",\r\n \"items\": null,\r\n \"totalValue\": 8990,\r\n \"paymentNames\": \"Mastercard\",\r\n \"status\": \"ready-for-handling\",\r\n \"statusDescription\": \"Pronto para o manuseio\",\r\n \"marketPlaceOrderId\": null,\r\n \"sequence\": \"502538\",\r\n \"salesChannel\": \"1\",\r\n \"affiliateId\": \"\",\r\n \"origin\": \"Marketplace\",\r\n \"workflowInErrorState\": false,\r\n \"workflowInRetry\": false,\r\n \"lastMessageUnread\": \" Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502538llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc\",\r\n \"ShippingEstimatedDate\": \"2018-12-19T18:22:26.0000000+00:00\",\r\n \"ShippingEstimatedDateMax\": null,\r\n \"ShippingEstimatedDateMin\": null,\r\n \"orderIsComplete\": true,\r\n \"listId\": null,\r\n \"listType\": null,\r\n \"authorizedDate\": \"2018-12-12T18:22:22.0000000+00:00\",\r\n \"callCenterOperatorName\": null,\r\n \"totalItems\": 1,\r\n \"currencyCode\": \"BRL\"\r\n },\r\n {\r\n \"orderId\": \"SCP-880102018018-01\",\r\n \"creationDate\": \"2018-11-30T17:34:01.0000000+00:00\",\r\n \"clientName\": \"roberta grecco\",\r\n \"items\": null,\r\n \"totalValue\": 1250,\r\n \"paymentNames\": \"\",\r\n \"status\": \"canceled\",\r\n \"statusDescription\": \"Cancelado\",\r\n \"marketPlaceOrderId\": \"880102018018-01\",\r\n \"sequence\": \"502537\",\r\n \"salesChannel\": \"1\",\r\n \"affiliateId\": \"SCP\",\r\n \"origin\": \"Fulfillment\",\r\n \"workflowInErrorState\": false,\r\n \"workflowInRetry\": false,\r\n \"lastMessageUnread\": \"cancelamento teste shp \",\r\n \"ShippingEstimatedDate\": null,\r\n \"ShippingEstimatedDateMax\": null,\r\n \"ShippingEstimatedDateMin\": null,\r\n \"orderIsComplete\": true,\r\n \"listId\": null,\r\n \"listType\": null,\r\n \"authorizedDate\": \"2018-11-30T17:34:42.0000000+00:00\",\r\n \"callCenterOperatorName\": null,\r\n \"totalItems\": 1,\r\n \"currencyCode\": \"BRL\"\r\n },\r\n {\r\n \"orderId\": \"SCP-880091692043-01\",\r\n \"creationDate\": \"2018-11-30T17:28:35.0000000+00:00\",\r\n \"clientName\": \"roberta grecco\",\r\n \"items\": null,\r\n \"totalValue\": 1250,\r\n \"paymentNames\": \"\",\r\n \"status\": \"invoiced\",\r\n \"statusDescription\": \"Faturado\",\r\n \"marketPlaceOrderId\": \"880091692043-01\",\r\n \"sequence\": \"502536\",\r\n \"salesChannel\": \"1\",\r\n \"affiliateId\": \"SCP\",\r\n \"origin\": \"Fulfillment\",\r\n \"workflowInErrorState\": false,\r\n \"workflowInRetry\": false,\r\n \"lastMessageUnread\": null,\r\n \"ShippingEstimatedDate\": null,\r\n \"ShippingEstimatedDateMax\": null,\r\n \"ShippingEstimatedDateMin\": null,\r\n \"orderIsComplete\": true,\r\n \"listId\": null,\r\n \"listType\": null,\r\n \"authorizedDate\": \"2018-11-30T17:29:22.0000000+00:00\",\r\n \"callCenterOperatorName\": null,\r\n \"totalItems\": 1,\r\n \"currencyCode\": \"BRL\"\r\n },\r\n {\r\n \"orderId\": \"SCP-880091058221-01\",\r\n \"creationDate\": \"2018-11-30T17:18:00.0000000+00:00\",\r\n \"clientName\": \"roberta grecco\",\r\n \"items\": null,\r\n \"totalValue\": 1250,\r\n \"paymentNames\": \"\",\r\n \"status\": \"canceled\",\r\n \"statusDescription\": \"Cancelado\",\r\n \"marketPlaceOrderId\": \"880091058221-01\",\r\n \"sequence\": \"502535\",\r\n \"salesChannel\": \"1\",\r\n \"affiliateId\": \"SCP\",\r\n \"origin\": \"Fulfillment\",\r\n \"workflowInErrorState\": false,\r\n \"workflowInRetry\": false,\r\n \"lastMessageUnread\": \"Teste de cancelamento do ShopFácil \",\r\n \"ShippingEstimatedDate\": null,\r\n \"ShippingEstimatedDateMax\": null,\r\n \"ShippingEstimatedDateMin\": null,\r\n \"orderIsComplete\": true,\r\n \"listId\": null,\r\n \"listType\": null,\r\n \"authorizedDate\": \"2018-11-30T17:18:44.0000000+00:00\",\r\n \"callCenterOperatorName\": null,\r\n \"totalItems\": 1,\r\n \"currencyCode\": \"BRL\"\r\n },\r\n {\r\n \"orderId\": \"SCP-880090643370-01\",\r\n \"creationDate\": \"2018-11-30T17:10:59.0000000+00:00\",\r\n \"clientName\": \"roberta grecco\",\r\n \"items\": null,\r\n \"totalValue\": 1250,\r\n \"paymentNames\": \"\",\r\n \"status\": \"ready-for-handling\",\r\n \"statusDescription\": \"Pronto para o manuseio\",\r\n \"marketPlaceOrderId\": \"880090643370-01\",\r\n \"sequence\": \"502534\",\r\n \"salesChannel\": \"1\",\r\n \"affiliateId\": \"SCP\",\r\n \"origin\": \"Fulfillment\",\r\n \"workflowInErrorState\": false,\r\n \"workflowInRetry\": false,\r\n \"lastMessageUnread\": null,\r\n \"ShippingEstimatedDate\": \"2018-12-07T17:11:39.0000000+00:00\",\r\n \"ShippingEstimatedDateMax\": null,\r\n \"ShippingEstimatedDateMin\": null,\r\n \"orderIsComplete\": true,\r\n \"listId\": null,\r\n \"listType\": null,\r\n \"authorizedDate\": \"2018-11-30T17:11:42.0000000+00:00\",\r\n \"callCenterOperatorName\": null,\r\n \"totalItems\": 1,\r\n \"currencyCode\": \"BRL\"\r\n },\r\n {\r\n \"orderId\": \"SCP-880090622238-01\",\r\n \"creationDate\": \"2018-11-30T17:10:45.0000000+00:00\",\r\n \"clientName\": \"roberta grecco\",\r\n \"items\": null,\r\n \"totalValue\": 1250,\r\n \"paymentNames\": \"\",\r\n \"status\": \"canceled\",\r\n \"statusDescription\": \"Cancelado\",\r\n \"marketPlaceOrderId\": \"880090622238-01\",\r\n \"sequence\": \"502533\",\r\n \"salesChannel\": \"1\",\r\n \"affiliateId\": \"SCP\",\r\n \"origin\": \"Fulfillment\",\r\n \"workflowInErrorState\": false,\r\n \"workflowInRetry\": false,\r\n \"lastMessageUnread\": null,\r\n \"ShippingEstimatedDate\": null,\r\n \"ShippingEstimatedDateMax\": null,\r\n \"ShippingEstimatedDateMin\": null,\r\n \"orderIsComplete\": true,\r\n \"listId\": null,\r\n \"listType\": null,\r\n \"authorizedDate\": null,\r\n \"callCenterOperatorName\": null,\r\n \"totalItems\": 1,\r\n \"currencyCode\": \"BRL\"\r\n },\r\n {\r\n \"orderId\": \"MNC-877730530419-01\",\r\n \"creationDate\": \"2018-11-20T21:09:01.0000000+00:00\",\r\n \"clientName\": \"Carlos VTEX\",\r\n \"items\": null,\r\n \"totalValue\": 11150,\r\n \"paymentNames\": \"\",\r\n \"status\": \"canceled\",\r\n \"statusDescription\": \"Cancelado\",\r\n \"marketPlaceOrderId\": \"877730530419-01\",\r\n \"sequence\": \"502532\",\r\n \"salesChannel\": \"1\",\r\n \"affiliateId\": \"MNC\",\r\n \"origin\": \"Fulfillment\",\r\n \"workflowInErrorState\": false,\r\n \"workflowInRetry\": false,\r\n \"lastMessageUnread\": null,\r\n \"ShippingEstimatedDate\": null,\r\n \"ShippingEstimatedDateMax\": null,\r\n \"ShippingEstimatedDateMin\": null,\r\n \"orderIsComplete\": true,\r\n \"listId\": null,\r\n \"listType\": null,\r\n \"authorizedDate\": \"2018-11-20T21:13:06.0000000+00:00\",\r\n \"callCenterOperatorName\": null,\r\n \"totalItems\": 1,\r\n \"currencyCode\": \"BRL\"\r\n },\r\n {\r\n \"orderId\": \"SCP-876733475998-01\",\r\n \"creationDate\": \"2018-11-16T16:58:18.0000000+00:00\",\r\n \"clientName\": \"roberta grecco\",\r\n \"items\": null,\r\n \"totalValue\": 1250,\r\n \"paymentNames\": \"\",\r\n \"status\": \"ready-for-handling\",\r\n \"statusDescription\": \"Pronto para o manuseio\",\r\n \"marketPlaceOrderId\": \"876733475998-01\",\r\n \"sequence\": \"502531\",\r\n \"salesChannel\": \"1\",\r\n \"affiliateId\": \"SCP\",\r\n \"origin\": \"Fulfillment\",\r\n \"workflowInErrorState\": false,\r\n \"workflowInRetry\": false,\r\n \"lastMessageUnread\": null,\r\n \"ShippingEstimatedDate\": \"2018-11-23T16:58:48.0000000+00:00\",\r\n \"ShippingEstimatedDateMax\": null,\r\n \"ShippingEstimatedDateMin\": null,\r\n \"orderIsComplete\": true,\r\n \"listId\": null,\r\n \"listType\": null,\r\n \"authorizedDate\": \"2018-11-16T16:58:53.0000000+00:00\",\r\n \"callCenterOperatorName\": null,\r\n \"totalItems\": 1,\r\n \"currencyCode\": \"BRL\"\r\n }\r\n ],\r\n \"facets\": [],\r\n \"paging\": {\r\n \"total\": 84,\r\n \"pages\": 6,\r\n \"currentPage\": 1,\r\n \"perPage\": 15\r\n },\r\n \"stats\": {\r\n \"stats\": {\r\n \"totalValue\": {\r\n \"Count\": 84,\r\n \"Max\": 21526180,\r\n \"Mean\": 262672.75,\r\n \"Min\": 1160,\r\n \"Missing\": 0,\r\n \"StdDev\": 2348087.3869179883,\r\n \"Sum\": 22064511,\r\n \"SumOfSquares\": 463417439039853,\r\n \"Facets\": {\r\n \"origin\": {\r\n \"Fulfillment\": {\r\n \"Count\": 68,\r\n \"Max\": 11150,\r\n \"Mean\": 1395.5882352941176,\r\n \"Min\": 1250,\r\n \"Missing\": 0,\r\n \"StdDev\": 1200.5513439298484,\r\n \"Sum\": 94900,\r\n \"SumOfSquares\": 229010000,\r\n \"Facets\": null\r\n },\r\n \"Marketplace\": {\r\n \"Count\": 16,\r\n \"Max\": 21526180,\r\n \"Mean\": 1373100.6875,\r\n \"Min\": 1160,\r\n \"Missing\": 0,\r\n \"StdDev\": 5374326.141087491,\r\n \"Sum\": 21969611,\r\n \"SumOfSquares\": 463417210029853,\r\n \"Facets\": null\r\n }\r\n },\r\n \"currencyCode\": {\r\n \"BRL\": {\r\n \"Count\": 84,\r\n \"Max\": 21526180,\r\n \"Mean\": 262672.75,\r\n \"Min\": 1160,\r\n \"Missing\": 0,\r\n \"StdDev\": 2348087.3869179883,\r\n \"Sum\": 22064511,\r\n \"SumOfSquares\": 463417439039853,\r\n \"Facets\": null\r\n }\r\n }\r\n }\r\n },\r\n \"totalItems\": {\r\n \"Count\": 84,\r\n \"Max\": 89,\r\n \"Mean\": 2.2261904761904763,\r\n \"Min\": 1,\r\n \"Missing\": 0,\r\n \"StdDev\": 9.660940100525016,\r\n \"Sum\": 187,\r\n \"SumOfSquares\": 8163,\r\n \"Facets\": {\r\n \"origin\": {\r\n \"Fulfillment\": {\r\n \"Count\": 68,\r\n \"Max\": 1,\r\n \"Mean\": 1,\r\n \"Min\": 1,\r\n \"Missing\": 0,\r\n \"StdDev\": 0,\r\n \"Sum\": 68,\r\n \"SumOfSquares\": 68,\r\n \"Facets\": null\r\n },\r\n \"Marketplace\": {\r\n \"Count\": 16,\r\n \"Max\": 89,\r\n \"Mean\": 7.4375,\r\n \"Min\": 1,\r\n \"Missing\": 0,\r\n \"StdDev\": 21.92401651157926,\r\n \"Sum\": 119,\r\n \"SumOfSquares\": 8095,\r\n \"Facets\": null\r\n }\r\n },\r\n \"currencyCode\": {\r\n \"BRL\": {\r\n \"Count\": 84,\r\n \"Max\": 89,\r\n \"Mean\": 2.2261904761904763,\r\n \"Min\": 1,\r\n \"Missing\": 0,\r\n \"StdDev\": 9.660940100525016,\r\n \"Sum\": 187,\r\n \"SumOfSquares\": 8163,\r\n \"Facets\": null\r\n }\r\n }\r\n }\r\n }\r\n }\r\n }\r\n}"}],"_postman_id":"632238d0-6695-4cf0-9951-9b9c3e4ddd70"},{"name":"Start Handling","id":"f3e4805a-693a-4f87-a5a4-08fdfe33f5d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"url":"https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders/{{orderId}}/start-handling","description":"

Change a Status Order to start-handling by Order ID

\n
know more about Order Status Flow in VTEX Help
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`orderId`	string	Order ID
`status`	string	Status Order that you want to apply

For example, in case you need change to start-handling the order status of order Id v5025004rjc-09 .

You will have to replace the variables orderId for v5025004rjc-09 and status to start-handling :

https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders/v5025004rjc-09/start-handling\n

Response codes

200 - Success

429 - Too many requests

403 - The credentials is not enabled to access the service

404 - Not found value

Authentication

This is a private API and need a appKey and appToken with admin access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","oms","pvt","orders","{{orderId}}","start-handling"],"host":["{{accountName}}","{{environment}}","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"f3e4805a-693a-4f87-a5a4-08fdfe33f5d1"},{"name":"Cancel Order","id":"4cffb61c-3f04-4cd5-92db-0822479814d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"INVZFNFDYQKGSGYUQWPFXMYGGOSIVUPXCICPFLYUABYOTDRJDVUBKMJVPOSQVWHEAMEKEJPFYUEWOJMCWIFZZOMPYHZQSHZDTTOHYHFTGPDPHMGFCQTNRIEMZPLXJZNQ"},{"key":"X-VTEX-API-AppKey","value":"vtexappkey-bazarhorizonte-INQSQG"}],"url":"https://bazarhorizonte.vtexcommercestable.com.br/api/oms/pvt/orders/{{pedido}}/cancel","description":"

Cancel a order by its ID

\n
know more about Order Status Flow in VTEX Help
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`orderId`	string	Order ID
`status`	string	Status Order that you want to apply

For example, in case you need to cancel the order Id v5025004rjc-09 .

You will have to replace the variables orderId for v5025004rjc-09 and status to cancel :

https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders/v5025004rjc-09/changestate/cancel\n

Response codes

200 - Success

429 - Too many requests

403 - The credentials is not enabled to access the service

404 - Not found value

Authentication

This is a private API and need a appKey and appToken with admin access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","oms","pvt","orders","{{pedido}}","cancel"],"host":["bazarhorizonte","vtexcommercestable","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"4cffb61c-3f04-4cd5-92db-0822479814d8"},{"name":"Register Change","id":"d0e92668-9cae-4921-9575-34b40714fb4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"Promoção dada por telefone\",\n \"discountValue\": 1000,\n \"incrementValue\": 0,\n \"itemsRemoved\": [\n {\n \"id\": \"234794\",\n \"price\": 600,\n \"quantity\": 2\n }\n ],\n \"itemsAdded\": [\n {\n \"id\": \"234788\",\n \"price\": 200,\n \"quantity\": 1\n }\n ]\n}"},"url":"https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders/{{orderId}}/changes","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Order status that allows Order Change
handling
waiting-for-fulfillment
ready-for-invoicing

\n
know more about Change completed orders in VTEX Help
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`orderId`	string	Order ID
`reason`	string	Order Change Reason
`discountValue`	integer	Order Change Disccount Value
`incrementValue`	integer	Order Change Increment Value
`itemsRemoved`	object	Object of items removed details
`itemsAdded`	object	Object of items added details
`id`	string	Changed Item ID
`price`	integer	Changed Item Price
`quantity`	integer	Changed Item Quantity

Response object has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`date`	string	Order Change Date
`orderId`	string	Order ID
`receipt`	string	Order Change Receipt ID

Authentication

This is a private API and need a appKey and appToken with admin access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","oms","pvt","orders","{{orderId}}","changes"],"host":["{{accountName}}","{{environment}}","com","br"],"query":[],"variable":[]}},"response":[{"id":"a3a032f1-b9eb-4b26-82a6-c08e636cde72","name":"Register Change","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"body":{"mode":"raw","raw":"{\n \"itemsAdded\": [\n {\n \"id\": \"1234568064\",\n \"quantity\": 1,\n \"price\": 0\n },\n {\n \"id\": \"1234568356\",\n \"quantity\": 1,\n \"price\": 90\n }\n ],\n \"itemsRemoved\": [\n {\n \"id\": \"267\",\n \"quantity\": 1,\n \"price\": 8990\n }\n ],\n \"reason\": \"Unavailable Product\",\n \"discountValue\": 8900,\n \"incrementValue\": 0\n}"},"url":"https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders/{{orderId}}/changes"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"date\": \"2019-02-08T13:54:33.6868469+00:00\",\r\n \"orderId\": \"v502538llux-01\",\r\n \"receipt\": \"535d4581-a2a2-4fd2-a206-1c61eae91b1e\"\r\n}"}],"_postman_id":"d0e92668-9cae-4921-9575-34b40714fb4d"},{"name":"Add Log","id":"99ac21fc-d8c8-49f0-9f4d-322eb666bbcc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"body":{"mode":"raw","raw":"{\n \"source\":\"Postman\", \n \"message\":\"Teste add interactions\"\n}"},"url":"https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders/{{orderId}}/interactions","description":"

Add a Log in Interactions Order Array

\n
know more about Change completed orders in VTEX Help
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`orderId`	string	Order ID
`source`	string	Log Source
`message`	integer	Log Message

Response codes

204 - Success

429 - Too many requests

403 - The credentials is not enabled to access the service

404 - Not found value

Authentication

This is a private API and need a appKey and appToken with admin access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","oms","pvt","orders","{{orderId}}","interactions"],"host":["{{accountName}}","{{environment}}","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"99ac21fc-d8c8-49f0-9f4d-322eb666bbcc"},{"name":"Get Attachment","id":"90b4dd1a-7cf1-410c-ad3f-6a5b9fba2d3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"url":"https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders/{{orderId}}/message-attachment?attachmentName=teste","description":"

Retrieve a order attachment by its name and order ID

\n
know more about Order Flow in VTEX Help
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`orderId`	string	Order Id
`attachmentName`	string	Order Attachment Name

For example, in case you need get a attachment from order ID v5025004rjc-09 .

You will have to replace the variables v5025004rjc-09 for v5025004rjc-09 and attachmentName for Mr Attachment:

https://luxstore.myvtex.com/api/oms/pvt/orders/v5025004rjc-09/message-attachment?attachmentName=teste\n

Response object has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`cancelled`	boolean	If the export request was cancelled
`completedDate`	string	Order Export process completed date
`dateOfRequest`	string	Order Export request date
`email`	string	Order Export requester email
`filter`	string	Order Export request filter
`hostUri`	string	Host URL
`id`	string	Order Export request Id
`instanceId`	string	Instace Id
`lasUpdateTime`	string	Order export process update time
`linkToDownload`	string	Link to Order Export Download
`publishId`	string	Order Export publish Id
`query`	string	Order Export request filter query
`rowNumber`	integer	Order export total rows
`rowsProcessed`	integer	Order export total processed rows
`startDate`	string	Order Export process start date
`utcTime`	string	UTC time

Authentication

This is a private API and need credentials with viewer access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","oms","pvt","orders","{{orderId}}","message-attachment"],"host":["{{accountName}}","{{environment}}","com","br"],"query":[{"key":"attachmentName","value":"teste"}],"variable":[]}},"response":[],"_postman_id":"90b4dd1a-7cf1-410c-ad3f-6a5b9fba2d3f"},{"name":"Reembolso Cielo","id":"943a06b5-8511-4189-95f5-bd6076dcb8f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"INVZFNFDYQKGSGYUQWPFXMYGGOSIVUPXCICPFLYUABYOTDRJDVUBKMJVPOSQVWHEAMEKEJPFYUEWOJMCWIFZZOMPYHZQSHZDTTOHYHFTGPDPHMGFCQTNRIEMZPLXJZNQ"},{"key":"X-VTEX-API-AppKey","value":"vtexappkey-bazarhorizonte-INQSQG"}],"body":{"mode":"raw","raw":"{value:\"12597\"}"},"url":"https://bazarhorizonte.vtexpayments.com.br/api/pvt/transactions/8047260A654340799F332A96749F44D3/refunding-request","urlObject":{"protocol":"https","path":["api","pvt","transactions","8047260A654340799F332A96749F44D3","refunding-request"],"host":["bazarhorizonte","vtexpayments","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"943a06b5-8511-4189-95f5-bd6076dcb8f7"}],"id":"479cf11c-0f8b-4b57-b752-00788098f036","_postman_id":"479cf11c-0f8b-4b57-b752-00788098f036","description":""},{"name":"Invoice","item":[{"name":"Invoice Notification","id":"04daa13b-9dfd-4458-af5d-af766dcdda25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"INVZFNFDYQKGSGYUQWPFXMYGGOSIVUPXCICPFLYUABYOTDRJDVUBKMJVPOSQVWHEAMEKEJPFYUEWOJMCWIFZZOMPYHZQSHZDTTOHYHFTGPDPHMGFCQTNRIEMZPLXJZNQ"},{"key":"X-VTEX-API-AppKey","value":"vtexappkey-bazarhorizonte-INQSQG"}],"body":{"mode":"raw","raw":"{\n \"type\":\"Output\",\n \"issuanceDate\":\"{{data}}\",\n \"invoiceNumber\":\"{{nota}}\",\n \"invoiceValue\":\"{{valor}}\",\n \"trackingNumber\": \"{{rastreio}}\",\n \"trackingUrl\": \"{{url}}\"\n \n }"},"url":"https://bazarhorizonte.vtexcommercestable.com.br/api/oms/pvt/orders/{{pedido}}/invoice","description":"

Order invoice notification

\n
know more about Order Invoice Notification in VTEX Help
\n

Request object has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`orderId`	string	Order Id
`type`	string	Invoice type, values accept:\"Output\", for output invoices like a normal delivery, and \"Input\", for input invoice like a package return
`issuanceDate`	string	Invoice Date
`invoiceNumber`	string	Invoice Number
`invoiceValue`	string	Invoice Value
`invoiceKey`	string	Invoice Access Key
`invoiceUrl`	string	Invoice Url
`courier`	string	Selected Courier
`trackingNumber`	string	Package Tracking Number
`trackingUrl`	string	Package Tracking URL
`items`	object	Packge SKU Array
`id`	string	SKU Id
`price`	integer	SKU Price
`quantity`	integer	SKU Quantity

\n
We strongly suggest that you always send the object of the invoiced items, with this practice the rounding errors will be avoided
\n

\n
It is not allowed to use more than once the Invoice Notification API with the same invoiceNumber
\n

Response object has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`date`	string	Invoice Date
`orderId`	string	Order Id
`receipt`	string	Invoice receipt confirmation ID

Authentication

This is a private API and need a appKey and appToken with admin access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","oms","pvt","orders","{{pedido}}","invoice"],"host":["bazarhorizonte","vtexcommercestable","com","br"],"query":[],"variable":[]}},"response":[{"id":"b4955b27-e6a9-4f0d-8a57-9a4fa6c2a9bd","name":"Invoice Notification","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"body":{"mode":"raw","raw":"{\n\t\"invoiceNumber\":\"7999972\",\n\t\"invoiceValue\":7450,\n\t\"issuanceDate\":\"2019-02-07T02:00:00.000Z\",\n\t\"invoiceUrl\":\"http://www.invoiceu.rl\",\n\t\"invoiceKey\":\"799\",\n\t\"trackingNumber\":\"9997LUX\",\n\t\"trackingUrl\":\"http://www.trackingu.rl\",\n\t\"courier\":\"Todos os CEPS\",\n\t\"items\": [\n\t\t\t\t{\n\t\t\t \"id\": \"1231\",\n\t\t\t \"price\": 7450,\n\t\t\t \"quantity\": 1\n\t\t\t }\n\t\t\t ]\n}"},"url":"https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders/v5195004lux-01/invoice"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n\t\"date\":\"2019-02-08T13:16:13.4617653+00:00\",\n\t\"orderId\":\"00-v5195004lux-01\",\n\t\"receipt\":\"527b1ae251264ef1b7a9b597cd8f16b9\"\n\t\n}"}],"_postman_id":"04daa13b-9dfd-4458-af5d-af766dcdda25"},{"name":"Update partial invoice (Send Tracking Number)","id":"34ceaac9-1843-4d82-be3f-68257381ad16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"body":{"mode":"raw","raw":"{\n \"trackingNumber\": \"87658\",\n \"trackingUrl\": null,\n \"courier\": null\n}"},"url":"https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders/{{orderId}}/invoice/{{invoiceNumber}}","description":"

Update invoice with tracking number

\n
know more about Order Invoice Notification in VTEX Help
\n

Request object has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`orderId`	string	Order Id
`invoiceNumber`	string	Invoice Number
`trackingNumber`	string	Package Tracking Number
`trackingUrl`	string	Package Tracking URL
`courier`	string	Selected Courier

Response object has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`date`	string	Invoice Date
`orderId`	string	Order Id
`receipt`	string	Invoice receipt confirmation ID

Authentication

This is a private API and need a appKey and appToken with admin access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","oms","pvt","orders","{{orderId}}","invoice","{{invoiceNumber}}"],"host":["{{accountName}}","{{environment}}","com","br"],"query":[],"variable":[]}},"response":[{"id":"19a78456-7bfe-49be-a9f9-68296793234e","name":"Update partial invoice (Send Tracking Number)","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"body":{"mode":"raw","raw":"{\n\t\"trackingNumber\":\"9997LUX\",\n\t\"trackingUrl\":\"http://www.trackingu.rl\",\n\t\"courier\":\"Todos os CEPS\"\n}"},"url":"https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders/v5195004lux-01/invoice/7999972"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"date\": \"2019-02-08T13:16:13.4617653+00:00\",\n \"orderId\": \"00-v5195004lux-01\",\n \"receipt\": \"527b1ae251264ef1b7a9b597cd8f16b9\"\n}"}],"_postman_id":"34ceaac9-1843-4d82-be3f-68257381ad16"}],"id":"51ec4258-ca02-4a83-a243-cae8744f27c6","_postman_id":"51ec4258-ca02-4a83-a243-cae8744f27c6","description":""},{"name":"Tracking","item":[{"name":"Update Tracking Status","id":"6e419f8b-61de-432e-9d4f-48fa68a21fba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"body":{"mode":"raw","raw":"{\n \"isDelivered\": false,\n \"events\": [\n {\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"description\": \"Coletado pela transportadora\",\n \"date\": \"2015-06-23\"\n },\n {\n \"city\": \"Sao Paulo\",\n \"state\": \"SP\",\n \"description\": \"A caminho de Curitiba\",\n \"date\": \"2015-06-24\"\n }\n ]\n}"},"url":"https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders/{{orderId}}/invoice/{{invoiceNumber}}/tracking","description":"

Send a tracking event to a order by order Id

\n
know more about Transaction Details in VTEX Help
\n

Request object has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`orderId`	string	Order Id
`invoiceNumber`	string	Order Invoice ID
`isDelivered`	boolean	If the order package is delivered
`events`	object	Events Details Object
`city`	string	Event Tracking City
`state`	string	Event Tracking State
`description`	Event Tracking Description
`date`	string	Event Tracking Date in international format `yyyy-mm-dd`

\n
If isDelivered is true, the status change to Delivered.
\n

Response object has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`date`	string	Tracking Update Date
`orderId`	string	Order ID Update
`receipt`	string	Tracking Update Receipt

Authentication

This is a private API and need a appKey and appToken with admin access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","oms","pvt","orders","{{orderId}}","invoice","{{invoiceNumber}}","tracking"],"host":["{{accountName}}","{{environment}}","com","br"],"query":[],"variable":[]}},"response":[{"id":"7b4aa1ea-ccdb-4068-b6c4-b1c5606d7569","name":"Update Tracking Status","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","description":"The mime type of this content"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"body":{"mode":"raw","raw":"{\n \"isDelivered\": true,\n \"events\": [\n {\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"description\": \"Coletado pela transportadora\",\n \"date\": \"2015-06-23\"\n },\n {\n \"city\": \"Sao Paulo\",\n \"state\": \"SP\",\n \"description\": \"A caminho de Curitiba\",\n \"date\": \"2015-06-24\"\n }\n ]\n}"},"url":"https://lojadosuporte.vtexcommercestable.com.br/api/oms/pvt/orders/v501245lspt-01/invoice/0102030405/tracking"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"116","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 29 Mar 2017 18:05:00 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx","name":"Server","description":""},{"key":"X-CDNIgnore","value":"1","name":"X-CDNIgnore","description":""},{"key":"X-Powered-by-VTEX-Janus-Edge","value":"v1.35.3","name":"X-Powered-by-VTEX-Janus-Edge","description":""},{"key":"X-Track","value":"stable","name":"X-Track","description":""},{"key":"X-VTEX-Janus-Router-Backend-App","value":"omsapi-v1.5.143","name":"X-VTEX-Janus-Router-Backend-App","description":""}],"cookie":[],"responseTime":null,"body":"{\"date\":\"2017-03-29T18:04:31.0521233+00:00\",\"orderId\":\"v501245lspt-01\",\"receipt\":\"f67d33a8029c42ce9a8f07fc17f54449\"}"}],"_postman_id":"6e419f8b-61de-432e-9d4f-48fa68a21fba"}],"id":"a8a8295c-65b0-4e8d-82aa-4f2ef00b00cc","_postman_id":"a8a8295c-65b0-4e8d-82aa-4f2ef00b00cc","description":""},{"name":"Conversation","item":[{"name":"Get Conversation","id":"cfa979e9-b9c2-4a1d-8b75-168051a46dc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"url":"https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders/{{orderId}}/conversation-message","description":"

Retrieve all conversation order by Order ID

\n
know more about Conversarion Tracker in VTEX Help
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`orderId`	string	Order Id

For example, in case you need get details from conversation in the Order Id v5025004rjc-09 .

You will have to replace the variables orderId for v5025004rjc-09:

https://lojadosuporte.myvtex.com/api/oms/pvt/orders/v5025004lux-09/conversation-message\n

Response object has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`attachmentNames`	object	Attachment Names Array
`body`	string	Conversation Content Body
`date`	string	Conversation Date
`firstWords`	string	First words of Converstion content
`hasAttachment`	boolean	If it has attachment
`id`	string	Conversation ID
`subject`	string	Conversation Content Subject
`from`	object	Conversation Sender
`to`	object	Conversation Receiver
`aliasMaskType`	integer	Conversation Tracker Mask Type
`conversationRelatedTo`	string	Related Order Id
`conversationSubject`	string	Conversation Subject
`email`	string	Sender or Receiver mail
`emailAlias`	string	Sender or Receiver transaction tracker mail
`name`	string	Sender or Receiver Name
`role`	string	If is a Client or null for transation mails

Authentication

This is a private API and need credentials with viewer access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","oms","pvt","orders","{{orderId}}","conversation-message"],"host":["{{accountName}}","{{environment}}","com","br"],"query":[],"variable":[]}},"response":[{"id":"5f1be7ab-8a82-437d-964f-fb2808e14af9","name":"Get Conversation","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","description":"The mime type of this content"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"url":"https://ambienteqa.{{environment}}.com.br/api/oms/pvt/orders/v976756ambn-01/conversation-message"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 13 Feb 2017 15:25:24 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx","name":"Server","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-CDNIgnore","value":"1","name":"X-CDNIgnore","description":""},{"key":"X-Powered-by-VTEX-Janus-Edge","value":"v1.35.3","name":"X-Powered-by-VTEX-Janus-Edge","description":""},{"key":"X-Track","value":"stable","name":"X-Track","description":""},{"key":"X-VTEX-Janus-Router-Backend-App","value":"omsapi-v1.5.135","name":"X-VTEX-Janus-Router-Backend-App","description":""}],"cookie":[],"responseTime":null,"body":"[{\"id\":\"2017-02-09t14-52-46_6ea318768a2f491c9e66ed92415fa2bc\",\"from\":{\"conversationRelatedTo\":\"v976756ambn-01\",\"conversationSubject\":\"oms\",\"emailAlias\":\"noreply@vtexcommerce.com.br-9814872b.ct.vtex.com.br\",\"aliasMaskType\":1,\"email\":\"noreply@vtexcommerce.com.br\",\"name\":\"Ambiente QA\",\"role\":\"\"},\"to\":[{\"conversationRelatedTo\":\"v976756ambn-01\",\"conversationSubject\":\"oms\",\"emailAlias\":\"melissa+3@vtex.com.br-2b.ct.vtex.com.br\",\"aliasMaskType\":1,\"email\":\"melissa+3@vtex.com.br\",\"name\":\"Melissa Otero\",\"role\":\"Customer\"}],\"subject\":\"Seu pedido de Produto Seleção SKU ... foi realizado com sucesso!\",\"firstWords\":\"AmbienteQA Pedido realizado com sucesso! realizado em: 09/02/2017 Olá, Melissa. Obrigado por comprar em nossa loja. Os detalhes do pedido en\",\"body\":\"AmbienteQA

$\\\"Ambiente$

Pedido realizado com sucesso!

realizado em: 09/02/2017

Olá, Melissa.

Obrigado por comprar em nossa loja. Os detalhes do pedido encontram-se abaixo:

Endereço de entrega

Melissa Otero
Praia de Botafogo - 223 - Botafogo
Rio de Janeiro - RJ
22250-040

Forma de pagamento

Boleto Bancário R$ 1.206,50 Imprimir boleto

Pedido nº v976756ambn-01

Fornecido e entregue por AmbienteQA

Tipo de entrega: Normal

✓

PEDIDO REALIZADO

►

PAGAMENTO CONFIRMADO

►

PEDIDO FATURADO

►

PEDIDO ENVIADO

Produto Seleção SKU Rich Selection 3 33 - Rosa

Entrega em até 6 dias úteis.

1x R$ 1.200,00

Itens	R$ 1.200,00
Entrega	R$ 6,50
Total	R$ 1.206,50

Acompanhe seus pedidos no site

ATENÇÃO: O prazo de entrega será considerado somente após a confirmação do pagamento ou imediato em caso de bônus.

Atenciosamente,
Equipe Ambiente QA.

\",\"hasAttachment\":false,\"attachmentNames\":[],\"date\":\"2017-02-09T14:52:46.0000000+00:00\"},{\"id\":\"2017-02-11t14-53-13_d495d5029b9f42f2b2f6bb7250a14f61\",\"from\":{\"conversationRelatedTo\":\"v976756ambn-01\",\"conversationSubject\":\"oms\",\"emailAlias\":\"noreply@vtexcommerce.com.br-9814872b.ct.vtex.com.br\",\"aliasMaskType\":1,\"email\":\"noreply@vtexcommerce.com.br\",\"name\":\"Ambiente QA\",\"role\":null},\"to\":[{\"conversationRelatedTo\":\"v976756ambn-01\",\"conversationSubject\":\"oms\",\"emailAlias\":\"melissa+3@vtex.com.br-2b.ct.vtex.com.br\",\"aliasMaskType\":1,\"email\":\"melissa+3@vtex.com.br\",\"name\":\"Melissa Otero\",\"role\":\"Customer\"}],\"subject\":\"Pagamento pendente de Produto Seleção SKU ... !\",\"firstWords\":\"AmbienteQA Pagamento pendente realizado em: 09/02/2017 Olá, Melissa. Verificamos que o pagamento referente ao(s) pedido(s) abaixo continua p\",\"body\":\"AmbienteQA

$\\\"fantasiablackbox\\\"$

Pagamento pendente

realizado em: 09/02/2017

Olá, Melissa.

Verificamos que o pagamento referente ao(s) pedido(s) abaixo continua pendente. Por favor, realize este pagamento para continuar com sua compra.

Forma de pagamento

Boleto Bancário R$ 1.206,50 à vista Imprimir boleto

Pedido nº v976756ambn-01

Fornecido e entregue por AmbienteQA

Tipo de entrega: Normal

✓

PEDIDO REALIZADO

►

PAGAMENTO CONFIRMADO

►

PEDIDO FATURADO

►

PEDIDO ENVIADO

Produto Seleção SKU Rich Selection 3 33 - Rosa

Entrega em até 6 dias úteis.

1x R$ 1.200,00

Itens	R$ 1.200,00
Entrega	R$ 6,50

Acompanhe seus pedidos no site

ATENÇÃO: Desconsidere a mensagem caso já tenha efetuado o pagamento.

Atenciosamente,
Equipe fantasiablackbox.

\",\"hasAttachment\":false,\"attachmentNames\":[],\"date\":\"2017-02-11T14:53:13.0000000+00:00\"}]"},{"id":"b53c038b-2c04-4899-891c-9e6227353ac8","name":"Get Conversation Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json","description":"The mime type of this content"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"url":"https://ambienteqa.{{environment}}.com.br/api/oms/pvt/orders/v976756ambn-01/conversation-message"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 13 Feb 2017 15:25:24 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx","name":"Server","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-CDNIgnore","value":"1","name":"X-CDNIgnore","description":""},{"key":"X-Powered-by-VTEX-Janus-Edge","value":"v1.35.3","name":"X-Powered-by-VTEX-Janus-Edge","description":""},{"key":"X-Track","value":"stable","name":"X-Track","description":""},{"key":"X-VTEX-Janus-Router-Backend-App","value":"omsapi-v1.5.135","name":"X-VTEX-Janus-Router-Backend-App","description":""}],"cookie":[],"responseTime":null,"body":"[{\"id\":\"2017-02-09t14-52-46_6ea318768a2f491c9e66ed92415fa2bc\",\"from\":{\"conversationRelatedTo\":\"v976756ambn-01\",\"conversationSubject\":\"oms\",\"emailAlias\":\"noreply@vtexcommerce.com.br-9814872b.ct.vtex.com.br\",\"aliasMaskType\":1,\"email\":\"noreply@vtexcommerce.com.br\",\"name\":\"Ambiente QA\",\"role\":\"\"},\"to\":[{\"conversationRelatedTo\":\"v976756ambn-01\",\"conversationSubject\":\"oms\",\"emailAlias\":\"melissa+3@vtex.com.br-2b.ct.vtex.com.br\",\"aliasMaskType\":1,\"email\":\"melissa+3@vtex.com.br\",\"name\":\"Melissa Otero\",\"role\":\"Customer\"}],\"subject\":\"Seu pedido de Produto Seleção SKU ... foi realizado com sucesso!\",\"firstWords\":\"AmbienteQA Pedido realizado com sucesso! realizado em: 09/02/2017 Olá, Melissa. Obrigado por comprar em nossa loja. Os detalhes do pedido en\",\"body\":\"AmbienteQA

$\\\"Ambiente$

Pedido realizado com sucesso!

realizado em: 09/02/2017

Olá, Melissa.

Obrigado por comprar em nossa loja. Os detalhes do pedido encontram-se abaixo:

Endereço de entrega

Melissa Otero
Praia de Botafogo - 223 - Botafogo
Rio de Janeiro - RJ
22250-040

Forma de pagamento

Boleto Bancário R$ 1.206,50 Imprimir boleto

Pedido nº v976756ambn-01

Fornecido e entregue por AmbienteQA

Tipo de entrega: Normal

✓

PEDIDO REALIZADO

►

PAGAMENTO CONFIRMADO

►

PEDIDO FATURADO

►

PEDIDO ENVIADO

Produto Seleção SKU Rich Selection 3 33 - Rosa

Entrega em até 6 dias úteis.

1x R$ 1.200,00

Itens	R$ 1.200,00
Entrega	R$ 6,50
Total	R$ 1.206,50

Acompanhe seus pedidos no site

ATENÇÃO: O prazo de entrega será considerado somente após a confirmação do pagamento ou imediato em caso de bônus.

Atenciosamente,
Equipe Ambiente QA.

$\\\"fantasiablackbox\\\"$

Pagamento pendente

realizado em: 09/02/2017

Olá, Melissa.

Verificamos que o pagamento referente ao(s) pedido(s) abaixo continua pendente. Por favor, realize este pagamento para continuar com sua compra.

Forma de pagamento

Boleto Bancário R$ 1.206,50 à vista Imprimir boleto

Pedido nº v976756ambn-01

Fornecido e entregue por AmbienteQA

Tipo de entrega: Normal

✓

PEDIDO REALIZADO

►

PAGAMENTO CONFIRMADO

►

PEDIDO FATURADO

►

PEDIDO ENVIADO

Produto Seleção SKU Rich Selection 3 33 - Rosa

Entrega em até 6 dias úteis.

1x R$ 1.200,00

Itens	R$ 1.200,00
Entrega	R$ 6,50

Acompanhe seus pedidos no site

ATENÇÃO: Desconsidere a mensagem caso já tenha efetuado o pagamento.

Atenciosamente,
Equipe fantasiablackbox.

\",\"hasAttachment\":false,\"attachmentNames\":[],\"date\":\"2017-02-11T14:53:13.0000000+00:00\"}]"}],"_postman_id":"cfa979e9-b9c2-4a1d-8b75-168051a46dc0"}],"id":"8bb7e718-4f6e-4615-ba98-7a378397774f","_postman_id":"8bb7e718-4f6e-4615-ba98-7a378397774f","description":""},{"name":"Payment","item":[{"name":"Get Payment transaction","id":"6aca55ac-0102-4fff-8437-83b6994e484c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"url":"https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders/{{orderId}}/payment-transaction","description":"

Retrieve transaction details by order Id

\n
know more about Transaction Details in VTEX Help
\n

Request object has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`orderId`	string	Order Id

Response object has the following properties:

Attribute	Type	Description
`status`	string	Transaction Status
`isActive`	boolean	If is a active transaction
`transactionId`	string	Transaction Id
`merchantName`	string	Transaction Merchant Name
`payments`	object	Payments details object
`id`	string	Payment ID
`paymentSystem`	string	Payment System Id
`paymentSystemName`	string	Payment Sytem Name
`value`	integer	Payment Value
`installments`	integer	Payment Installments Quantity
`referenceValue`	integer	Payment Reference Value
`cardHolder`	string	Payment Card Holder
`cardNumber`	string	Payment Card Number
`firstDigits`	string	Payment Card First Digits
`lastDigits`	string	Payment Card Last Digits
`cvv2`	string	???
`expireMonth`	string	Payment Card expire Month
`expireYear`	string	Payment Card expire Year
`url`	string	Payment URL
`giftCardId`	string	Gift Card Id
`giftCardName`	string	Gift Card Name
`giftCardCaption`	string	Gift Card Caption
`authId`	string	Connector Authorization Id
`group`	string	Payment Group
`tid`	string	Payment Transaction Id
`dueDate`	string	Payment Due Date
`connectorResponses`	string	Order Id
`Tid`	string	Connector Transaction Id
`ReturnCode`	string	Connector Return Code
`Message`	string	Order Id
`authId`	string	Connector Authorization Id

Authentication

This is a private API and need a appKey and appToken with admin access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","oms","pvt","orders","{{orderId}}","payment-transaction"],"host":["{{accountName}}","{{environment}}","com","br"],"query":[],"variable":[]}},"response":[{"id":"29c6bb7c-2568-44f0-85b0-241812aab9ce","name":"Get Payment transaction","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"url":"https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders/{{orderId}}/payment-transaction"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Finished\",\n \"isActive\": true,\n \"transactionId\": \"CB452D77E7D04099A4DB0479087B1D2C\",\n \"merchantName\": \"LUXSTORE\",\n \"payments\": [\n {\n \"id\": \"721CBE1090324D12ABE301FE33DE775A\",\n \"paymentSystem\": \"4\",\n \"paymentSystemName\": \"Mastercard\",\n \"value\": 10150,\n \"installments\": 1,\n \"referenceValue\": 10150,\n \"cardHolder\": null,\n \"cardNumber\": null,\n \"firstDigits\": \"412341\",\n \"lastDigits\": \"4123\",\n \"cvv2\": null,\n \"expireMonth\": null,\n \"expireYear\": null,\n \"url\": null,\n \"giftCardId\": null,\n \"giftCardName\": null,\n \"giftCardCaption\": null,\n \"redemptionCode\": null,\n \"group\": \"creditCard\",\n \"tid\": \"101770752\",\n \"dueDate\": null,\n \"connectorResponses\": {\n \"Tid\": \"101770752\",\n \"ReturnCode\": null,\n \"Message\": null,\n \"authId\": \"170852\"\n }\n }\n ]\n}"}],"_postman_id":"6aca55ac-0102-4fff-8437-83b6994e484c"},{"name":"Send Payment Notification","id":"b7931cfe-98c3-4f5a-8b00-b28a601ed2b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"url":"https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/orders/{{orderId}}/payments/{{paymentId}}/payment-notification","description":"

Send a payment notification by order Id

\n
know more about Transaction Details in VTEX Help
\n

Request object has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`orderId`	string	Order Id
`paymentId`	string	Payment ID

Response codes

200 - Success

400 - Bad request

403 - The credentials is not enabled to access the service

404 - Not found value

429 - Too many requests

Authentication

This is a private API and need a appKey and appToken with admin access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","oms","pvt","orders","{{orderId}}","payments","{{paymentId}}","payment-notification"],"host":["{{accountName}}","{{environment}}","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"b7931cfe-98c3-4f5a-8b00-b28a601ed2b5"}],"id":"a2e9cafc-77f8-476a-a0cf-529c678f4bce","_postman_id":"a2e9cafc-77f8-476a-a0cf-529c678f4bce","description":""},{"name":"Feed v2 (deprecated)","item":[{"name":"Get feed order status","id":"c184392e-a708-4f41-aff6-fa797b2ae2aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"url":"https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/feed/orders/status?maxLot={{maxLot}}","description":"

Get feed order events

\nWarning! We have a new version, please if you are starting a project know more about Feed v3 in VTEX Help\n

\n\n\n\n\n

Request has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`accountName`	string	Account Name
`maxLot`	integer	Lot quantity, maximum accept value is 10

Response object has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`eventId`	string	Feed event ID
`handle`	string	Event handle, used in Confirm Item Feed
`domain`	integer	Order Source
`state`	integer	Feed event state
`orderId`	string	Order ID

\n
The event will be removed if the message send retry is equal to or greater than the maximum retention period
\n

Authentication

This is a private API and need a appKey and appToken with viewer access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","oms","pvt","feed","orders","status"],"host":["{{accountName}}","{{environment}}","com","br"],"query":[{"key":"maxLot","value":"{{maxLot}}"}],"variable":[]}},"response":[],"_postman_id":"c184392e-a708-4f41-aff6-fa797b2ae2aa"},{"name":"Confirm item feed order status","id":"5ff0b460-1733-42c9-b0d1-3a2873703d26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"body":{"mode":"raw","raw":"[\n {\n \"commitToken\": \"Marketplace##{\\\"Receipt\\\":\\\"+eXJYhj5rDqHa28+XUcfebDO4pve3TvMpPlW0ivc5STyE/40J6wxooXgBF8LZ9CdhZkFJnMYBVDwPwQtNEoZQrVtErDB2Yq2zs16QqsJuYxSrQtBfl9rMfmkO5orB9oDHSpvwL6DjDzcuJeQBBNxono/m4F6BloJEsk9BmuTmPaRI+7xsrN5Oeg8NPUoNSnsT983JPr1B+Y+TbbFjC1R8ZkvFHGVfti1QbhOwmYWTHPG08YMqla+Qwh7kUONLBXPqporF/CcqJo5YVTSu2uBcCuXkUo+OH9uUTn6hHkUROo=\\\",\\\"PublisheId\\\":\\\"C0111A50CEB244E59C95422870127A4F\\\",\\\"PublisheId_Item\\\":\\\"C0111A50CEB244E59C95422870127A4F\\\",\\\"EventId\\\":\\\"0dc05b6b-48a5-4f03-975a-a69fb6550aaa\\\",\\\"LastSendOverwrite\\\":null}\"\n }\n]"},"url":"https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/feed/orders/status/confirm","description":"

Order status event acknowledge

\nWarning! We have a new version, please if you are starting a project know more about Feed v3 in VTEX Help\n

\n\n\n

Request object has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`commitToken`	string	Event status order handle

Response codes

200 - Success

429 - Too many requests

403 - The credentials is not enabled to access the service

404 - Not found value

Authentication

This is a private API and need a appKey and appToken with admin access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","oms","pvt","feed","orders","status","confirm"],"host":["{{accountName}}","{{environment}}","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"5ff0b460-1733-42c9-b0d1-3a2873703d26"}],"id":"e4e71bf6-761b-46c2-aa18-43683441fd88","description":"

Check this article to learn more about the OMS feed: https://help.vtex.com/en/tutorial/how-the-oms-feed-works

\nWarning! We have a new version, please if you are starting a project know more about Feed v3 in VTEX Help\n

","event":[{"listen":"prerequest","script":{"id":"6639a030-a359-4d58-ba7a-a3baefeb00e6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b2c4bfdf-b5a1-4eb8-9c79-28441627ae8a","type":"text/javascript","exec":[""]}}],"_postman_id":"e4e71bf6-761b-46c2-aa18-43683441fd88"},{"name":"Feed v3","item":[{"name":"Get feed order status","id":"d2a8fc63-0d71-42bd-8b82-80a351e7981b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"url":"https://{{accountName}}.myvtex.com/api/orders/feed?maxlot={{maxLot}}","description":"

Get feed order events

\n
know more about Feed v3 in VTEX Help
\n

Request has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`accountName`	string	Account Name
`maxLot`	integer	Lot quantity, maximum accept value is 10

Response object has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`eventId`	string	Feed event ID
`handle`	string	Event handle, used in Confirm Item Feed
`domain`	integer	Order Source
`state`	integer	Feed event state
`orderId`	string	Order ID
`lastChange`	date	Date for last change
`currentChange`	date	Date of change of current status

\n
The event will be removed if the message send retry is equal to or greater than the maximum retention period
\n

Authentication

This is a private API and need a appKey and appToken with viewer access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","orders","feed"],"host":["{{accountName}}","myvtex","com"],"query":[{"key":"maxlot","value":"{{maxLot}}"}],"variable":[]}},"response":[{"id":"96a0856b-ab73-439c-a40a-fe3e861bb2c8","name":"Get feed order status","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"url":{"raw":"https://{{accountName}}.myvtex.com/api/orders/feed?maxlot=10","protocol":"https","host":["{{accountName}}","myvtex","com"],"path":["api","orders","feed"],"query":[{"key":"maxlot","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"eventId\": \"ED423DDED4C1AE580CADAC1A4D02DA3F\",\n \"handle\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoidnRleGFwcGtleS1wYXJ0bmVyc2xhdGFtLVJNQkpNUyIsIkFwcEtleSI6InZ0ZXhhcHBrZXktcGFydG5lcnNsYXRhbS1STUJKTVMiLCJBY2NvdW50IjoicGFydG5lcnNsYXRhbSIsIkhhbmRsZSI6IkFRRUIzbmtWR0piOXhhNGRjYlpkOTFVVWMyL2JObHc0Qnp3ZlNLV201Rjg2QXgrSGlRM053bEJkb2NwM2wvVytLdjFNQTZ4d3ZLcFYwYjlSeUttNVRpb3hrSVFMSG1Uck9xenB2aFlwU29uMzRrVmlNaWZHY2lnZFFqalBJdk00eWU4amVuaS9QKytaTmVxOFZWeFNGay81Yzg3YS84MTRjTFg2WGZPR2x2WitlTnVjTzA3S3UxK0xXaU5vQmJEY0cycGxKekxkRks3Qld3b1NTV3BmSWhrOGhmSFNkSzlzZVpJeG01QXFLbHFrUHNDNGk5emVaYVpBUVVrSi9aZWo3UjRrRDVRaXFjNmpjcnFheEdHc1lsNHMzUWM0ZmtWdmhYblJVQ2l2ZGdpMEtUYS8zcXlWWU9QTktIV2huTlZxMEZHNDNjME4vaWh6dDc0d1laNVl6aDFJRitHU2t1YTkrN1pCdnQ2VGs1cFRhZmVVclk0ckNPL2Fobnl1eXFLOG53ZkorVWxUTmt2ZVNFS29FdTNiUWQzSmc5R1lYWHlXOVVxRGo5dHJIZ1N5M3ZZa0dBWjd0MDZNZWUwQnBsdFBxWExaIiwiT3JkZXJJZCI6Ijk1MzcxMjAwNDEyNi0wMSIsIk1lc3NhZ2VJZCI6ImI5YjI4NDkwLTNjNzAtNDdjNi1hMTE3LWNhN2FjMTk2MDY1OSIsIkRvbWFpbiI6IkZ1bGZpbGxtZW50IiwiU3RhdGUiOiJyZWFkeS1mb3ItaGFuZGxpbmciLCJMYXN0U3RhdGUiOiJ3aW5kb3ctdG8tY2FuY2VsIiwiTGFzdENoYW5nZSI6IjA4LzEyLzIwMTkgMjA6NTQ6MDEiLCJDdXJyZW50Q2hhbmdlIjoiMDgvMTIvMjAxOSAyMDo1NDoyMyIsIkNyZWF0ZWRBdCI6IjA4LzEyLzIwMTkgMjE6MDE6MzAiLCJpc3MiOiJicm9hZGNhc3QtYXBpLnZ0ZXhjb21tZXJjZS5jb20uYnIiLCJhdWQiOiJwYXJ0bmVyc2xhdGFtX3Z0ZXhhcHBrZXktcGFydG5lcnNsYXRhbS1STUJKTVMifQ.7RQBZQb6pHhFhA_jMKTiSoJbDck7awgD3Xx7sdJcW6w\",\n \"domain\": \"Fulfillment\",\n \"state\": \"ready-for-handling\",\n \"lastState\": \"window-to-cancel\",\n \"orderId\": \"953712004126-01\",\n \"lastChange\": \"2019-08-12T20:54:01.134057Z\",\n \"currentChange\": \"2019-08-12T20:54:23.7153839Z\"\n }\n]"}],"_postman_id":"d2a8fc63-0d71-42bd-8b82-80a351e7981b"},{"name":"Commit item feed order status","id":"902bce4d-bd58-4551-a1e4-10d2aef7158d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"body":{"mode":"raw","raw":"{\n \"handles\":[\n \"AQEBSM/bSqonHYtx+UrHdbuJ0i7M9yMbI2jtYwMIPdEc4BenuneaCTC9VEJ3dgAy1XtfQvHBvgwZTO8LvGObIKNqiKXDZiMKY25vK+pblZEqf1pWdLMugu5XoHA5ZAd4IcBcXrBcrlr1GU8uvPEBoVLOsVBP9IAxIZkkeEedIDg3K6GPyEXVuPlTEYb/0OCunEGxWF+AZ1frFdXh7ulORTcuqO5oDlBGbpD+QYzCmF4mUZtQ0VVWh9icM1QBVh6PlJ0D/lfwnJKWpBn3jf8c+DTm7sD7wb1Lcz9uWMLhDtPwvH9vue4MvKU9sCahEQe7K5jWuwwb54szGbFKdfcACsTSQ9WlyBfMdbV83c27k68G3cnaBFExkC1MLHHE9UzpQ6l4s43BT4k95ocgMXffnj/HMUYXn+OCvlvjytY59x1OCRE=\"\n ]\n}"},"url":"https://{{accountName}}.myvtex.com/api/orders/feed","description":"

Order status event acknowledge

\n
know more about Feed v3 in VTEX Help
\n

Request object has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`handles`	string	Event status order handle

Response codes

200 - Success

429 - Too many requests

403 - The credentials is not enabled to access the service

404 - Not found value

Authentication

This is a private API and need a appKey and appToken with admin access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","orders","feed"],"host":["{{accountName}}","myvtex","com"],"query":[],"variable":[]}},"response":[{"id":"67002e4a-1c01-488b-88d4-2f72142fb722","name":"Confirm item feed order status","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"body":{"mode":"raw","raw":"{\n \"handles\":[\n \"AQEBSM/bSqonHYtx+UrHdbuJ0i7M9yMbI2jtYwMIPdEc4BenuneaCTC9VEJ3dgAy1XtfQvHBvgwZTO8LvGObIKNqiKXDZiMKY25vK+pblZEqf1pWdLMugu5XoHA5ZAd4IcBcXrBcrlr1GU8uvPEBoVLOsVBP9IAxIZkkeEedIDg3K6GPyEXVuPlTEYb/0OCunEGxWF+AZ1frFdXh7ulORTcuqO5oDlBGbpD+QYzCmF4mUZtQ0VVWh9icM1QBVh6PlJ0D/lfwnJKWpBn3jf8c+DTm7sD7wb1Lcz9uWMLhDtPwvH9vue4MvKU9sCahEQe7K5jWuwwb54szGbFKdfcACsTSQ9WlyBfMdbV83c27k68G3cnaBFExkC1MLHHE9UzpQ6l4s43BT4k95ocgMXffnj/HMUYXn+OCvlvjytY59x1OCRE=\"\n ]\n}"},"url":"https://{{accountName}}.myvtex.com/api/orders/feed"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"902bce4d-bd58-4551-a1e4-10d2aef7158d"},{"name":"Feed Configuration","id":"7dcfc91b-9264-4ddf-9e63-b1940679bbe8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"body":{"mode":"raw","raw":"{\n\t\"filter\": {\n\t\t\"status\": [\"order-completed\",\"start-handling\", \"handling\", \"ready-for-handling\", \"waiting-ffmt-authorization\", \"cancel\"]\n\t},\n\t\"queue\":{\n\t\t\n\t\t\"visibilityTimeoutInSeconds\": 250,\n\t\t\"MessageRetentionPeriodInSeconds\":345600\n\t}\n}"},"url":"https://{{accountName}}.myvtex.com/api/orders/feed/config","description":"

Configure the filter rule to Feed V3

\n
know more about Feed v3 in VTEX Help
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`filter`	object	Status Filter Array Details
`status`	object	The events status array to filter
`queue`	object	Array of string
`visibilityTimeoutInSeconds`	integer	Visibility Timeout in Seconds: 30 minimum and 86400 max value
`MessageRetentionPeriodInSeconds`	integer	Visibility Timeout in Seconds: 345600 minimum and 1209600 max value

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status avaible to filter
order-created order-completed
on-order-completed
payment-pending
waiting-for-order-authorization
approve-payment
payment-approved
payment-denied
request-cancel
waiting-for-seller-decision
authorize-fulfillment
order-create-error
order-creation-error
window-to-cancel
ready-for-handling
start-handling
handling
invoice-after-cancellation-deny
order-accepted
invoice
invoiced
replaced
cancellation-requested
cancel
canceled

\n
know more about Order Status in VTEX Help
\n

\n
The event will be removed if the message send retry is equal to or greater than the maximum retention period
\n

Response codes

200 - Success

403 - The credentials is not enabled to access the service

404 - Not found value

429 - Too many requests

Authentication

This is a private API and need a appKey and appToken with admin access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","orders","feed","config"],"host":["{{accountName}}","myvtex","com"],"query":[],"variable":[]}},"response":[{"id":"d6e147d1-047c-4e0a-94e4-d2349ccf45c8","name":"Feed Configuration","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"body":{"mode":"raw","raw":"{\n\t\"filter\": {\n\t\t\"status\": [\"order-completed\",\"start-handling\", \"handling\", \"ready-for-handling\", \"waiting-ffmt-authorization\", \"cancel\"]\n\t},\n\t\"queue\":{\n\t\t\n\t\t\"visibilityTimeoutInSeconds\": 250,\n\t\t\"MessageRetentionPeriodInSeconds\":345600\n\t}\n}"},"url":"https://accountname.myvtex.com/api/orders/feed/config"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7dcfc91b-9264-4ddf-9e63-b1940679bbe8"},{"name":"Get Feed Configuration","id":"53c2cbed-e755-4cc9-9caa-ae672d26a818","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"url":"https://{{accountName}}.myvtex.com/api/orders/feed/config","description":"

Request has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`accountName`	string	Account Name

Authentication

This is a private API and need a appKey and appToken with viewer access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","orders","feed","config"],"host":["{{accountName}}","myvtex","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"53c2cbed-e755-4cc9-9caa-ae672d26a818"},{"name":"Feed Configuration Delete","id":"8131fe8f-4363-4c49-b6c0-5fc0a451596e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{accountName}}.myvtex.com/api/orders/feed/config","description":"

Delete Feed V3 Configuration

\n
know more about Feed v3 in VTEX Help
\n

Response codes

200 - Success

403 - The credentials is not enabled to access the service

400 Bad Request - \"Unable to check address\" / \"Only https scheme is accepted\"

404 - Not found value

429 - Too many requests

Authentication

This is a private API and need a appKey and appToken with admin access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

Check this article to learn more about the OMS feed: https://help.vtex.com/en/tutorial/how-the-oms-feed-works

\n","event":[{"listen":"prerequest","script":{"id":"6639a030-a359-4d58-ba7a-a3baefeb00e6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b2c4bfdf-b5a1-4eb8-9c79-28441627ae8a","type":"text/javascript","exec":[""]}}],"_postman_id":"a87113d4-fdc2-4ebd-8f90-a6120fe63091"},{"name":"Order Hook","item":[{"name":"Hook Configuration","id":"7fd6e368-cf44-4323-a38a-5dcb5d996777","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"body":{"mode":"raw","raw":"{\n \"filter\": {\n \"status\": [\"order-completed\", \"handling\", \"ready-for-handling\", \"waiting-ffmt-authorization\", \"cancel\"]\n },\n \"hook\": {\n \"url\": \"https://endpoint.example/path\",\n \"headers\": {\n \"key\": \"value\"\n }\n }\n}"},"url":"https://{{accountName}}.myvtex.com/api/orders/hook/config","description":"

Configure endpoint and filter rule to Order Hook

\n
know more about Feed v3 in VTEX Help
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`filter`	object	Status Filter Array
`status`	object	The events status to filter
`hook`	object	Object of EndPoint infos
`url`	integer	End Point URL
`headers`	object	Credentials Array
`key`	string	Endpoint key

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status avaible to filter
order-created order-completed
on-order-completed
payment-pending
waiting-for-order-authorization
approve-payment
payment-approved
payment-denied
request-cancel
waiting-for-seller-decision
authorize-fulfillment
order-create-error
order-creation-error
window-to-cancel
ready-for-handling
start-handling
handling
invoice-after-cancellation-deny
order-accepted
invoice
invoiced
replaced
cancellation-requested
cancel
canceled

\n
know more about Order Status in VTEX Help
\n

Response codes

200 - Success

400 Bad Request - \"Unable to check address\" / \"Only https scheme is accepted\"

403 - The credentials is not enabled to access the service

404 - Not found value

429 - Too many requests

\n
The status event will be removed if can not deliver a message more than 100 times, 4 days progressively
\n

Authentication

This is a private API and need a appKey and appToken with admin access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","orders","hook","config"],"host":["{{accountName}}","myvtex","com"],"query":[],"variable":[]}},"response":[{"id":"6b1efc8a-0149-4435-8004-a60156c43c48","name":"Hook Configuration","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"body":{"mode":"raw","raw":"{\n \"filter\": {\n \"status\": [\"order-completed\", \"handling\", \"ready-for-handling\", \"waiting-ffmt-authorization\", \"cancel\"]\n },\n \"hook\": {\n \"url\": \"https://endpoint.example/path\",\n \"headers\": {\n \"key\": \"value\"\n }\n }\n}"},"url":"https://{{accountName}}.myvtex.com/api/orders/hook/config"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"Domain\": \"Fulfillment\",\n \"OrderId\": \"v52277740atmc-01\",\n \"State\": \"ready-for-handling\",\n \"LastState\": \"window-to-cancel\",\n \"LastChange\": \"2019-08-14T17:11:39.2550122Z\",\n \"CurrentChange\": \"2019-08-14T17:12:48.0965893Z\",\n \"Origin\": {\n \"Account\": \"automacaoqa\",\n \"Key\": \"vtexappkey-appvtex\"\n }\n}"}],"_postman_id":"7fd6e368-cf44-4323-a38a-5dcb5d996777"},{"name":"Delete Hook Configuration","id":"59e9eb87-3bf6-457d-b581-e92c9582a103","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{accountName}}.myvtex.com/api/orders/hook/config","description":"

Delete Hook Configuration

\n
know more about Feed v3 in VTEX Help
\n

Response codes

200 - Success

429 - Too many requests

403 - The credentials is not enabled to access the service

404 - Not found value

\n
The status event will be removed if can not deliver a message more than 100 times, 4 days progressively
\n

Authentication

This is a private API and need a appKey and appToken with admin access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","orders","hook","config"],"host":["{{accountName}}","myvtex","com"],"query":[],"variable":[]}},"response":[{"id":"0dd5a99c-565c-4be1-96b9-fbcb5a9a6deb","name":"Delete Hook Configuration","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"X-VTEX-API-AppToken","value":"{{X-VTEX-API-AppToken}}"},{"key":"X-VTEX-API-AppKey","value":"{{X-VTEX-API-AppKey}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{accountName}}.myvtex.com/api/orders/hook/config"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"59e9eb87-3bf6-457d-b581-e92c9582a103"}],"id":"42c78bc4-761f-45be-a8c2-6d872ec79681","_postman_id":"42c78bc4-761f-45be-a8c2-6d872ec79681","description":""},{"name":"Export Order Report","item":[{"name":"Status Completed","id":"b37e98fc-db5c-447f-bbd0-d4fccf28414b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-vtex-api-appKey","value":"{{X-VTEX-API-AppKey}}"},{"key":"x-vtex-api-appToken","value":"{{X-VTEX-API-AppToken}}"}],"url":"https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/admin/reports/completed","description":"

Retrieve a list of all order report completed by accountName

\n
know more about Order export and reports in VTEX Help
\n

\n
Attention! The scope of the export log is per user
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`accountName`	string	Store Account Name

For example, in case you need get a list of all order export completed from accountName luxstore .

You will have to replace the variables accountName for luxstore:

https://luxstore.myvtex.com/api/oms/pvt/admin/reports/completed\n

Response object has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`cancelled`	boolean	If the export request was cancelled
`completedDate`	string	Order Export process completed date
`dateOfRequest`	string	Order Export request date
`email`	string	Order Export requester email
`filter`	string	Order Export request filter
`hostUri`	string	Host URL
`id`	string	Order Export request Id
`instanceId`	string	Instace Id
`lasUpdateTime`	string	Order export process update time
`linkToDownload`	string	Link to Order Export Download
`publishId`	string	Order Export publish Id
`query`	string	Order Export request filter query
`rowNumber`	integer	Order export total rows
`rowsProcessed`	integer	Order export total processed rows
`startDate`	string	Order Export process start date
`utcTime`	string	UTC time

Authentication

This is a private API and need credentials with viewer access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","oms","pvt","admin","reports","completed"],"host":["{{accountName}}","{{environment}}","com","br"],"query":[],"variable":[]}},"response":[{"id":"0339208e-433b-40c7-8dad-420447c7226d","name":"Export Completed Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"The mime type of this content"},{"key":"x-vtex-api-appKey","value":"{{X-VTEX-API-AppKey}}"},{"key":"x-vtex-api-appToken","value":"{{X-VTEX-API-AppToken}}"}],"url":"https://accountname.vtexcommercestable.com.br/api/oms/pvt/admin/reports/completed"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"close","name":"Connection","description":""},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 10 May 2017 18:32:41 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx","name":"Server","description":""},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":""},{"key":"X-CDNIgnore","value":"1","name":"X-CDNIgnore","description":""},{"key":"X-Powered-by-VTEX-Janus-Edge","value":"v1.36.4","name":"X-Powered-by-VTEX-Janus-Edge","description":""},{"key":"X-Track","value":"stable","name":"X-Track","description":""},{"key":"X-VTEX-Janus-Router-Backend-App","value":"omsapi-v1.5.161","name":"X-VTEX-Janus-Router-Backend-App","description":""}],"cookie":[],"responseTime":null,"body":"[{\"id\":\"a83d6d30-a52a-4706-9fc9-e2e7c1841acb\",\"cancelled\":false,\"query\":\"{\\\"Queries\\\":[{\\\"Quoted\\\":true,\\\"FieldName\\\":\\\"InstanceId\\\",\\\"FieldValue\\\":\\\"263FD533551E445CACEEC991385EF610\\\"},{\\\"Quoted\\\":true,\\\"FieldName\\\":\\\"OrderIsComplete\\\",\\\"FieldValue\\\":\\\"True\\\"}],\\\"Oper\\\":\\\"AND\\\"}\",\"filter\":\"generateCsv=true&orderBy=creationDate%2cdesc&page=1&utc=-0300\",\"email\":\"renan.servare@vtex.com.br\",\"hostUri\":\"http://accountname.vtexcommercestable.com.br/\",\"utcTime\":\"-0300\",\"dateOfRequest\":\"2017-05-10T18:31:28.3984674+00:00\",\"startDate\":\"2017-05-10T18:31:27.4043359+00:00\",\"lasUpdateTime\":\"2017-05-10T18:31:35.5250685+00:00\",\"instanceId\":\"i-0b359c34e40c3f281\",\"publishId\":\"263fd533551e445caceec991385ef610\",\"linkToDownload\":\"http://accountname.vtexcommercestable.com.br/api/oms/pub/636300378883984674/report?AWSAccessKeyId=ASIAJM7A43QHIYFHFSMQ&Expires=1494527496&x-amz-security-token=FQoDYXdzEHsaDBnJIX7Yxf7j6gEuTCK3A3AS4wJiFF97%2FpIGtq4rpqA2F7CqU0g%2BIhPPdD%2FaqnF9TKxX1%2BSj4JloO%2F54XdgL3VZyb%2B76Z0FrOZAYnGZvuE%2FMB4KUz1d4NKFOh0sFt%2FxzYFrBOLvMO%2F%2FW3LMG%2FuyiHecP9pYceVysntj41jJeRcLG%2BRBN4Z69TQBQrUp%2FOS%2FOaJFssVvF6olk5WjK9gYxBDpUUiOQvyAIdhmRKiMfhfOSdT%2FgrPG06YGJE18lm4kIThxH3aqE1k2pl3gVd250QRFzGrFRCPgylnlm5C9xEFf2Mr794Dc2I2ki5GCR8Vhxwgi3rlCvI4G8R1PIXcwG7YfFyzb%2BgKUYCsAcvUschtbpWm5ahXZsJG2FioeFIzHbd3xQ5I2yjV9lrKyUiQHjxsyX7Z0dd7YkKkclmOR85wrhgxHLLpOrM021lYNbm1K9a%2FfPjIOxhMt3a1dgkwNaIJmgxnY3n%2FDgNSJsDpYEpckx9tNqbcuCEJYLC54fmbOH%2B3Nip%2Fks3X%2FBmvzo2iB79Y5cucIEkl9wFeKr9kqw5t5u4ciFf%2F4opHnT85eHZm3POEYsD9XxcIHUrlYyLbMawaFwBgklp6oo7LDNyAU%3D&Signature=%2BFGUxl8zViIqttg5f5y%2F9tbAQhw%3D\",\"completedDate\":\"2017-05-10T18:31:35.5530698+00:00\",\"rowsProcessed\":8,\"rowNumber\":8}]"}],"_postman_id":"b37e98fc-db5c-447f-bbd0-d4fccf28414b"},{"name":"Status In Progress","id":"e7c3671b-d171-4c22-ad62-c9aab8ae50d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-vtex-api-appKey","value":"{{X-VTEX-API-AppKey}}"},{"key":"x-vtex-api-appToken","value":"{{X-VTEX-API-AppToken}}"}],"url":"https://{{accountName}}.{{environment}}.com.br/api/oms/pvt/admin/reports/inprogress","description":"

Retrieve a list of all order report in progress by accountName

\n
know more about Order export and reports in VTEX Help
\n

\n
Attention! The scope of the export log is per user
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`accountName`	string	Store Account Name

For example, in case you need get a list of all order export in progress from accountName luxstore .

You will have to replace the variables accountName for luxstore:

https://luxstore.myvtex.com/api/oms/pvt/admin/reports/completed\n

Response object has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`cancelled`	boolean	If the export request was cancelled
`completedDate`	string	Order Export process completed date
`dateOfRequest`	string	Order Export request date
`email`	string	Order Export requester email
`filter`	string	Order Export request filter
`hostUri`	string	Host URL
`id`	string	Order Export request Id
`instanceId`	string	Instace Id
`lasUpdateTime`	string	Order export process update time
`linkToDownload`	string	Link to Order Export Download
`publishId`	string	Order Export publish Id
`query`	string	Order Export request filter query
`rowNumber`	integer	Order export total rows
`rowsProcessed`	integer	Order export total processed rows
`startDate`	string	Order Export process start date
`utcTime`	string	UTC time

Authentication

This is a private API and need credentials with viewer access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","oms","pvt","admin","reports","inprogress"],"host":["{{accountName}}","{{environment}}","com","br"],"query":[],"variable":[]}},"response":[{"id":"3caea366-1be2-40ac-b168-4082dc9764ea","name":"Export In Progress Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"The mime type of this content"},{"key":"x-vtex-api-appKey","value":"{{X-VTEX-API-AppKey}}"},{"key":"x-vtex-api-appToken","value":"{{X-VTEX-API-AppToken}}"}],"url":"https://accountname.vtexcommercestable.com.br/api/oms/pvt/admin/reports/inprogress"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"780","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 10 May 2017 16:21:34 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"nginx","name":"Server","description":""},{"key":"X-CDNIgnore","value":"1","name":"X-CDNIgnore","description":""},{"key":"X-Powered-by-VTEX-Janus-Edge","value":"v1.36.4","name":"X-Powered-by-VTEX-Janus-Edge","description":""},{"key":"X-Track","value":"stable","name":"X-Track","description":""},{"key":"X-VTEX-Janus-Router-Backend-App","value":"omsapi-v1.5.161","name":"X-VTEX-Janus-Router-Backend-App","description":""}],"cookie":[],"responseTime":null,"body":"[{\"id\":\"b7bdafba-2456-4aba-9bc0-1d598df685bd\",\"cancelled\":false,\"query\":\"{\\\"Queries\\\":[{\\\"Quoted\\\":true,\\\"FieldName\\\":\\\"InstanceId\\\",\\\"FieldValue\\\":\\\"263FD533551E445CACEEC991385EF610\\\"},{\\\"Quoted\\\":true,\\\"FieldName\\\":\\\"OrderIsComplete\\\",\\\"FieldValue\\\":\\\"True\\\"}],\\\"Oper\\\":\\\"AND\\\"}\",\"filter\":\"generateCsv=true&orderBy=creationDate%2cdesc&page=1&utc=-0300\",\"email\":\"renan.servare@vtex.com.br\",\"hostUri\":\"http://accountname.vtexcommercestable.com.br/\",\"utcTime\":\"-0300\",\"dateOfRequest\":\"2017-05-10T16:21:31.7452567+00:00\",\"startDate\":\"2017-05-10T16:21:30.7714518+00:00\",\"lasUpdateTime\":\"2017-05-10T16:21:30.7714518+00:00\",\"instanceId\":\"i-0a3b7a89f1fe13ba9\",\"publishId\":\"263fd533551e445caceec991385ef610\",\"linkToDownload\":null,\"completedDate\":null,\"rowsProcessed\":0,\"rowNumber\":null}]"}],"_postman_id":"e7c3671b-d171-4c22-ad62-c9aab8ae50d8"}],"id":"33c3c4a1-7aa1-47f4-8a35-5872f87ec2b4","description":"

Check export request by status

\n","event":[{"listen":"prerequest","script":{"id":"19fd9b4f-fc0d-4da4-9949-bd3fa3bec52e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ffe2fd4f-9120-4f5c-a399-9f231b5f449a","type":"text/javascript","exec":[""]}}],"_postman_id":"33c3c4a1-7aa1-47f4-8a35-5872f87ec2b4"},{"name":"User Orders","item":[{"name":"User orders list","id":"ab6930e4-b0e5-48e2-a6d9-54171c0149e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{accountName}}.{{environment}}.com.br/api/oms/user/orders/?clientEmail={{email}}&page={{pageNumber}}&per_page={{pageSize}}","description":"

Get all a list of all orders from a client by its e-mail

Request object has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`email`	string	Client e-mail
`pageNumber`	string	Page number for result pagination
`pageSize`	boolean	Page quantity for result pagination

\n
User must be authenticated with a valid VTEX ID cookie (VtexIdclientAutCookie_{{store}}) and it must match the requested e-mail.
\n

Response object has the following properties:

Attribute	Type	Description
`list`	object	Order List Object
`orderId`	string	Order ID
`creationDate`	string	Order Creation Date
`clientName`	string	Order Client Name
`items`	object	Obsolete Field
`totalValue`	integer	Total Value Amount
`paymentNames`	string	Payment System Name
`status`	string	Order Status
`statusDescription`	string	Status Description
`marketplaceOrderId`	string	Marketplace Order Id
`sequence`	string	Order Sequence ID
`salesChannel`	string	Order Sales Channel Id
`affiliateId`	string	Seller Name who was responsible for the order
`origin`	string	Order Origin: \"Marketplace\" or \"Fulfillment\"
`workflowInErrorState`	boolean	If is a Work Flow Error
`workflowInRetry`	boolean	If is in a Work Flow Retry
`lastMessageUnread`	string	Last sent transactional message
`shippingEstimateDate`	string	Estimate Shipping Date
`ShippingEstimatedDateMax`	string	???
`ShippingEstimatedDateMin`	string	???
`orderIsComplete`	boolean	If is a Order Completed
`listId`	string	Releated Gift List Id
`listType`	string	Releated Gift List Type
`authorizedDate`	string	Authorized Order Date
`callCenterOperatorData`	string	Call Center Operator responsible for the order
`totalItems`	integer	Total Order Items
`currencyCode`	string	Currency Code in ISO 4217

Authentication

This is a private API and need a appKey and appToken with admin access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","oms","user","orders",""],"host":["{{accountName}}","{{environment}}","com","br"],"query":[{"key":"clientEmail","value":"{{email}}"},{"key":"page","value":"{{pageNumber}}"},{"key":"per_page","value":"{{pageSize}}"}],"variable":[]}},"response":[{"id":"95bcc38b-3af0-47e5-a2b6-5968289bd369","name":"User orders list","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{accountName}}.{{environment}}.com.br/api/oms/user/orders/?clientEmail={{email}}&page={{pageNumber}}&per_page={{pageSize}}","protocol":"https","host":["{{accountName}}","{{environment}}","com","br"],"path":["api","oms","user","orders",""],"query":[{"key":"clientEmail","value":"{{email}}"},{"key":"page","value":"{{pageNumber}}"},{"key":"per_page","value":"{{pageSize}}"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"list\": [\n {\n \"orderId\": \"v502556llux-01\",\n \"creationDate\": \"2019-01-28T20:09:43.0000000+00:00\",\n \"clientName\": \"Cunha VTEX\",\n \"items\": null,\n \"totalValue\": 1160,\n \"paymentNames\": \"Boleto Bancário\",\n \"status\": \"handling\",\n \"statusDescription\": \"Preparando Entrega\",\n \"marketPlaceOrderId\": null,\n \"sequence\": \"502556\",\n \"salesChannel\": \"1\",\n \"affiliateId\": \"\",\n \"origin\": \"Marketplace\",\n \"workflowInErrorState\": false,\n \"workflowInRetry\": false,\n \"lastMessageUnread\": \" Lux Store Seu pedido foi alterado! Pedido realizado em: 28/01/2019 Olá, Rodrigo. Seu pedido foi alterado. Seguem informações abaixo: \",\n \"ShippingEstimatedDate\": \"2019-02-04T20:33:46.0000000+00:00\",\n \"ShippingEstimatedDateMax\": null,\n \"ShippingEstimatedDateMin\": null,\n \"orderIsComplete\": true,\n \"listId\": null,\n \"listType\": null,\n \"authorizedDate\": \"2019-01-28T20:33:04.0000000+00:00\",\n \"callCenterOperatorName\": null,\n \"totalItems\": 1,\n \"currencyCode\": \"BRL\"\n },\n {\n \"orderId\": \"v502449llux-02\",\n \"creationDate\": \"2018-08-28T17:42:40.0000000+00:00\",\n \"clientName\": \"Cunha VTEX\",\n \"items\": null,\n \"totalValue\": 118588,\n \"paymentNames\": \"Promissory\",\n \"status\": \"canceled\",\n \"statusDescription\": \"Cancelado\",\n \"marketPlaceOrderId\": null,\n \"sequence\": \"502452\",\n \"salesChannel\": \"1\",\n \"affiliateId\": \"\",\n \"origin\": \"Marketplace\",\n \"workflowInErrorState\": false,\n \"workflowInRetry\": false,\n \"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\",\n \"ShippingEstimatedDate\": null,\n \"ShippingEstimatedDateMax\": null,\n \"ShippingEstimatedDateMin\": null,\n \"orderIsComplete\": true,\n \"listId\": null,\n \"listType\": null,\n \"authorizedDate\": null,\n \"callCenterOperatorName\": null,\n \"totalItems\": 12,\n \"currencyCode\": \"BRL\"\n },\n {\n \"orderId\": \"v502449llux-01\",\n \"creationDate\": \"2018-08-28T17:42:28.9171556+00:00\",\n \"clientName\": \"Cunha VTEX\",\n \"items\": [\n {\n \"seller\": \"1\",\n \"quantity\": 1,\n \"description\": \"Mangueira Reservatório Ao Cavalete\",\n \"ean\": null,\n \"refId\": \"TE3121110\",\n \"id\": \"195\",\n \"productId\": \"134\",\n \"sellingPrice\": 7390,\n \"price\": 7390\n },\n {\n \"seller\": \"1\",\n \"quantity\": 1,\n \"description\": \"Mangueira Filtro\",\n \"ean\": null,\n \"refId\": \"XC459N610CA\",\n \"id\": \"238\",\n \"productId\": \"162\",\n \"sellingPrice\": 5190,\n \"price\": 5190\n }\n ],\n \"totalValue\": 21526180,\n \"paymentNames\": null,\n \"status\": \"canceled\",\n \"statusDescription\": \"Cancelado\",\n \"marketPlaceOrderId\": \"\",\n \"sequence\": \"502449\",\n \"salesChannel\": \"1\",\n \"affiliateId\": \"\",\n \"origin\": \"Marketplace\",\n \"workflowInErrorState\": false,\n \"workflowInRetry\": false,\n \"lastMessageUnread\": null,\n \"ShippingEstimatedDate\": null,\n \"ShippingEstimatedDateMax\": null,\n \"ShippingEstimatedDateMin\": null,\n \"orderIsComplete\": true,\n \"listId\": null,\n \"listType\": null,\n \"authorizedDate\": null,\n \"callCenterOperatorName\": null,\n \"totalItems\": 0,\n \"currencyCode\": null\n },\n {\n \"orderId\": \"v502058llux-01\",\n \"creationDate\": \"2017-07-25T23:17:36.7963248+00:00\",\n \"clientName\": \"Cunha VTEX\",\n \"items\": [\n {\n \"seller\": \"1\",\n \"quantity\": 1,\n \"description\": \"Aquecedor Britania 1500 Branco\",\n \"ean\": \"1235567890143\",\n \"refId\": \"branquinho\",\n \"id\": \"1234568212\",\n \"productId\": \"1000200\",\n \"sellingPrice\": 35599,\n \"price\": 35599\n }\n ],\n \"totalValue\": 35599,\n \"paymentNames\": null,\n \"status\": \"invoiced\",\n \"statusDescription\": \"Faturado\",\n \"marketPlaceOrderId\": \"\",\n \"sequence\": \"502058\",\n \"salesChannel\": \"1\",\n \"affiliateId\": \"\",\n \"origin\": \"Marketplace\",\n \"workflowInErrorState\": false,\n \"workflowInRetry\": false,\n \"lastMessageUnread\": null,\n \"ShippingEstimatedDate\": \"2017-07-29T19:24:20.7444363+00:00\",\n \"ShippingEstimatedDateMax\": null,\n \"ShippingEstimatedDateMin\": null,\n \"orderIsComplete\": true,\n \"listId\": null,\n \"listType\": null,\n \"authorizedDate\": null,\n \"callCenterOperatorName\": null,\n \"totalItems\": 0,\n \"currencyCode\": null\n },\n {\n \"orderId\": \"v501538llux-01\",\n \"creationDate\": \"2017-06-26T16:57:58.9986524+00:00\",\n \"clientName\": \"Cunha VTEX\",\n \"items\": [\n {\n \"seller\": \"1\",\n \"quantity\": 1,\n \"description\": \"Boneco do Mário\",\n \"ean\": \"bonecomario\",\n \"refId\": \"bonecomario\",\n \"id\": \"1234568183\",\n \"productId\": \"1000257\",\n \"sellingPrice\": 150363,\n \"price\": 150363\n },\n {\n \"seller\": \"1\",\n \"quantity\": 1,\n \"description\": \"Camiseta GG\",\n \"ean\": null,\n \"refId\": \"abc1234\",\n \"id\": \"1234567894\",\n \"productId\": \"1000187\",\n \"sellingPrice\": 899,\n \"price\": 899\n }\n ],\n \"totalValue\": 151262,\n \"paymentNames\": null,\n \"status\": \"invoiced\",\n \"statusDescription\": \"Faturado\",\n \"marketPlaceOrderId\": \"\",\n \"sequence\": \"501538\",\n \"salesChannel\": \"1\",\n \"affiliateId\": \"\",\n \"origin\": \"Marketplace\",\n \"workflowInErrorState\": false,\n \"workflowInRetry\": false,\n \"lastMessageUnread\": null,\n \"ShippingEstimatedDate\": \"2017-06-27T13:59:49.7705236+00:00\",\n \"ShippingEstimatedDateMax\": null,\n \"ShippingEstimatedDateMin\": null,\n \"orderIsComplete\": true,\n \"listId\": null,\n \"listType\": null,\n \"authorizedDate\": null,\n \"callCenterOperatorName\": null,\n \"totalItems\": 0,\n \"currencyCode\": null\n },\n {\n \"orderId\": \"v501020llux-01\",\n \"creationDate\": \"2016-11-21T19:57:54.0415289+00:00\",\n \"clientName\": \"Cunha VTEX\",\n \"items\": [\n {\n \"seller\": \"1\",\n \"quantity\": 2,\n \"description\": \"Camiseta GG\",\n \"ean\": null,\n \"refId\": \"abc1234\",\n \"id\": \"1234567894\",\n \"productId\": \"1000187\",\n \"sellingPrice\": 899,\n \"price\": 899\n }\n ],\n \"totalValue\": 3190,\n \"paymentNames\": null,\n \"status\": \"canceled\",\n \"statusDescription\": \"Cancelado\",\n \"marketPlaceOrderId\": \"\",\n \"sequence\": \"501020\",\n \"salesChannel\": \"1\",\n \"affiliateId\": \"\",\n \"origin\": \"Marketplace\",\n \"workflowInErrorState\": false,\n \"workflowInRetry\": false,\n \"lastMessageUnread\": null,\n \"ShippingEstimatedDate\": \"2016-12-02T08:00:00.0000000+00:00\",\n \"ShippingEstimatedDateMax\": null,\n \"ShippingEstimatedDateMin\": null,\n \"orderIsComplete\": true,\n \"listId\": null,\n \"listType\": null,\n \"authorizedDate\": null,\n \"callCenterOperatorName\": null,\n \"totalItems\": 0,\n \"currencyCode\": null\n },\n {\n \"orderId\": \"v500973llux-01\",\n \"creationDate\": \"2016-10-10T17:19:30.8562035+00:00\",\n \"clientName\": \"Cunha VTEX\",\n \"items\": [\n {\n \"seller\": \"1\",\n \"quantity\": 1,\n \"description\": \"SMARTPHONE SAMSUNG GALAXY S7 FLAT SM-G930FZDLZTO 32GB DOURADO TELA 5.1\\\" 4G CÂMERA 12 MP\",\n \"ean\": null,\n \"refId\": \"testefnac\",\n \"id\": \"1234568028\",\n \"productId\": \"1000203\",\n \"sellingPrice\": 299000,\n \"price\": 299000\n }\n ],\n \"totalValue\": 299900,\n \"paymentNames\": null,\n \"status\": \"handling\",\n \"statusDescription\": \"Preparando Entrega\",\n \"marketPlaceOrderId\": \"\",\n \"sequence\": \"500973\",\n \"salesChannel\": \"1\",\n \"affiliateId\": \"\",\n \"origin\": \"Marketplace\",\n \"workflowInErrorState\": false,\n \"workflowInRetry\": false,\n \"lastMessageUnread\": null,\n \"ShippingEstimatedDate\": \"2016-10-10T14:23:17.1897068+00:00\",\n \"ShippingEstimatedDateMax\": null,\n \"ShippingEstimatedDateMin\": null,\n \"orderIsComplete\": true,\n \"listId\": null,\n \"listType\": null,\n \"authorizedDate\": null,\n \"callCenterOperatorName\": null,\n \"totalItems\": 0,\n \"currencyCode\": null\n },\n {\n \"orderId\": \"v500970llux-01\",\n \"creationDate\": \"2016-10-10T17:07:59.0889392+00:00\",\n \"clientName\": \"Cunha VTEX\",\n \"items\": [\n {\n \"seller\": \"1\",\n \"quantity\": 1,\n \"description\": \"Camiseta GG\",\n \"ean\": null,\n \"refId\": \"abc1234\",\n \"id\": \"1234567894\",\n \"productId\": \"1000187\",\n \"sellingPrice\": 899,\n \"price\": 899\n }\n ],\n \"totalValue\": 1799,\n \"paymentNames\": null,\n \"status\": \"invoiced\",\n \"statusDescription\": \"Faturado\",\n \"marketPlaceOrderId\": \"\",\n \"sequence\": \"500970\",\n \"salesChannel\": \"1\",\n \"affiliateId\": \"\",\n \"origin\": \"Marketplace\",\n \"workflowInErrorState\": false,\n \"workflowInRetry\": false,\n \"lastMessageUnread\": null,\n \"ShippingEstimatedDate\": \"2016-10-10T14:13:34.4927265+00:00\",\n \"ShippingEstimatedDateMax\": null,\n \"ShippingEstimatedDateMin\": null,\n \"orderIsComplete\": true,\n \"listId\": null,\n \"listType\": null,\n \"authorizedDate\": null,\n \"callCenterOperatorName\": null,\n \"totalItems\": 0,\n \"currencyCode\": null\n },\n {\n \"orderId\": \"v500890llux-01\",\n \"creationDate\": \"2016-08-17T18:35:04.8659804+00:00\",\n \"clientName\": \"Cunha VTEX\",\n \"items\": [\n {\n \"seller\": \"1\",\n \"quantity\": 1,\n \"description\": \"Botin Futbol Adidas 11Questra Fg Cesped Hombre Absolut - M\",\n \"ean\": \"absolutm\",\n \"refId\": null,\n \"id\": \"549\",\n \"productId\": \"9\",\n \"sellingPrice\": 1000,\n \"price\": 1000\n }\n ],\n \"totalValue\": 1000,\n \"paymentNames\": null,\n \"status\": \"canceled\",\n \"statusDescription\": \"Cancelado\",\n \"marketPlaceOrderId\": \"\",\n \"sequence\": \"500890\",\n \"salesChannel\": \"1\",\n \"affiliateId\": \"\",\n \"origin\": \"Marketplace\",\n \"workflowInErrorState\": false,\n \"workflowInRetry\": false,\n \"lastMessageUnread\": null,\n \"ShippingEstimatedDate\": null,\n \"ShippingEstimatedDateMax\": null,\n \"ShippingEstimatedDateMin\": null,\n \"orderIsComplete\": true,\n \"listId\": null,\n \"listType\": null,\n \"authorizedDate\": null,\n \"callCenterOperatorName\": null,\n \"totalItems\": 0,\n \"currencyCode\": null\n },\n {\n \"orderId\": \"v500838llux-01\",\n \"creationDate\": \"2016-07-29T00:20:47.7736718+00:00\",\n \"clientName\": \"Cunha VTEX\",\n \"items\": [\n {\n \"seller\": \"1\",\n \"quantity\": 1,\n \"description\": \"Rooibos Lavanda - Pouch - 50gr\",\n \"ean\": \"198\",\n \"refId\": \"10098\",\n \"id\": \"98\",\n \"productId\": \"1000025\",\n \"sellingPrice\": 5200,\n \"price\": 5200\n }\n ],\n \"totalValue\": 6200,\n \"paymentNames\": null,\n \"status\": \"canceled\",\n \"statusDescription\": \"Cancelado\",\n \"marketPlaceOrderId\": \"\",\n \"sequence\": \"500838\",\n \"salesChannel\": \"1\",\n \"affiliateId\": \"\",\n \"origin\": \"Marketplace\",\n \"workflowInErrorState\": false,\n \"workflowInRetry\": false,\n \"lastMessageUnread\": null,\n \"ShippingEstimatedDate\": null,\n \"ShippingEstimatedDateMax\": null,\n \"ShippingEstimatedDateMin\": null,\n \"orderIsComplete\": true,\n \"listId\": null,\n \"listType\": null,\n \"authorizedDate\": null,\n \"callCenterOperatorName\": null,\n \"totalItems\": 0,\n \"currencyCode\": null\n }\n ],\n \"facets\": [],\n \"paging\": {\n \"total\": 19,\n \"pages\": 10,\n \"currentPage\": 1,\n \"perPage\": 2\n },\n \"stats\": {\n \"stats\": {\n \"totalValue\": {\n \"Count\": 19,\n \"Max\": 0,\n \"Mean\": 0,\n \"Min\": 0,\n \"Missing\": 0,\n \"StdDev\": 0,\n \"Sum\": 0,\n \"SumOfSquares\": 0,\n \"Facets\": {}\n },\n \"totalItems\": {\n \"Count\": 19,\n \"Max\": 0,\n \"Mean\": 0,\n \"Min\": 0,\n \"Missing\": 0,\n \"StdDev\": 0,\n \"Sum\": 0,\n \"SumOfSquares\": 0,\n \"Facets\": {}\n }\n }\n }\n}"}],"_postman_id":"ab6930e4-b0e5-48e2-a6d9-54171c0149e9"},{"name":"User order details","id":"fec694dd-76e4-4d8c-91f2-9bdb05d25f70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{accountName}}.{{environment}}.com.br/api/oms/user/orders/{{orderId}}?clientEmail={{email}}","description":"

Get all details from a order in client pespective

Request object has the following properties:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
`orderId`	string	Order ID
`email`	string	Client e-mail

\n
User must be authenticated with a valid VTEX ID cookie (VtexIdclientAutCookie_{{store}}) and it must match the requested e-mail.
\n

Response object has the following properties:

Attribute	Type	Description
`affiliateId`	string	Seller Name who was responsible for the order
`allowCancellation`	boolean	If Cancellation is allowed
`allowEdition`	boolean	If Order Edition is allowed
`approvedBy`	string	User who approved the order
`authorizedDate`	string	Authorized Order Date
`callCenterOperatorData`	string	Call Center Operator responsible for the order
`cancelReason`	string	Cancel Reason
`cancelledBy`	string	User who Cancelled the order
`changesAttachment`	object	Change details object
`changesData`	object	Array with each change
`discountValue`	integer	Change Discount Value
`incrementValue`	integer	Change Increment Value
`itemsAdded`	object	Added items details
`itemsRemoved`	object	Removed items details
`id`	integer	Changed SKU ID
`name`	string	Changed SKU Name
`price`	integer	Changed SKU Price
`quantity`	integer	Changed SKU Quantity
`unitMultiplier`	integer	Changed SKU Unit Multiplier
`reason`	string	Change Reason
`receipt`	object	Change receipt details object
`date`	string	Change receipt date
`orderId`	string	Change receipt order Id
`receipt`	object	Change receipt ID
`id`	string	Object Id, expect value \"changeAttachment\"
`clientProfileData`	object	Object with all Cliente Profile Data
`corporateDocument`	string	Client Corporate Document
`corporateName`	string	Client Corporate Name
`corporatePhone`	string	Cliente Corporate Telephone
`customerClass`	string	???
`document`	string	Client Document
`documentType`	string	Client Document Type
`email`	string	Client e-mail
`firstName`	string	Client First Name
`id`	string	Object ID, expected value \"clientProfileData\"
`isCorporate`	string	If the Client is a Corporate Client
`lastName`	string	Client Last Name
`phone`	string	Client Telephone
`stateInscription`	string	Client Corporate Inscription
`tradeName`	string	Client Corporate Trade Name
`userProfileId`	string	Client User Profile ID
`commercialConditionData`	string	???
`creationDate`	string	Order Creation Date
`customData`	object	Custom Data Object
`customApps`	object	Custom Apps details Object
`fields`	object	Custom App Fields
`id`	string	Custom App Id
`major`	integer	???
`emailTracked`	string	Client Conversation Tracker E-mail
`followUpEmail`	string	Responsible store e-mail
`giftRegistryData`	string	???
`hostname`	string	Account Hostname registered in License Manager
`invoiceData`	string	???
`invoicedDate`	string	Invoice Date
`isCheckedIn`	string	???
`isCompleted`	boolean	If is a Order Completed
`items`	object	Order Items Object
`additionalInfo`	Order Item Additional Info
`brandId`	string	Brand ID
`brandName`	string	Brand Name
`categoriesIds`	string	Item Category ID
`commercialConditionId`	string	Invoice Date
`dimension`	string	Item Dimension Object
`cubicweight`	string	Item Cubic Weight
`height`	string	Item Height
`length`	string	Item Length
`weight`	string	Item Weight
`width`	string	Item Width
`offeringInfo`	string	???
`offeringType`	string	???
`offeringTypeId`	string	???
`productClusterId`	string	All releated Product Clusters
`attachments`	object	Attachents Array
`content`	object	Attachment Content Custom Field
`name`	string	Attachment Name
`bundleItems`	object	Invoice Date
`commission`	string	Comission value registered to Seller
`components`	object	???
`detailUrl`	string	Product Slug URL
`ean`	string	SKU EAN
`freightCommission`	integer	Comission value registered to Seller
`id`	string	SKU Id
`imageUrl`	string	SKU Image URL
`isGift`	string	If this item is a gift in order context
`itemAttachment`	object	Attachment Object
`content`	object	Attachment Content Array
`name`	string	Attachment Name
`listPrice`	integer	Item List Price
`lockId`	string	Reservation ID
`manualPrice`	string	???
`measurementUnit`	string	Item Measurement Unit
`name`	string	Item Name
`offerings`	object	???
`params`	object	???
`preSaleDate`	string	Item Pre Sale Date
`price`	integer	Item Price
`priceDefinitions`	string	???
`priceTags`	object	Object with all price modifier
`identifier`	string	Price Tag ID
`isPercentual`	boolean	If the Price Tag is a Percentual modifier
`name`	string	Price Tag Name
`rawValue`	string	Price Tag Raw Value
`value`	string	Price Tag Value
`priceValidUntil`	object	???
`productId`	string	Item Product ID
`quantity`	integer	Item Quantity
`refId`	string	Item Reference ID
`rewardValue`	integer	Item Reward value
`seller`	string	Item Seller
`sellerSku`	string	Invoice Date
`sellingPrice`	integer	Item Selling Price
`shippingPrice`	string	Item Shipping Price
`tax`	integer	Item Tax
`taxCode`	string	Item Tax Code
`uniqueId`	string	Item Order Unique ID
`unitMultiplier`	integer	Item Unit Multipler
`lastChange`	string	Order Last Change Date
`lastMessage`	string	???
`marketingData`	string	Marketing Data Object
`coupon`	string	Order Disccount Coupon
`id`	string	Object ID, expected value \"marketingData\"
`marketingTags`	object	Marketing Tags Array
`utmCampaign`	string	UTM Campaign Parameters
`utmMedium`	string	UTM Medium Parameters
`utmPartner`	string	UTM Source Parameters
`utmSource`	string	UTM Source Parameters
`utmiCampaign`	string	UTMI Campaign Internal Parameters
`utmiPart`	string	UTMI Part Internal Parameters
`utmipage`	string	UTMI Page Internal Parameters
`marketplace`	object	Marketplace Details Object
`baseURL`	string	Marketplace Base URL
`isCertified`	string	If is a Certified Marketplace
`name`	string	Marketplace Name
`marketplaceItems`	object	Marketplace Details Object
`marketplaceOrderId`	string	Marketplace Order Id
`marketplaceServicesEndpoint`	string	Marketplace Services Endpoint
`merchantName`	string	Merchant Name
`openTextField`	object	Open Text Field Object
`value`	string	Open Text Field Value
`orderFormId`	string	Order Form Id
`orderGroup`	string	Order Group Id
`orderId`	string	Order Id
`origin`	string	Order Origin: \"Marketplace\" or \"Fulfillment\"
`packageAttachment`	object	Package Object
`packages`	object	Packages Details Object, populated after order invoiced
`cfop`	string	???
`courier`	string	Package selected Courier
`courierStatus`	string	Package Tracking Status
`data`	object	Package Tracking Timeline
`finished`	string	If the delivery are finished
`status`	string	Courier Status
`embeddedInvoice`	???
`invoiceKey`	string	Invoice Credencial Key
`invoiceNumber`	string	Package Invoice Number
`invoiceUrl`	string	Package Invoice URL
`invoiceValue`	string	Package Invoice Value
`issuanceDate`	string	Package Issuance Date
`items`	string	Items Package Array
`description`	string	Item Desciprtion
`itemIndex`	string	Item Index
`price`	string	Item Price
`quantity`	string	Item Quantity
`unitMultiplier`	string	Unit Multiplier
`trackingNumber`	string	Package Tracking Number
`trackingUrl`	string	Tracking Order URL
`type`	string	Invoice Type, expected values \"Output\" and \"Input\"
`paymentData`	object	Payment Object
`transactions`	object	Transactions Object
`isActive`	boolean	If the payment is Active
`merchantName`	string	Merchant Name
`payments`	object	Payment Object
`cardHolder`	string	Payment Card Holder
`cardNumber`	string	Payment Card Number
`connectorResponses`	object	Connector Responses Object
`Message`	string	Connector Responses Message
`ReturnCode`	string	Connector Return Code
`Tid`	string	Connector Transaction Id
`acquirer`	string	Connector Acquirer
`authId`	string	Connector Authorization Id
`cvv2`	string	???
`dueDate`	string	Payment Due Date
`expireMonth`	string	Payment Card expire Month
`expireYear`	string	Payment Card expire Year
`firstDigits`	string	Payment Card First Digits
`giftCardCaption`	string	Gift Card Caption
`giftCardId`	string	Gift Card Id
`giftCardName`	string	Gift Card Name
`group`	string	Payment Group
`id`	string	Payment Id
`installments`	string	Payment Installments Quantity
`lastDigits`	string	Payment Card Last Digits
`paymentSystem`	string	Payment System Type Id
`paymentSystemName`	string	Payment System Name
`redemptionCode`	string	Gift Card Redemption Code
`referenceValue`	string	Payment Reference Value
`tid`	string	Payment Transaction Id
`url`	string	Payment URL
`value`	string	Payment Value
`transactionId`	string	Transaction Id
`ratesAndBenefitsData`	string	Rates and Benefits Data Object
`id`	string	Object ID, expected value \"ratesAndBenefitsData\"
`rateAndBenefitsIdentifiers`	object	Rates and Benefits Details Object
`additionalInfo`	string	Rates and Benefits Additional Info
`description`	string	Rates and Benefits Description
`featured`	string	If is allowed to acumulate the Rates and Benefits
`matchedParameters`	object	March Parameters Array
`name`	string	Rates and Benefits Name
`roundingError`	integer	Rounding Error Total Amount
`salesChannel`	string	Order Sales Channel Id
`sellerOrderId`	string	Order Seller Id
`sellers`	object	Sellers Array
`id`	string	Seller Id
`logo`	string	URL Seller Logo
`name`	string	Seller Name
`sequence`	string	Order Sequence ID
`shippingData`	object	Shipping Data Object
`address`	object	Shipping Address
`addressId`	string	Shipping Address Id
`addressType`	string	Shipping Address Type
`city`	string	Shipping City
`complement`	string	Shipping Complement
`country`	string	Shipping Country in ISO 3166 ALPHA-3 abbreviation
`geoCoordinates`	object	Shipping Geo Coordinates Array
`neighborhood`	string	Shipping Neighborhood
`number`	string	Shipping Number
`postalCode`	string	Shipping Postal Code
`receiverName`	string	Shipping Receiver Name
`reference`	string	Shipping Reference
`state`	string	Shipping State
`street`	string	Shipping Street
`id`	string	Object ID, expected value \"shippingData\"
`logisticsInfo`	object	Logistics Info Object
`addressId`	string	Adress Id
`deliveryChannel`	string	Delivery Channel, allowed values \"delivery\" or \"pickup-in-point\"
`deliveryCompany`	string	Courier Company Name
`deliveryIds`	object	Delivery Ids Object
`courierId`	string	Courier Id
`courierName`	string	Courier Name
`dockId`	string	Releated Dock Id
`quantity`	integer	Items Quantity
`warehouseId`	string	Releated Warehouse Id
`deliveryWindow`	object	Delivery Window Object
`endDateUtc`	string	Delivery Date End in UTC
`price`	string	Delivery Window Cost
`startDateUtc`	string	Delivery Date Starts in UTC
`itemIndex`	integer	Logistic Info Item Index
`listPrice`	integer	Logistic Info Item List Price
`lockTTL`	string	???
`pickupStoreInfo`	object	Pickup Store Info Object
`additionalInfo`	string	Pickup Store Additional Info
`address`	string	Pickup Store Address
`dockId`	string	Pickup Store Releated Dock Id
`friendlyName`	string	Pickup Store Friendly Name
`isPickupStore`	boolean	If is a Pickup Store
`polygonName`	string	Releated Polygom Name
`price`	integer	Logistic Info Item Price
`selectedSla`	string	Selected SLA
`sellingPrice`	integer	Logistic Info Item Selling Price
`shippingEstimate`	string	Estimate Shipping Duration
`shippingEstimateDate`	string	Estimate Shipping Date
`shipsTo`	object	Shipping Country in ISO 3166 ALPHA-3 abbreviation
`slas`	object	SLAs Object
`deliveryChannel`	string	Delivery Channel, allowed values \"delivery\" or \"pickup-in-point\"
`deliveryWindow`	object	Delivery Window Object
`endDateUtc`	string	Delivery Date End in UTC
`price`	string	Delivery Window Cost
`startDateUtc`	string	Delivery Date Starts in UTC
`id`	string	SLA Id
`pickupStoreInfo`	object	Pickup Store Details Object
`additionalInfo`	string	Pickup Store Additional Info
`address`	string	Pickup Store Address
`dockId`	string	Pickup Store releated Dock Id
`friendlyName`	string	Pickup Store Friendly Name
`isPickupStore`	boolean	If is a Pickup Store
`polygonName`	string	Releated Polygon Name
`price`	integer	SLA Price
`shippingEstimate`	string	SLA Shipping Estimate
`selectedAddresses`	object	Selected Address Details Object
`addressId`	string	Shipping Address Id
`addressType`	string	Shipping Address Type
`city`	string	Shipping City
`complement`	string	Shipping Complement
`country`	string	Shipping Country in ISO 3166 ALPHA-3 abbreviation
`geoCoordinates`	object	Shipping Geo Coordinates Array
`neighborhood`	string	Shipping Neighborhood
`number`	string	Shipping Number
`postalCode`	string	Shipping Postal Code
`receiverName`	string	Shipping Receiver Name
`reference`	string	Shipping Reference
`state`	string	Shipping State
`street`	string	Shipping Street
`trackingHints`	string	???
`status`	string	Order Status
`statusDescription`	string	Status Description
`storePreferencesData`	object	Store Preferences Data Object
`countryCode`	string	Country Code in ISO 3166 ALPHA-3 abbreviation
`currencyCode`	string	Currency Code in ISO 4217
`currencyFormatInfo`	object	Currency Format Info Object
`CurrencyDecimalDigits`	integer	Currency Decimal Digits
`CurrencyDecimalSeparator`	string	Currency Decimal Separator
`CurrencyGroupSeparator`	string	Currency Group Separator
`CurrencyGroupSize`	integer	Currency Group Size
`StartsWithCurrencySymbol`	boolean	If Starts With Currency Symbol
`currencyLocale`	integer	LCID Decimal
`currencySymbol`	string	Currency Symbol
`timeZone`	string	Order Time Zone
`totals`	object	Totals Object
`id`	string	Totals Ids, expected values: \"Items\", \"Discounts\", \"Shipping\" and \"Tax\"
`name`	string	Totals ID Description
`value`	integer	Totals Value
`value`	integer	Order Value

Authentication

This is a private API and need a appKey and appToken with admin access

\n
know more about Creating appKeys and appTokens to authenticate integrations
\n

\n","urlObject":{"protocol":"https","path":["api","oms","user","orders","{{orderId}}"],"host":["{{accountName}}","{{environment}}","com","br"],"query":[{"key":"clientEmail","value":"{{email}}"}],"variable":[]}},"response":[{"id":"e078a386-5f33-4a48-a036-88b961181db8","name":"User order details","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{accountName}}.{{environment}}.com.br/api/oms/user/orders/{{orderId}}?clientEmail={{email}}","protocol":"https","host":["{{accountName}}","{{environment}}","com","br"],"path":["api","oms","user","orders","{{orderId}}"],"query":[{"key":"clientEmail","value":"{{email}}"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"orderId\": \"v502556llux-01\",\n \"sequence\": \"502556\",\n \"marketplaceOrderId\": \"\",\n \"marketplaceServicesEndpoint\": \"http://oms.vtexinternal.com.br/api/oms?an=luxstore\",\n \"sellerOrderId\": \"00-v502556llux-01\",\n \"origin\": \"Marketplace\",\n \"affiliateId\": \"\",\n \"salesChannel\": \"1\",\n \"merchantName\": \"luxstore\",\n \"status\": \"handling\",\n \"statusDescription\": \"Preparando Entrega\",\n \"value\": 1160,\n \"creationDate\": \"2019-01-28T20:09:43.8999580+00:00\",\n \"lastChange\": \"2019-02-06T20:46:11.7010747+00:00\",\n \"orderGroup\": \"v502556lspt\",\n \"totals\": [\n {\n \"id\": \"Items\",\n \"name\": \"Total dos Itens\",\n \"value\": 3290\n },\n {\n \"id\": \"Discounts\",\n \"name\": \"Total dos Descontos\",\n \"value\": 0\n },\n {\n \"id\": \"Shipping\",\n \"name\": \"Total do Frete\",\n \"value\": 1160\n },\n {\n \"id\": \"Tax\",\n \"name\": \"Total da Taxa\",\n \"value\": 0\n },\n {\n \"id\": \"Change\",\n \"name\": \"Total das mudanças\",\n \"value\": -3290\n }\n ],\n \"items\": [\n {\n \"uniqueId\": \"87F0945396994B349158C7D9C9941442\",\n \"id\": \"1234568358\",\n \"productId\": \"9429485\",\n \"ean\": null,\n \"lockId\": \"00-v502556llux-01\",\n \"itemAttachment\": {\n \"content\": {},\n \"name\": null\n },\n \"attachments\": [],\n \"quantity\": 1,\n \"seller\": \"1\",\n \"name\": \"Bay Max L\",\n \"refId\": \"BIGHEROBML\",\n \"price\": 3290,\n \"listPrice\": 3290,\n \"manualPrice\": null,\n \"priceTags\": [],\n \"imageUrl\": \"http://luxstore.vteximg.com.br/arquivos/ids/159263-55-55/image-cc1aed75cbfa424a85a94900be3eacec.jpg?v=636795432619830000\",\n \"detailUrl\": \"/bay-max-9429485/p\",\n \"components\": [],\n \"bundleItems\": [],\n \"params\": [],\n \"offerings\": [],\n \"sellerSku\": \"1234568358\",\n \"priceValidUntil\": null,\n \"commission\": 0,\n \"tax\": 0,\n \"preSaleDate\": null,\n \"additionalInfo\": {\n \"brandName\": \"VTEX\",\n \"brandId\": \"2000023\",\n \"categoriesIds\": \"/1/\",\n \"productClusterId\": \"135,142\",\n \"commercialConditionId\": \"5\",\n \"dimension\": {\n \"cubicweight\": 0.7031,\n \"height\": 15,\n \"length\": 15,\n \"weight\": 15,\n \"width\": 15\n },\n \"offeringInfo\": null,\n \"offeringType\": null,\n \"offeringTypeId\": null\n },\n \"measurementUnit\": \"un\",\n \"unitMultiplier\": 1,\n \"sellingPrice\": 3290,\n \"isGift\": false,\n \"shippingPrice\": null,\n \"rewardValue\": 0,\n \"freightCommission\": 0,\n \"priceDefinitions\": null,\n \"taxCode\": null,\n \"parentItemIndex\": null,\n \"parentAssemblyBinding\": null\n }\n ],\n \"marketplaceItems\": [],\n \"clientProfileData\": {\n \"id\": \"clientProfileData\",\n \"email\": \"rodrigo.cunha@vtex.com.br\",\n \"firstName\": \"Rodrigo\",\n \"lastName\": \"Cunha\",\n \"documentType\": \"cpf\",\n \"document\": \"11047867702\",\n \"phone\": \"+5521972321094\",\n \"corporateName\": null,\n \"tradeName\": null,\n \"corporateDocument\": null,\n \"stateInscription\": null,\n \"corporatePhone\": null,\n \"isCorporate\": false,\n \"userProfileId\": \"5a3692de-358a-4bea-8885-044bce33bb93\",\n \"customerClass\": null\n },\n \"giftRegistryData\": null,\n \"marketingData\": null,\n \"ratesAndBenefitsData\": {\n \"id\": \"ratesAndBenefitsData\",\n \"rateAndBenefitsIdentifiers\": []\n },\n \"shippingData\": {\n \"id\": \"shippingData\",\n \"address\": {\n \"addressType\": \"residential\",\n \"receiverName\": \"Rodrigo Cunha\",\n \"addressId\": \"-1425945657910\",\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"street\": \"Praia de Botafogo\",\n \"number\": \"518\",\n \"neighborhood\": \"Botafogo\",\n \"complement\": \"10\",\n \"reference\": null,\n \"geoCoordinates\": []\n },\n \"logisticsInfo\": [\n {\n \"itemIndex\": 0,\n \"selectedSla\": \"Normal\",\n \"lockTTL\": \"10d\",\n \"price\": 1160,\n \"listPrice\": 1160,\n \"sellingPrice\": 1160,\n \"deliveryWindow\": null,\n \"deliveryCompany\": \"Todos os CEPS\",\n \"shippingEstimate\": \"5bd\",\n \"shippingEstimateDate\": \"2019-02-04T20:33:46.4595004+00:00\",\n \"slas\": [\n {\n \"id\": \"Normal\",\n \"name\": \"Normal\",\n \"shippingEstimate\": \"5bd\",\n \"deliveryWindow\": null,\n \"price\": 1160,\n \"deliveryChannel\": \"delivery\",\n \"pickupStoreInfo\": {\n \"additionalInfo\": null,\n \"address\": null,\n \"dockId\": null,\n \"friendlyName\": null,\n \"isPickupStore\": false\n },\n \"polygonName\": null\n },\n {\n \"id\": \"Expressa\",\n \"name\": \"Expressa\",\n \"shippingEstimate\": \"5bd\",\n \"deliveryWindow\": null,\n \"price\": 1160,\n \"deliveryChannel\": \"delivery\",\n \"pickupStoreInfo\": {\n \"additionalInfo\": null,\n \"address\": null,\n \"dockId\": null,\n \"friendlyName\": null,\n \"isPickupStore\": false\n },\n \"polygonName\": null\n },\n {\n \"id\": \"Quebra Kit\",\n \"name\": \"Quebra Kit\",\n \"shippingEstimate\": \"2bd\",\n \"deliveryWindow\": null,\n \"price\": 1392,\n \"deliveryChannel\": \"delivery\",\n \"pickupStoreInfo\": {\n \"additionalInfo\": null,\n \"address\": null,\n \"dockId\": null,\n \"friendlyName\": null,\n \"isPickupStore\": false\n },\n \"polygonName\": null\n },\n {\n \"id\": \"Sob Encomenda\",\n \"name\": \"Sob Encomenda\",\n \"shippingEstimate\": \"32bd\",\n \"deliveryWindow\": null,\n \"price\": 1392,\n \"deliveryChannel\": \"delivery\",\n \"pickupStoreInfo\": {\n \"additionalInfo\": null,\n \"address\": null,\n \"dockId\": null,\n \"friendlyName\": null,\n \"isPickupStore\": false\n },\n \"polygonName\": null\n }\n ],\n \"shipsTo\": [\n \"BRA\"\n ],\n \"deliveryIds\": [\n {\n \"courierId\": \"197a56f\",\n \"courierName\": \"Todos os CEPS\",\n \"dockId\": \"1\",\n \"quantity\": 1,\n \"warehouseId\": \"1_1\"\n }\n ],\n \"deliveryChannel\": \"delivery\",\n \"pickupStoreInfo\": {\n \"additionalInfo\": null,\n \"address\": null,\n \"dockId\": null,\n \"friendlyName\": null,\n \"isPickupStore\": false\n },\n \"addressId\": \"-1425945657910\",\n \"polygonName\": null\n }\n ],\n \"trackingHints\": null,\n \"selectedAddresses\": [\n {\n \"addressId\": \"-1425945657910\",\n \"addressType\": \"residential\",\n \"receiverName\": \"Rodrigo Cunha\",\n \"street\": \"Praia de Botafogo\",\n \"number\": \"518\",\n \"complement\": \"10\",\n \"neighborhood\": \"Botafogo\",\n \"postalCode\": \"22250-040\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BRA\",\n \"reference\": null,\n \"geoCoordinates\": []\n }\n ]\n },\n \"paymentData\": {\n \"transactions\": [\n {\n \"isActive\": true,\n \"transactionId\": \"418213DE29634837A63DD693A937A696\",\n \"merchantName\": \"luxstore\",\n \"payments\": [\n {\n \"id\": \"D3DEECAB3C6C4B9EAF8EF4C1FE062FF3\",\n \"paymentSystem\": \"6\",\n \"paymentSystemName\": \"Boleto Bancário\",\n \"value\": 4450,\n \"installments\": 1,\n \"referenceValue\": 4450,\n \"cardHolder\": null,\n \"cardNumber\": null,\n \"firstDigits\": null,\n \"lastDigits\": null,\n \"cvv2\": null,\n \"expireMonth\": null,\n \"expireYear\": null,\n \"url\": \"https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}\",\n \"giftCardId\": null,\n \"giftCardName\": null,\n \"giftCardCaption\": null,\n \"redemptionCode\": null,\n \"group\": \"bankInvoice\",\n \"tid\": null,\n \"dueDate\": \"2019-02-02\",\n \"connectorResponses\": {}\n }\n ]\n }\n ]\n },\n \"packageAttachment\": {\n \"packages\": []\n },\n \"sellers\": [\n {\n \"id\": \"1\",\n \"name\": \"Lux Store\",\n \"logo\": \"\"\n }\n ],\n \"callCenterOperatorData\": null,\n \"followUpEmail\": \"7bf3a59bbc56402c810bda9521ba449e@ct.vtex.com.br\",\n \"lastMessage\": null,\n \"hostname\": \"luxstore\",\n \"invoiceData\": null,\n \"changesAttachment\": {\n \"id\": \"changeAttachment\",\n \"changesData\": [\n {\n \"reason\": \"Blah\",\n \"discountValue\": 3290,\n \"incrementValue\": 0,\n \"itemsAdded\": [],\n \"itemsRemoved\": [\n {\n \"id\": \"1234568358\",\n \"name\": \"Bay Max L\",\n \"quantity\": 1,\n \"price\": 3290,\n \"unitMultiplier\": null\n }\n ],\n \"receipt\": {\n \"date\": \"2019-02-06T20:46:04.4003606+00:00\",\n \"orderId\": \"v502556llux-01\",\n \"receipt\": \"029f9ab8-751a-4b1e-bf81-7dd25d14b49b\"\n }\n }\n ]\n },\n \"openTextField\": null,\n \"roundingError\": 0,\n \"orderFormId\": \"caae7471333e403f959fa5fd66951340\",\n \"commercialConditionData\": null,\n \"isCompleted\": true,\n \"customData\": null,\n \"storePreferencesData\": {\n \"countryCode\": \"BRA\",\n \"currencyCode\": \"BRL\",\n \"currencyFormatInfo\": {\n \"CurrencyDecimalDigits\": 2,\n \"CurrencyDecimalSeparator\": \",\",\n \"CurrencyGroupSeparator\": \".\",\n \"CurrencyGroupSize\": 3,\n \"StartsWithCurrencySymbol\": true\n },\n \"currencyLocale\": 1046,\n \"currencySymbol\": \"R$\",\n \"timeZone\": \"E. South America Standard Time\"\n },\n \"allowCancellation\": true,\n \"allowEdition\": false,\n \"isCheckedIn\": false,\n \"marketplace\": {\n \"baseURL\": \"http://oms.vtexinternal.com.br/api/oms?an=luxstore\",\n \"isCertified\": null,\n \"name\": \"luxstore\"\n },\n \"authorizedDate\": \"2019-01-28T20:33:04.0000000+00:00\",\n \"invoicedDate\": null\n}"}],"_postman_id":"fec694dd-76e4-4d8c-91f2-9bdb05d25f70"}],"id":"9b156d96-8b93-4ce4-a5a6-ed943803e81a","_postman_id":"9b156d96-8b93-4ce4-a5a6-ed943803e81a","description":""}]}