New Order Integration

API to integrate an external channel's order into the VTEX plataform.

This process is asynchronous and a notification with the order's integration results will be sent to the endpoint specified in the connectorEndpoint field in 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. If the account is not informed in the URL host, it should also be defined as a query string parameter in the route: an={account}.

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.

Response body model

        "accountName": string,
    "success": bool,
    "flow": string,
    "operationId": string,
    "marketplaceOrderId": string,
        "code": string,
        "message": string,
            "source": string,
            "code": string,
            "description": string
    "fields": {
           "mainOrderId": string,
                     "franchiseOrderId": string

Response codes

SOI001The order was integrated into VTEX successfully
SOI002The order was approved in VTEX successfully
SOI003The order was successfully enqueued in our service for processing
EOI000An unknown error occurred when processing the order, and in this case, the solution would be contacting VTEX for support
EOI001An unmapped error occurred when processing the order, and more details about the error can be found in the response error list
EOI002There are no SLAs or items available to fulfill this order. That is: the item(s) can be without stock, inactive in the catalog or not included in connector’s trade policy; the SLA/pickup point chosen in the order is not available or doesn’t have stock for the order’s items; or there aren’t any SLAs available at all to fulfill the order
EOI003The order total payment value differs from what is expected by the seller, and they do not have Order Authorization rules set up to deal with price divergence
EOI004This order's cart is invalid. That can mean that either the item(s) in it don’t exist in VTEX catalog or the order's data doesn’t comply with the store configuration (for example, the minimum total value or quantity of items set by the seller was not reached in the order)
EOI005A validation error occurred while trying to process the order. That is, some field/value sent in the order’s contract is invalid and not filled according to our’s or Checkout/Fulfillment’s documentation
EOI006An unexpected error occurred in one of VTEX's internal services. Please try to send the request again later, as it’s possible one of our services is going through instabilities
EOI007The order specified already exists in VTEX and we are not able to create duplicated orders
EOI008The order cannot be approved because it’s not integrated in VTEX yet
EOI009This order is out of the valid status to approve, such as canceled, for example
EOI010The request to our API timed out, meaning we exceeded the response time limit
Click Try It! to start a request and see the response here!