Endpoints

A full reference of all available BrickHatch API endpoints for catalog lookups, inventory, orders, and more.

Overview

Explore all available API endpoints for accessing BrickHatch data. These endpoints are designed for use in your applications and integrations.

Before using any endpoint, make sure you understand how requests and responses work:

Orders

Get orders

Retrieve a list of orders that your store has received.

Request

Method	Path
GET	/store/orders

Parameters

Parameter Name	Type	Required	Description
`searchQuery`	string	No	Search orders by keywords such as order ID, buyer details, or other relevant text
`status`	string[]	No	Filter orders by one or more statuses
`startDate`	string (date)	No	Return orders created on or after this date
`endDate`	string (date)	No	Return orders created on or before this date
`minimumAmount`	number	No	Filter orders with a total greater than or equal to this value
`maximumAmount`	number	No	Filter orders with a total less than or equal to this value
`sortBy`	string	No	Field to sort results by
`sortOrder`	string	No	Sort direction, typically ascending or descending
`offset`	number	No	Pagination offset for retrieving additional results

Response

JSON

{
  "data": {
    "count": 1,
    "limit": 60,
    "orders": [
      {
        "orderId": "123456789",
        "userId": 1,
        "storeId": 1,
        "status": "pending-payment" | "processing" | "shipped" | "delivered" | "cancelled",
        "paymentIntentId": "pi_123456789",
        "total": 10000,
        "currency": "USD",
        "confirmedAt": "YYYY-MM-DD HH:MM:SS" | null,
        "processingAt": "YYYY-MM-DD HH:MM:SS" | null,
        "shippedAt": "YYYY-MM-DD HH:MM:SS" | null,
        "completedAt": "YYYY-MM-DD HH:MM:SS" | null,
        "cancelledAt": "YYYY-MM-DD HH:MM:SS" | null,
        "createdAt": "YYYY-MM-DD HH:MM:SS",
        "details": {
          "itemCount": 2,
          "feePercent": 25,
          "paymentMethod": "**** 4242",
          "couponCode": "SUMMER21" | null,
          "refundId": "re_123456789" | null,
          "cancelledBy": userId | null,
          "cancellationReason": "reason text" | null,
          "trackingNumber": "tracking number" | null,
          "shippingMethodName": "shipping method name" | null,
          "pricing": {
            "subtotal": 8000,
            "discount": 2000,
            "shipping": 4000,
          },
          "address": {
            "firstName": "John",
            "lastName": "Doe",
            "line1": "123 Main St",
            "line2": "Apt 4B",
            "city": "New York",
            "state": "NY",
            "postalCode": "10001",
            "country": "US"
          }
        }
      }
    ]
  }
}

Response

JSON

{}

Update orders

Update the details of multiple orders in a single request.

Request

Method	Path
PUT	/store/orders

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Get order

Retrieve a single order by its unique identifier.

Request

Method	Path
GET	/store/orders/:orderId

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Update order

Update details of an existing order.

Request

Method	Path
PUT	/store/orders/:orderId

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Inventory

Get your inventory

Retrieve all items currently in your inventory.

Request

Method	Path
GET	/inventory

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Create an item in the inventory

Create a new item in your inventory.

Request

Method	Path
POST	/inventory

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Bulk create an item in inventory

Create multiple inventory items in a single request.

Request

Method	Path
POST	/inventory/bulk

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Update an item in the inventory

Update a specific item in your inventory.

Request

Method	Path
PUT	/inventory/:itemId

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Bulk update an item in the inventory

Update multiple inventory items at once.

Request

Method	Path
PUT	/inventory/bulk

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Delete an item

Remove a single item from your inventory.

Request

Method	Path
DELETE	/inventory/:itemId

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Bulk delete an item

Remove multiple items from your inventory in a single request.

Request

Method	Path
DELETE	/inventory/bulk

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Coupons

Get coupons

Retrieve all coupons associated with your store.

Request

Method	Path
GET	/coupons

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Get coupon

Retrieve a single coupon by its identifier.

Request

Method	Path
GET	/coupons/:couponId

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Create coupon

Create a new coupon for your store.

Request

Method	Path
POST	/coupons

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Delete coupon

Delete a coupon by its identifier.

Request

Method	Path
DELETE	/coupons/:couponId

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Bulk create coupon

Create multiple coupons in a single request.

Request

Method	Path
POST	/coupons/bulk

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Bulk update coupon

Update multiple coupons at once.

Request

Method	Path
PUT	/coupons/bulk

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Bulk delete coupon

Delete multiple coupons in a single request.

Request

Method	Path
DELETE	/coupons/bulk

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Shipping Methods

Get shipping methods

Retrieve all shipping methods configured for your store.

Request

Method	Path
GET	/shipping-methods

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Get shipping method

Retrieve a specific shipping method by its identifier.

Request

Method	Path
GET	/shipping-methods/:shippingMethodId

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Create shipping method

Create a new shipping method for your store.

Request

Method	Path
POST	/shipping-methods

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Update shipping method

Update an existing shipping method.

Request

Method	Path
PUT	/shipping-methods/:shippingMethodId

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Delete shipping method

Delete a shipping method from your store.

Request

Method	Path
DELETE	/shipping-methods/:shippingMethodId

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Bulk create shipping

Create multiple shipping methods in one request.

Request

Method	Path
POST	/shipping-methods/bulk

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Bulk update shipping

Update multiple shipping methods at once.

Request

Method	Path
PUT	/shipping-methods/bulk

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Bulk delete shipping

Delete multiple shipping methods in a single request.

Request

Method	Path
DELETE	/shipping-methods/bulk

Parameters

Parameter Name	Type	Required	Description

Response

JSON

{}

Your Cart

Endpoints

Overview

Orders

Get orders

Update orders

Get order

Update order

Inventory

Get your inventory

Create an item in the inventory

Bulk create an item in inventory

Update an item in the inventory

Bulk update an item in the inventory

Delete an item

Bulk delete an item

Coupons

Get coupons

Get coupon

Create coupon

Delete coupon

Bulk create coupon

Bulk update coupon

Bulk delete coupon

Shipping Methods

Get shipping methods

Get shipping method

Create shipping method

Update shipping method

Delete shipping method

Bulk create shipping

Bulk update shipping

Bulk delete shipping

Still need help?

Start selling on BrickHatch