Sign in

v1

latestOpenAPI 3.0.02026-07-141525155.4 KB
External Marketplace

Update Order Status

API request used to update an order status in VTEX.

This process is asynchronous and a notification with the order's integration results will be sent to the endpoint specified in the connectiorEndpoint field or the connectiorEndpoint App Template, if the connector uses our App template. The field connectorName is also optional for connectors that use our App Template and authenticate using the app's auth cookie.

For a detailed explanation of the steps required to develop a custom connector to become an external marketplace for VTEX sellers, check out our complete External Marketplace Integration Guide.

put/{accountName}.vtexcommercestable.com.br/api/order-integration/orders/status

Path parameters

accountNamestring required

Parameter should indicate the name of the VTEX account where the order is being integrated or updated, meaning the seller responsible for the order.

Query parameters

anstring
Example:apiexamples

Parameter should indicate the name of the VTEX account where the order is being integrated or updated, meaning the seller responsible for the order.

Headers

Content-Typestring required

Describes the type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

connectorEndpointstring required

String with the connector's base endpoint that will receive notifications about the orders processing results, as well as status updates from VTEX OMS. This field does not accept query strings. You can use the models below:

  • https://{{externalconnector}}.com

  • https://{{externalconnector.com}}/api/vtex if you additionaly want to send a relative URL with the endpoint.

This field is optional if the connector uses the App Template and authenticates on our request via VtexIdclientAutCookie.

It is required if the connector is native or does not use the App Template.

connectorNamestring required

String with the identifier code of the connector responsible for the order.

This field is optional if the connector uses the App Template and authenticates on our request via VtexIdclientAutCookie.

It is required if the connector is native or does not use the App Template.

marketplaceOrderIdstring required

String that indicates the order's ID in the marketplace.

marketplaceOrderStatusstring required

Required field including a string with the order’s status in the marketplace. If you send an order with the status APPROVED to integrate, our service will automatically try to advance its status in VTEX after integrating it. This field accepts the following values:

  • new

  • approved.

Example request

{
  "connectorEndpoint": "https://connector-endpoint.com/api/vtex",
  "connectorName": "Skyhub",
  "marketplaceOrderId": "{{$guid}}",
  "marketplaceOrderStatus": "APPROVED"
}

Response

OK

accountNamestring nullable required

String that indicates which account made the request.

codestring required

String with a internal Channel Order API code that classifies the response. The possible values returned in this field are described in the Response Codes section of this API Reference.

flowstring required

String containing the name of the flow responsible for the response. This field can contain the following values:

PlaceOrder: when integrating new orders.

ApproveOrder: when approving existing orders.

Unknown: when we’re not able to identify the flow.

marketplaceOrderIdstring nullable required

String that indicates the order's ID in the marketplace.

messagestring required

String with a message explaining the code returned in the response.

operationIdstring nullable required

String GUID that identifies the operation in our service. This field can be used to help us analyze unexpected errors or behaviors.

successboolean required

Boolean that indicates if the response is successful or not.

Example response

{
  "accountName": null,
  "code": "SOI003",
  "errors": null,
  "fields": null,
  "flow": "ApproveOrder",
  "marketplaceOrderId": "7e62fcd3-827b-400d-be8a-f050a79c4976",
  "message": "Order successfully enqueued",
  "operationId": null,
  "success": true
}