Skip to main content

Order Registration (3D Product Configurator)

Summary

  1. Overview

  2. Order Properties

    2.1 orderCode

    2.2 orderDate

    2.3 total

    2.4 compositionDetails

  3. Order endpoint

    3.1 Get Order by Code

1. Overview

The Configurator Order Registration API is a crucial tool for merchants utilizing Zakeke's configurator for personalized product offerings. This API facilitates the seamless generation of two key outputs:

Composition:

The "composition" comprises a comprehensive list of options selected by customers during the configuration process.

Print-ready files are generated when configured products involve design elements such as text or images.

These outputs are accessible in the Orders section of the back-office, providing merchants with essential insights for efficient order fulfillment.

For secure and efficient communication, the API requires S2S (Server2Server) authentication.

2. Order Properties

2.1 orderCode

"orderCode": "3521"

The order identifier on your system.

2.2 orderDate

"orderDate": "2018-10-24T10:29:48.132Z"

The date and time (ISO 8601 format) when the order was created in your system.

2.3 total

"total": 409.94

The sum of all line item prices, discounts, shipping, taxes, and tips (must be positive).

2.4 compositionDetails

"compositionDetails": [
{
"orderDetailCode": "453",
"composition": "315-e4848045-91c2-44b2",
"unitPrice": 149.99,
"quantity": 2
}
]

A list of composition detail objects, each containing information about an product configuration in the order. Each object has the following properties:

  • orderDetailCode: The ID on your system for the line item.
  • composition: The product configuration identifier for the product that the line item belongs to.
  • unitPrice: The unit price of the product, including the configuration price, after discounts have been applied. Must be in the base currency set in the Zakeke API settings.
  • quantity: The number of products that were purchased.

3. Order endpoint

POST https://api.zakeke.com/v1/order

Register an order in Zakeke. For more details click here

3.1 Get Order by Code

GET https://api.zakeke.com/v1/order/{orderCode}

The API allows the order with customized products to be displayed in the Zakeke system. If the request is successful, the order is displayed. For more details click here