Getting Started

Submitting an order

Welcome to our API! This guide will walk you through the steps to retrieve categories, subcategories, and product options, and then show you how to build a payload for further operations.

Prerequisites

Before you begin, ensure you have:

• An API key (provided after registration).
• A REST client or a tool like curl for making API requests.
• Basic knowledge of JSON.
• Configured the Payment Method of your account.
• Set the default billing address of your store

Step 1: Retrieve Available Categories

Endpoint: Retrieve all categories available.

Description: This endpoint retrieves a list of all available product categories currently being offered.

Step 2: Retrieve Subcategories Under a Category

Endpoint: Retrieve all subcategories under a category.

Description: This endpoint retrieves all subcategories for a given category ID. the subcategoryId must be provided for each orderItem.

Step 3: Retrieve Available Product Options of a Subcategory

Endpoint: Retrieve all options available for the subcategory.

Description: Retrieve all product options available within a specific subcategory. The result will provide a list of option groups with its available corresponding option items. Only one option item per option group is allowed to be included in the order submission payload. The order item options should be entered inside orderItemOptions array of each orderItem as an integer.

:::note
If no orderItemOption is provided, the default product options for that subcategory will be used.
:::

Step 4: Build Payload Based on Previous Steps

Description: Using the information retrieved from the above steps, you can build a payload for submitting an order.

Example Payload:

{
    "externalId": "186898732",
    "storeId": "818",
    "shippingMethod": "default",
    "productionTime": "regular",
    "recipient": {
        "firstName": "John",
        "lastName": "Smith",
        "addressLine1": "123 Main St.",
        "addressLine2": "Apt. 123",
        "city": "New York",
        "state": "NY",
        "zipCode": "10001",
        "country": "US",
        "phone": "123-456-7890",
        "company": "ABC Company"
    },
    "orderItems": [
        {
            "externalItemId": "123456789",
            "subcategoryId": 103001,
            "quantity": 1,
            "width": 8,
            "height": 10,
            "file": {
                "imageUrl": "https://www.example.com/image.jpg"
            },
            "orderItemOptions": [
                11,
                51,
                23
            ],
            "solidColorHexCode": null
        }
    ]
}