Skip to main content

Orders API

  1. Ovreview

    1.1 Retrieve Orders by Date

    1.2 Obtaining Order by code

    1.3 Retrieve an Order by ID

  2. Register an Order

1. Overview​

The Zakeke Orders API is a comprehensive collection of endpoints designed to facilitate the seamless management of orders within the Zakeke ecosystem. This robust set of APIs encompasses retrieval functions for accessing order information as well as registration capabilities for the integration and synchronization of orders within your platform.

Tips:

Here you will find the description of the keys present in the response JSON regarding the API Orders

1.1 Retrieve Orders by Date​

Retrieve a paginated list of customized orders starting from the most recent ones

GET /v2/orders

The Items key contains order details, providing information on quantity, print files, and order date

Response​

[
  {
    "id": 0,
    "code": "string",
    "orderNumber": "string",
    "salesChannel": {
      "id": 0,
      "url": "string",
      "platform": "string"
    },
    "items": [
      {
        "code": "string",
        "productSku": "string",
        "productName": "string",
        "productTemplateId": "string",
        "thumbnail": "string",
        "quantity": 0,
        "design": "string",
        "preDesignedTemplateName": "string",
        "printFilesStatus": "string",
        "printingFilesZip": "string",
        "printingFiles": [
          {
            "type": "string",
            "url": "string"
          }
        ],
        "price": {
          "value": 0,
          "currency": "string"
        }
      }
    ],
    "orderDate": "string"
  }
]

1.2 Obtaining Order by code​

Get all the details of the specified order using the code.

GET /v2/order/{orderCode}

Response​

{
  "id": 0,
  "code": "string",
  "orderNumber": "string",
  "salesChannel": {
    "id": 0,
    "url": "string",
    "platform": "string"
  },
  "items": [
    {
      "code": "string",
      "productSku": "string",
      "productName": "string",
      "productTemplateId": "string",
      "thumbnail": "string",
      "quantity": 0,
      "design": "string",
      "preDesignedTemplateName": "string",
      "printFilesStatus": "string",
      "printingFilesZip": "string",
      "printingFiles": [
        {
          "type": "string",
          "url": "string"
        }
      ],
      "price": {
        "value": 0,
        "currency": "string"
      }
    }
  ],
  "orderDate": "string"
}

1.3 Retrieve an Order by ID​

As a response you will get a Json with all the details of the order with requested ID. You will get all the items entered in the design, the date of the order and the price

GET /v2/orders/{order}

Response​

{
  "id": 0,
  "code": "string",
  "orderNumber": "string",
  "salesChannel": {
    "id": 0,
    "url": "string",
    "platform": "string"
  },
  "items": [
    {
      "code": "string",
      "productSku": "string",
      "productName": "string",
      "productTemplateId": "string",
      "thumbnail": "string",
      "quantity": 0,
      "design": "string",
      "preDesignedTemplateName": "string",
      "printFilesStatus": "string",
      "printingFilesZip": "string",
      "printingFiles": [
        {
          "type": "string",
          "url": "string"
        }
      ],
      "price": {
        "value": 0,
        "currency": "string"
      }
    }
  ],
  "orderDate": "string"
}

2. Register an Order​

POST /v2/order

The key compositionDetails is the composition of the item associated with these order details.

Response​

{
  "orderCode": "string",
  "orderDate": "2023-11-03T09:13:38.437Z",
  "sessionID": "string",
  "total": 0,
  "details": [
    {
      "orderDetailCode": "string",
      "sku": "string",
      "designID": "string",
      "modelUnitPrice": 0,
      "designUnitPrice": 0,
      "quantity": 0,
      "designModificationID": "string"
    }
  ],
  "compositionDetails": [
    {
      "orderDetailCode": "string",
      "composition": "string",
      "unitPrice": 0,
      "originalUnitPrice": 0,
      "quantity": 0
    }
  ]
}