Order Status By External Order Id

GET 
/v2/external-order-id/:id

Shows information about an existing order and its products by provided external order id. This endpoint allows API users to get current information on the fulfillment status of their orders.

Request

Path Parameters

id stringrequired
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.
Example: 51cf91c1-da4a-42c4-81d3-3ec3e3268655

Responses

200

Success

application/json

Schema

Schema

data object

id stringrequired

Public ID of the order.

orderNumber floatrequired

Customer order number.

externalId 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.

fulfillmentStatus stringrequired

Possible values: [pending, fulfilled, Partially Fulfilled, cancelled, sent to merchant, failed (merchant), failed (unknown), failed (payment), cancelled (payment), failed (payment validation), payment successful, failed (inventory), failed (inventory - related)]

Fulfillment status of the order

products object[]

Array [

id stringrequired

Product ID.

variantId stringrequired

The ID of the product variant.

quantity floatrequired

Possible values: >= 1

Quantity of the product variant.

merchantOrderId stringnullablerequired

The merchant order ID. External to Bonsai. Empty if the order has not yet been placed on external merchant system.

fulfillmentStatus stringrequired

Possible values: [pending, fulfilled, Partially Fulfilled, cancelled, sent to merchant, failed (merchant), failed (unknown), failed (payment), cancelled (payment), failed (payment validation), payment successful, failed (inventory), failed (inventory - related)]

Fulfillment status of the individual product variant in the order.

paymentStatus stringrequired

Possible values: [unpaid, paid, refunded, partially refunded]

Payment status for the related order.

]

shippingTracking object[]

Array [

carrier stringrequired

The name of the shipping carrier.

trackingNumber stringrequired

The tracking number for the shipment.

trackingUrl stringrequired

The URL to track the shipment.

products object[]

Array [

id stringrequired

Product ID.

variantId stringrequired

The ID of the product variant.

quantity floatrequired

Possible values: >= 1

Quantity of the product variant.

]

]

customer objectrequired

email emailrequired

Customer email

firstName string

Customer's first name

lastName string

Customer's last name

note string

Note containing extra information for our team

Example (from schema)

{
  "data": {
    "id": "cldbvy7gt0006hpzo9nyw72ks",
    "orderNumber": 238636,
    "externalId": "51cf91c1-da4a-42c4-81d3-3ec3e3268655",
    "fulfillmentStatus": "fulfilled",
    "products": [
      {
        "id": "clad6pg5z00eu012gfz7hfm92",
        "variantId": "M00679529706740",
        "quantity": 1,
        "merchantOrderId": "T8745295",
        "fulfillmentStatus": "fulfilled",
        "paymentStatus": "paid"
      }
    ],
    "shippingTracking": [
      {
        "carrier": "USPS",
        "trackingNumber": "9400100000000000069420",
        "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=9400100000000000069420",
        "products": [
          {
            "id": "clad6pg5z00eu012gfz7hfm92",
            "variantId": "M00679529706740",
            "quantity": 1
          }
        ]
      }
    ],
    "customer": {
      "email": "qa@shopbonsai.ca",
      "firstName": "string",
      "lastName": "string"
    },
    "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 [
status floatrequired
detail stringnullablerequired
title stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "status": 400,
      "detail": "",
      "title": "Bad input request"
    }
  ]
}

401

401 - Unauthorized

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
authentication_expected string
]

Example (from schema)

{
  "errors": [
    {
      "id": "123e4567-e89b-12d3-a456-426655440000",
      "status": 401,
      "code": "AUTHENTICATION_FAILED",
      "title": "Authentication failed",
      "detail": {
        "authentication_expected": "Authorization header"
      }
    }
  ]
}

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
customer_order_id string
]

Example (from schema)

{
  "errors": [
    {
      "id": "123e4567-e89b-12d3-a456-426655440000",
      "status": 404,
      "code": "CUSTOMER_ORDER_NOT_FOUND",
      "title": "Customer order has not been found",
      "detail": {
        "customer_order_id": "cldbvy7gt0006hpzo9nyw72ks"
      }
    }
  ]
}

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...