Create an order/cart

Create an order or an abandoned cart.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Error cases

Malformatted value - ex: price as String (400)

Generic error for all fields and custom fields values types

{
    "status": 400,
    "errors": [
        {
            "error_key": "products[0].unit_price",
            "error": "wrong_type",
            "error_description": "This value should be of type numeric."
        }
    ]
}
{
    "status": 400,
    "errors": [
        {
            "error_key": "ordered_at",
            "error": "wrong_value",
            "error_description": "wrong_value"
        }
    ]
}

Order external_id already exist (400)

{
    "status": 400,
    "errors": [
        {
            "error_key": "external_id",
            "error": "wrong_value",
            "error_description": "Order with external_id test already exists."
        }
    ]
}

Contact does not exist (400)

{
    "status": 400,
    "errors": [
        {
            "error_key": "individual_id",
            "error": "wrong_value",
            "error_description": "Individual not found for identifier {eeeeeee}"
        }
    ]
}

Product does not exist (400)

{
    "status": 400,
    "errors": [
        {
            "error_key": "product_id",
            "error": "wrong_value",
            "error_description": "Product not found for external id testzerzerzer"
        }
    ]
}

Store does not exist (400)

{
    "status": 400,
    "errors": [
        {
            "error_key": "store_external_id",
            "error": "wrong_value",
            "error_description": "Store not found for external id test"
        }
    ]
}

Custom field does not exist (400)

{
    "status": 400,
    "errors": [
        {
            "error_key": "custom_fields",
            "error": "wrong_value",
            "error_description": "Custom field not found for id 99."
        }
    ]
}
Body Params

Order data.

string
required
string
required
string
string
required
string

When the order was purchased (local timezone).

number
number
number
number
boolean
Defaults to true

Order is purchased or not

string
string
products
array of objects
products
custom_fields
array of objects
custom_fields
Responses

401

Authentication failed.

403

Forbidden.

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json