Skip to main content

Compositions API

  1. Overview

    1.1 Get a Composition by ID

    1.2 Get all Minimal Necessary Data to Add a Composition to a Shopping Cart

  2. Seller Compositions

    2.1 Returns All Identifiers of Customers with Compositions

    2.2 Returns All Compositions for Seller

1. Overview​

In the context of the Zakeke API, a "composition" refers to a comprehensive list of attributes and options resulting from a configuration through the 3D configurator. Essentially, it represents the permutation derived from the customer's order.

For detailed insights into these terms, refer to the documentation here.

The Compositions API is a comprehensive collection of endpoints designed to access composition information.

Tips:

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

1.1 Get a Composition by ID​

A composition is an entity that indicates what the customer has selected.

GET /v2/compositions/{compositionID}/{quantity}

The Items key provides information on the selected item.

Response​

{
  "compositionID": "string",
  "name": "string",
  "tempPreviewImageUrl": "string",
  "price": 0,
  "designID": "string",
  "items": [
    {
      "itemGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "attributeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "attributeType": "string",
      "attributeCode": "string",
      "attributeName": "string",
      "selectedOptionGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "selectedOptionCode": "string",
      "selectedOptionName": "string",
      "selectedValue": "string"
    }
  ],
  "previewFiles": [
    {
      "url": "string",
      "cameraName": "string"
    }
  ]
}

1.2 Get all Minimal Necessary Data to Add a Composition to a Shopping Cart​

Get all Minimal Necessary Data to Add a Composition to a Shopping Cart You will get as a response all the details related to the composition created

GET /v2/compositions/{id}/cartinfo

Response​

{
  "preview": "string",
  "price": 0,
  "designID": "string",
  "items": [
    {
      "itemGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "attributeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "attributeType": "string",
      "attributeCode": "string",
      "attributeName": "string",
      "selectedOptionGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "selectedOptionCode": "string",
      "selectedOptionName": "string",
      "selectedValue": "string"
    }
  ]
}

2. Seller Compositions​

2.1 Returns All Identifiers of Customers with Compositions​

As a response you will get a string that identifies the store ID

GET /v2/compositions/seller/customers

2.2 Returns All Compositions for Seller​

GET /v2/compositions/seller

Response​

{
  "continuationToken": "string",
  "compositions": [
    {
      "compositionID": "string",
      "name": "string",
      "tempPreviewImageUrl": "string",
      "modelCode": "string",
      "modelID": 0,
      "pdSettings": 0
    }
  ]
}