Submit Pending Orders

POST 
/v2/submit

Submits an order to Bonsai without payment. These orders will not be processed until payment is submitted.

Request

application/json

Body

required

customer objectrequired

email emailrequired

Customer email

firstName string

Customer's first name

lastName string

Customer's last name

products object[]required
Possible values: >= 1
Array [
id stringrequired
Product ID.
variantId stringrequired
The ID of the product variant.
quantity floatrequired
Possible values: >= 1
Quantity of the product variant.
]
shippingAddress objectrequired

firstName stringrequired

Customer first name.

lastName stringrequired

Customer last name.

address1 stringrequired

The street address of the shipping address.

address2 stringnullable

An optional additional field for the street address of the shipping address.

city stringrequired

The city, town, or village of the shipping address.

country stringrequired

The two-letter code (ISO 3166-1 format) for the country of the shipping address.

province stringnullable

The two-letter abbreviation of the region of the shipping address.

phone string

The phone number at the shipping address.

zip stringrequired

The postal code (zip, postcode, Eircode, …) of the shipping address.

payment objectrequired

method stringrequired

Possible values: [credit card, external payment, stripe]

Payment method that will be used to pay for the order.

externalOrderId string

ID of the order provided to Bonsai by the party who placed the order. This can be anything you like, but should be unique per order.

misc object
Miscellaneous data for the order. For example, analytics data.
data objectrequired
note string

Note containing extra information for our team

cartId string

Unique identifier for the cart

Responses

200

Success

application/json

Schema

Schema

data object

email emailrequired

Email of the customer

shippingAddress objectrequired

firstName stringrequired

Customer first name.

lastName stringrequired

Customer last name.

address1 stringrequired

The street address of the shipping address.

address2 stringnullable

An optional additional field for the street address of the shipping address.

city stringrequired

The city, town, or village of the shipping address.

country stringrequired

The two-letter code (ISO 3166-1 format) for the country of the shipping address.

province stringnullable

The two-letter abbreviation of the region of the shipping address.

phone string

The phone number at the shipping address.

zip stringrequired

The postal code (zip, postcode, Eircode, …) of the shipping address.

shippingLines object[]required

Array [

title stringrequired

The title of the shipping method.

code stringrequired

A reference to the shipping method.

price floatrequired

The price of this shipping method in the shop currency. Can not be negative.

source stringrequired

The source of the shipping method.

tax floatnullable

Taxes for a specific shipping line.

]

products object[]required

Array [

id stringrequired

Product ID.

variantId stringrequired

The ID of the product variant.

quantity floatrequired

Possible values: >= 1

Quantity of the product variant.

name stringrequired

The title of the product.

price floatrequired

The price of the product.

]

breakdown objectrequired

goods floatrequired

The amount of goods refunded

goodsTax floatrequired

The amount of goods tax refunded

shipping floatrequired

The amount of shipping refunded

shippingTax floatrequired

The amount of shipping tax refunded

duties floatrequired

The amount of duties refunded

currency stringrequired

Possible values: [CAD, USD, GBP, AUD, EUR]

Currency of the refund

id stringrequired

Public ID of the order.

orderNumber floatrequired

Order number in the system

note string

Note containing extra information for our team

Example (from schema)

{
  "data": {
    "email": "qa@shopbonsai.ca",
    "shippingAddress": {
      "firstName": "Eddy",
      "lastName": "Bonsai",
      "address1": "351 E 103rd St",
      "address2": "Whitecastle",
      "city": "New York",
      "country": "US",
      "province": "NY",
      "phone": "555-625-1199",
      "zip": "10029"
    },
    "shippingLines": [
      {
        "title": "Small Packet International Air",
        "code": "INT.TP",
        "price": 20,
        "source": "canada_post",
        "tax": 12.45
      }
    ],
    "products": [
      {
        "id": "clad6pg5z00eu012gfz7hfm92",
        "variantId": "M00679529706740",
        "quantity": 1,
        "name": "Nike Air Jordan",
        "price": 10
      }
    ],
    "breakdown": {
      "goods": 5,
      "goodsTax": 1,
      "shipping": 1,
      "shippingTax": 1,
      "duties": 0,
      "currency": "USD"
    },
    "id": "cldbvy7gt0006hpzo9nyw72ks",
    "orderNumber": 54663,
    "note": "Fulfil only if white colour was selected. Or reach out to our support"
  }
}

400

400 - Bad request

application/json

Schema

Schema

errors object[]
Array [
id stringrequired
Unique identifier for error. Can be used for tracing across services.
status floatrequired
HTTP status code.
code stringrequired
Unique code for specific error.
title stringrequired
Short description what the error entails.
detail objectrequired
Useful details related to the error
publicId string
variantId string
]

Example (from schema)

{
  "errors": [
    {
      "id": "123e4567-e89b-12d3-a456-426655440000",
      "status": 400,
      "code": "OUT_OF_STOCK",
      "title": "The product is out of stock",
      "detail": {
        "publicId": "clad6pg5z00ru012gfz7hfm92",
        "variantId": "M00679529706740"
      }
    }
  ]
}

401

401 - Unauthorized

application/json

Schema

Schema

errors object[]
Array [
status floatrequired
detail stringnullablerequired
title stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "status": 401,
      "detail": "",
      "title": "Authentication information is missing or invalid"
    }
  ]
}

404

404 - Not found

application/json

Schema

Schema

errors object[]
Array [
id stringrequired
Unique identifier for error. Can be used for tracing across services.
status floatrequired
HTTP status code.
code stringrequired
Unique code for specific error.
title stringrequired
Short description what the error entails.
detail objectrequired
Useful details related to the error
publicId string
variantId string
]

Example (from schema)

{
  "errors": [
    {
      "id": "123e4567-e89b-12d3-a456-426655440000",
      "status": 404,
      "code": "VARIANT_DOES_NOT_EXIST",
      "title": "Variant does not exist",
      "detail": {
        "publicId": "clad6pg5z00ru012gfz7hfm92",
        "variantId": "M00679529706740"
      }
    }
  ]
}

500

500 - Internal server error

application/json

Schema

Schema

errors object[]
Array [
id stringrequired
Unique identifier for error. Can be used for tracing across services.
status floatrequired
HTTP status code.
code stringrequired
Unique code for specific error.
title stringrequired
Short description what the error entails.
detail objectrequired
Useful details related to the error
stripeToken string
customer object
email string
first_name string
last_name string
message string
]

Example (from schema)

{
  "errors": [
    {
      "id": "123e4567-e89b-12d3-a456-426655440000",
      "status": 500,
      "code": "STRIPE_ERROR",
      "title": "Error during a Stripe operation",
      "detail": {
        "stripeToken": "tok_1EJ2Zp2eZvKYlo2Cg2g2g2g2",
        "customer": {
          "email": "qa@shopbonsai.ca",
          "first_name": "Eddy",
          "last_name": "Bonsai"
        },
        "message": "Your card was declined."
      }
    }
  ]
}

5XX

500 - Unknown error

application/json

Schema

Schema

errors object[]
Array [
status floatrequired
detail stringnullablerequired
title stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "detail": "",
      "title": "Unknown error"
    }
  ]
}

Loading...