Product

Create new product

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

brand_idstringRequired

product_idstringRequired

shopify_product_idstringOptional

slugstring · enumRequiredPossible values:

Responses

200Success

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Request successful

datamultipleOptionalExample: Brand | Product | Notification | ...

post

/product/create

HTTPcURLJavaScriptPython

POST /product/create HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2583

{
  "brand_id": "text",
  "product_id": "text",
  "shopify_product_id": "text",
  "details": {
    "product_background_image": "text",
    "product_image": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "product_image_video": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "product_image_placeholder_properties": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "splashscreen_video": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "promotional_video": {
      "asset": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "thumbnail": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      }
    },
    "product_name": "text",
    "product_general_name": "text",
    "product_information": "text",
    "product_origin": [
      {
        "iconUrl": "text",
        "title": "text",
        "date": "text",
        "description": "text",
        "location": "text",
        "external_uri": "text",
        "coordinates": {
          "longitude": 1,
          "latitude": 1
        },
        "asset": {
          "uri": {},
          "path": {},
          "fileName": {},
          "mime": {}
        },
        "color": "text"
      }
    ],
    "product_creation_country": "text",
    "product_contact": "text",
    "product_producer_name": "text",
    "product_description": "text",
    "product_description_asset": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "product_sub_logo": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "price": {
      "amount": 1,
      "currency": "text"
    },
    "sku_id": "text",
    "gtin": "text",
    "player": {
      "title": "text",
      "icon": "text",
      "description": "text",
      "content": [
        {
          "uri": {},
          "path": {},
          "fileName": {},
          "mime": {}
        }
      ]
    },
    "team": {
      "title": "text",
      "icon": "text",
      "description": "text",
      "content": [
        {
          "uri": {},
          "path": {},
          "fileName": {},
          "mime": {}
        }
      ]
    },
    "tabs": [
      {
        "title": "text",
        "icon": "text",
        "description": "text",
        "type": "list-media",
        "content": [
          {
            "uri": {},
            "path": {},
            "fileName": {},
            "mime": {}
          }
        ]
      }
    ],
    "shop_url": "text"
  },
  "warranty": {
    "product_warranty": true,
    "product_warranty_duration": 1,
    "product_warranty_extend": true,
    "product_warranty_extend_price": {
      "amount": 1,
      "currency": "text"
    },
    "product_warranty_extend_terms": "text",
    "product_warranty_extend_duration": 1,
    "product_warranty_extend_limit": 1
  },
  "care": {
    "product_image": "text",
    "product_document": "text"
  },
  "end_of_life": {
    "title": "text",
    "story": [
      {
        "file": {
          "uri": {},
          "path": {},
          "fileName": {},
          "mime": {}
        },
        "title": "text",
        "description": "text"
      }
    ]
  },
  "history": [
    {
      "date": "text",
      "title": "text",
      "type": "text",
      "sub_title": "text",
      "description": "text",
      "place": "text",
      "document": {
        "uri": "text",
        "path": "text",
        "fileName": "text",
        "mime": "text"
      },
      "asset": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "background": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "timeline_asset": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "coordinates": {
        "longitude": 1,
        "latitude": 1
      }
    }
  ],
  "video": {
    "title": "text",
    "video": [
      {
        "asset": {
          "uri": {},
          "path": {},
          "fileName": {},
          "mime": {}
        },
        "thumbnail": {
          "uri": {},
          "path": {},
          "fileName": {},
          "mime": {}
        }
      }
    ]
  },
  "slug": "treebike"
}

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Fill car with AI

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

vinstringRequired

Responses

200Success

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Request successful

datamultipleOptionalExample: Brand | Product | Notification | ...

post

/product/fill/car/ai

HTTPcURLJavaScriptPython

POST /product/fill/car/ai HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "vin": "text"
}

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Update product

put

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

product_idstringRequired

Body

application/json

product_feature_liststring[]Optional

slugstring · enumOptionalPossible values:

Responses

200Success

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Request successful

datamultipleOptionalExample: Brand | Product | Notification | ...

put

/product/update/{product_id}

HTTPcURLJavaScriptPython

PUT /product/update/{product_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 8864

{
  "details": {
    "product_background_image": "text",
    "product_image": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "product_image_video": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "product_image_placeholder_properties": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "splashscreen_video": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "promotional_video": {
      "asset": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "thumbnail": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      }
    },
    "product_name": "text",
    "product_general_name": "text",
    "product_information": "text",
    "product_origin": [
      {
        "iconUrl": "text",
        "title": "text",
        "date": "text",
        "description": "text",
        "location": "text",
        "external_uri": "text",
        "coordinates": {
          "longitude": 1,
          "latitude": 1
        },
        "asset": {
          "uri": {},
          "path": {},
          "fileName": {},
          "mime": {}
        },
        "color": "text"
      }
    ],
    "product_creation_country": "text",
    "product_contact": "text",
    "product_producer_name": "text",
    "product_description": "text",
    "product_description_asset": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "product_sub_logo": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "price": {
      "amount": 1,
      "currency": "text"
    },
    "sku_id": "text",
    "gtin": "text",
    "player": {
      "title": "text",
      "icon": "text",
      "description": "text",
      "content": [
        {
          "uri": {},
          "path": {},
          "fileName": {},
          "mime": {}
        }
      ]
    },
    "team": {
      "title": "text",
      "icon": "text",
      "description": "text",
      "content": [
        {
          "uri": {},
          "path": {},
          "fileName": {},
          "mime": {}
        }
      ]
    },
    "tabs": [
      {
        "title": "text",
        "icon": "text",
        "description": "text",
        "type": "list-media",
        "content": [
          {
            "uri": {},
            "path": {},
            "fileName": {},
            "mime": {}
          }
        ]
      }
    ],
    "shop_url": "text"
  },
  "warranty": {
    "product_warranty": true,
    "product_warranty_duration": 1,
    "product_warranty_extend": true,
    "product_warranty_extend_price": {
      "amount": 1,
      "currency": "text"
    },
    "product_warranty_extend_terms": "text",
    "product_warranty_extend_duration": 1,
    "product_warranty_extend_limit": 1
  },
  "care": {
    "product_image": "text",
    "product_document": "text"
  },
  "end_of_life": {
    "resale": "text",
    "donate": "text",
    "recycle": "text"
  },
  "history": [
    {
      "date": "text",
      "title": "text",
      "type": "text",
      "sub_title": "text",
      "description": "text",
      "place": "text",
      "document": {
        "uri": "text",
        "path": "text",
        "fileName": "text",
        "mime": "text"
      },
      "asset": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "background": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "timeline_asset": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "coordinates": {
        "longitude": 1,
        "latitude": 1
      }
    }
  ],
  "media": [
    {
      "type": "video",
      "title": "text",
      "description": "text",
      "content": {}
    }
  ],
  "video": {
    "title": "text",
    "video": [
      {
        "asset": {
          "uri": {},
          "path": {},
          "fileName": {},
          "mime": {}
        },
        "thumbnail": {
          "uri": {},
          "path": {},
          "fileName": {},
          "mime": {}
        }
      }
    ]
  },
  "pass": {
    "type": "membership",
    "qr_code_url": "text",
    "product_thumbnail": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "product_thumbnail_2x": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "product_thumbnail_3x": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "brand_logo": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "brand_logo_2x": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "brand_logo_3x": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "icon": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "icon_2x": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "icon_3x": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "strip": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "strip_2x": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "background": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "background_2x": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "text_color": "text",
    "pass_color": "text",
    "fields": [
      {
        "label": "text",
        "value": "text"
      }
    ]
  },
  "banner": {
    "type": "game",
    "content": [
      {
        "asset": {
          "uri": {},
          "path": {},
          "fileName": {},
          "mime": {}
        },
        "external_url": "text"
      }
    ]
  },
  "multi_banner": [
    {
      "type": "game",
      "content": {
        "asset": {
          "uri": {},
          "path": {},
          "fileName": {},
          "mime": {}
        },
        "external_url": "text"
      }
    }
  ],
  "product_feature_list": [
    "text"
  ],
  "slug": "treebike",
  "vehicle": {
    "type": "car",
    "mileage": {
      "type": "km",
      "value": 1
    },
    "transmission": "automatic",
    "year": 1,
    "specification_asset": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "ownership_certificate": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "registration_mark": "text",
    "number_of_owners": 1,
    "doors": 1,
    "hand_drive": "text",
    "colour": "text",
    "body_type": "text",
    "interior": "text",
    "engine": "electric",
    "engine_size": "text",
    "serial_number": {
      "type": "VIN",
      "value": "text"
    },
    "drive": {
      "asset": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "battery": "text",
      "acceleration": {
        "value": 1,
        "range": "text"
      },
      "range": {
        "value": 1,
        "sub_value": "text"
      },
      "drive": "text"
    },
    "dimensions": {
      "asset": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "weight": {
        "value": 1,
        "sub_value": "text"
      },
      "cargo": {
        "value": 1,
        "sub_value": "text"
      },
      "wheels": {
        "value": 1,
        "sub_value": "text"
      },
      "seating": {
        "value": 1,
        "sub_value": "text"
      },
      "centre_touchscreen": {
        "value": 1,
        "sub_value": "text"
      },
      "rear_touchscreen": {
        "value": 1,
        "sub_value": "text"
      },
      "ground_clearance": {
        "value": 1,
        "sub_value": "text"
      },
      "width": {
        "value": 1,
        "sub_value": "text"
      },
      "height": {
        "value": 1,
        "sub_value": "text"
      },
      "length": {
        "value": 1,
        "sub_value": "text"
      },
      "track_front": {
        "value": 1,
        "sub_value": "text"
      },
      "track_rear": {
        "value": 1,
        "sub_value": "text"
      }
    },
    "power_consumption": {
      "asset": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "co2_emissions": {
        "value": 1,
        "sub_value": "text"
      },
      "co2_efficiency_class": "text",
      "official_power_consumption": {
        "value": 1,
        "sub_value": "text"
      },
      "fuel_consumption": {
        "value": 1,
        "sub_value": "text"
      }
    },
    "charging": {
      "asset": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "supercharging_max": {
        "value": 1,
        "sub_value": "text"
      },
      "charging_speed": {
        "value": 1,
        "sub_value": "text"
      }
    },
    "warranty": {
      "asset": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "basic_vehicle": {
        "label": "text",
        "values": [
          {
            "value": "text",
            "sub_value": "text"
          }
        ]
      },
      "battery_drive_unit": {
        "label": "text",
        "values": [
          {
            "value": "text",
            "sub_value": "text"
          }
        ]
      }
    },
    "maintenance_history": {
      "date": "text",
      "title": "text",
      "shop": {
        "name": "text",
        "coordinates": {
          "longitude": 1,
          "latitude": 1
        }
      },
      "report": {
        "icon": "text",
        "mileage": {
          "type": "km",
          "value": 1
        },
        "registration": "text",
        "details": {
          "description": "text",
          "updates": [
            "text"
          ]
        },
        "documents": {
          "invoices": [
            {
              "uri": "text",
              "path": "text",
              "fileName": "text",
              "mime": "text"
            }
          ],
          "reports": [
            {
              "uri": "text",
              "path": "text",
              "fileName": "text",
              "mime": "text"
            }
          ]
        }
      }
    },
    "other_informations": [
      {
        "title": "text",
        "description": "text"
      }
    ]
  },
  "art": {
    "art_id": "text",
    "artist_name": "text",
    "artist_description": "text",
    "artist_description_gallery": [
      {
        "type": "video",
        "title": "text",
        "description": "text",
        "content": {}
      }
    ],
    "artist_banner_asset": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "artist_signature": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    }
  },
  "documents": [
    {
      "title": "text",
      "description": "text",
      "document": {
        "uri": "text",
        "path": "text",
        "fileName": "text",
        "mime": "text"
      },
      "external_uri": "text"
    }
  ],
  "schedule_events": [
    {
      "tag": "text",
      "title": "text",
      "description": "text",
      "place": "text",
      "start_date": "text",
      "end_date": "text",
      "background": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "external_url": "text",
      "media": [
        {
          "type": "text",
          "title": "text",
          "sub_title": "text",
          "description": "text",
          "content": [
            {
              "type": "video",
              "title": "text",
              "description": "text",
              "content": {}
            }
          ]
        }
      ]
    }
  ],
  "schedule_events_section_asset": {
    "uri": {},
    "path": {},
    "fileName": {},
    "mime": {}
  },
  "galleries": [
    {
      "type": "text",
      "title": "text",
      "sub_title": "text",
      "description": "text",
      "content": [
        {
          "type": "video",
          "title": "text",
          "description": "text",
          "content": {}
        }
      ]
    }
  ],
  "shops": [
    {
      "title": "text",
      "categories": [
        {
          "title": "text",
          "asset": {
            "uri": {},
            "path": {},
            "fileName": {},
            "mime": {}
          },
          "products": [
            {
              "name": "text",
              "asset": {
                "uri": {},
                "path": {},
                "fileName": {},
                "mime": {}
              },
              "external_url": "text",
              "price": {
                "amount": 1,
                "currency": "text"
              }
            }
          ]
        }
      ]
    }
  ],
  "shops_section_asset": {
    "uri": {},
    "path": {},
    "fileName": {},
    "mime": {}
  },
  "reward_section_asset": {
    "uri": {},
    "path": {},
    "fileName": {},
    "mime": {}
  },
  "polls": [
    {
      "_id": "text",
      "title": "text",
      "description": "text",
      "poll_image_uri": "text",
      "custom_push_message": "text",
      "answers": [
        "text"
      ],
      "expiration_date": 1
    }
  ],
  "flippable_card_style": {
    "front": {
      "background": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "sub_product_image": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "colors": {
        "primary": "text",
        "secondary": "text",
        "tertiary": "text",
        "quaternary": "text",
        "bg_primary": "text",
        "bg_secondary": "text",
        "text_color": "text",
        "text_color_secondary": "text"
      }
    },
    "back": {
      "background": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "sub_product_image": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "colors": {
        "primary": "text",
        "secondary": "text",
        "tertiary": "text",
        "quaternary": "text",
        "bg_primary": "text",
        "bg_secondary": "text",
        "text_color": "text",
        "text_color_secondary": "text"
      }
    }
  },
  "booklet": {
    "section_asset": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "presentation_asset": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "presentation": {
      "asset": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "title": "text",
      "description": "text",
      "content": [
        {
          "type": "video",
          "title": "text",
          "description": "text",
          "content": {}
        }
      ],
      "cta_label": "text",
      "external_url": "text"
    },
    "promotion": {
      "asset": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "background": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "title": "text",
      "sub_title": "text",
      "description": "text",
      "cta_label": "text",
      "external_url": "text"
    }
  }
}

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Delete product

delete

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

product_idstringRequired

Responses

200Success

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Request successful

datamultipleOptionalExample: Brand | Product | Notification | ...

delete

/product/delete/{product_id}

HTTPcURLJavaScriptPython

DELETE /product/delete/{product_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Add poll to a product

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

product_idstringRequired

Body

application/json

Responses

200Success

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Request successful

datamultipleOptionalExample: Brand | Product | Notification | ...

post

/product/poll/{product_id}

HTTPcURLJavaScriptPython

POST /product/poll/{product_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 286

{
  "poll": {
    "_id": "text",
    "title": "text",
    "description": "text",
    "poll_image_uri": "text",
    "custom_push_message": "text",
    "answers": [
      "text"
    ],
    "expiration_date": 1
  },
  "voucher": {
    "voucher_image": "text",
    "voucher_title": "text",
    "voucher_description": "text",
    "voucher_promo_code": "text",
    "expiration_date": 1
  }
}

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Update a poll

put

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

poll_idstringRequired

Body

application/json

Responses

200Success

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Request successful

datamultipleOptionalExample: Brand | Product | Notification | ...

put

/product/poll/{poll_id}

HTTPcURLJavaScriptPython

PUT /product/poll/{poll_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "poll": {
    "title": "text",
    "description": "text",
    "poll_image_uri": "text",
    "custom_push_message": "text",
    "answers": [
      "text"
    ],
    "expiration_date": 1
  }
}

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Delete a poll

delete

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

poll_idstringRequired

Responses

200Success

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Request successful

datamultipleOptionalExample: Brand | Product | Notification | ...

delete

/product/poll/{poll_id}

HTTPcURLJavaScriptPython

DELETE /product/poll/{poll_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Create certificates from a product

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

product_idstringRequired

Body

application/json

collection_namestringOptional

display_edition_badgebooleanOptional

multi_ownerbooleanRequired

proof_of_purchase_securitybooleanRequired

collection_materialsstring[]Optional

collection_dimensionsstringOptional

certificate_typestring · enumOptionalPossible values:

claim_templatestring · enumOptionalPossible values:

supplynumber · min: 1Required

Responses

200Success

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Request successful

datamultipleOptionalExample: Brand | Product | Notification | ...

post

/product/certificate/create/{product_id}

HTTPcURLJavaScriptPython

POST /product/certificate/create/{product_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 737

{
  "collection_name": "text",
  "display_edition_badge": true,
  "multi_owner": true,
  "proof_of_purchase_security": true,
  "collection_materials": [
    "text"
  ],
  "collection_dimensions": "text",
  "certificate_type": "AUTHENTIC",
  "claim_template": "classic",
  "claim_template_structure": [
    {
      "type": "title-description-asset",
      "title": "text",
      "description": "text",
      "asset": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      }
    }
  ],
  "supply": 1,
  "certificate_ownership_card_custom": {
    "front": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "back": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    }
  },
  "external_link": [
    {
      "social_name": "facebook",
      "url": "text"
    }
  ],
  "media": [
    {
      "uri": {},
      "title": {},
      "description": {},
      "order": {},
      "displayMode": "basic",
      "sliderIndex": {},
      "main": {},
      "path": {},
      "fileName": {},
      "mime": {}
    }
  ]
}

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Get product urls

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

product_idstringRequired

Responses

200Success

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Request successful

datamultipleOptionalExample: Brand | Product | Notification | ...

get

/product/urls/{product_id}

HTTPcURLJavaScriptPython

GET /product/urls/{product_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Add Digital Passport Product to a product

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

product_idstringRequired

Body

application/json

Responses

200Success

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Request successful

datamultipleOptionalExample: Brand | Product | Notification | ...

post

/product/dpp/{product_id}

HTTPcURLJavaScriptPython

POST /product/dpp/{product_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "dpp": [
    {
      "section": "text",
      "components": [
        {
          "title": "text",
          "description": "text",
          "components": [
            {
              "type": "progress",
              "content": {}
            }
          ]
        }
      ]
    }
  ]
}

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Export product ids as CSV

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200Success

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Request successful

datamultipleOptionalExample: Brand | Product | Notification | ...

get

/product/export/product_ids

HTTPcURLJavaScriptPython

GET /product/export/product_ids HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Get epos codes for a product as CSV

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

product_idstringRequired

Responses

200Success

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Request successful

datamultipleOptionalExample: Brand | Product | Notification | ...

get

/product/export/proof_of_purchase_codes/{product_id}

HTTPcURLJavaScriptPython

GET /product/export/proof_of_purchase_codes/{product_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Get all epos codes as CSV

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200Success

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Request successful

datamultipleOptionalExample: Brand | Product | Notification | ...

get

/product/export/all/proof_of_purchase_codes

HTTPcURLJavaScriptPython

GET /product/export/all/proof_of_purchase_codes HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Get product owners

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

product_idstringRequired

Responses

200Success

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Request successful

datamultipleOptionalExample: Brand | Product | Notification | ...

get

/product/get/owners/{product_id}

HTTPcURLJavaScriptPython

GET /product/get/owners/{product_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

Add Apple & Google pass structure to a product

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

product_idstringRequired

Body

application/json

typestring · enumRequiredPossible values:

qr_code_urlstringRequired

text_colorstringRequired

pass_colorstringRequired

Responses

200Success

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Request successful

datamultipleOptionalExample: Brand | Product | Notification | ...

post

/product/build/pass/{product_id}

HTTPcURLJavaScriptPython

POST /product/build/pass/{product_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 896

{
  "type": "membership",
  "qr_code_url": "text",
  "product_thumbnail": {
    "uri": {},
    "path": {},
    "fileName": {},
    "mime": {}
  },
  "product_thumbnail_2x": {
    "uri": {},
    "path": {},
    "fileName": {},
    "mime": {}
  },
  "product_thumbnail_3x": {
    "uri": {},
    "path": {},
    "fileName": {},
    "mime": {}
  },
  "brand_logo": {
    "uri": {},
    "path": {},
    "fileName": {},
    "mime": {}
  },
  "brand_logo_2x": {
    "uri": {},
    "path": {},
    "fileName": {},
    "mime": {}
  },
  "brand_logo_3x": {
    "uri": {},
    "path": {},
    "fileName": {},
    "mime": {}
  },
  "icon": {
    "uri": {},
    "path": {},
    "fileName": {},
    "mime": {}
  },
  "icon_2x": {
    "uri": {},
    "path": {},
    "fileName": {},
    "mime": {}
  },
  "icon_3x": {
    "uri": {},
    "path": {},
    "fileName": {},
    "mime": {}
  },
  "strip": {
    "uri": {},
    "path": {},
    "fileName": {},
    "mime": {}
  },
  "strip_2x": {
    "uri": {},
    "path": {},
    "fileName": {},
    "mime": {}
  },
  "background": {
    "uri": {},
    "path": {},
    "fileName": {},
    "mime": {}
  },
  "background_2x": {
    "uri": {},
    "path": {},
    "fileName": {},
    "mime": {}
  },
  "text_color": "text",
  "pass_color": "text",
  "fields": [
    {
      "label": "text",
      "value": "text"
    }
  ]
}

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}

(Shopify) Bulk import products

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

brand_idstringRequired

product_idstringRequired

shopify_product_idstringOptional

slugstring · enumRequiredPossible values:

Responses

200Success

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Request successful

datamultipleOptionalExample: Brand | Product | Notification | ...

post

/product/bulk-import

HTTPcURLJavaScriptPython

POST /product/bulk-import HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2583

{
  "brand_id": "text",
  "product_id": "text",
  "shopify_product_id": "text",
  "details": {
    "product_background_image": "text",
    "product_image": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "product_image_video": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "product_image_placeholder_properties": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "splashscreen_video": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "promotional_video": {
      "asset": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "thumbnail": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      }
    },
    "product_name": "text",
    "product_general_name": "text",
    "product_information": "text",
    "product_origin": [
      {
        "iconUrl": "text",
        "title": "text",
        "date": "text",
        "description": "text",
        "location": "text",
        "external_uri": "text",
        "coordinates": {
          "longitude": 1,
          "latitude": 1
        },
        "asset": {
          "uri": {},
          "path": {},
          "fileName": {},
          "mime": {}
        },
        "color": "text"
      }
    ],
    "product_creation_country": "text",
    "product_contact": "text",
    "product_producer_name": "text",
    "product_description": "text",
    "product_description_asset": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "product_sub_logo": {
      "uri": {},
      "path": {},
      "fileName": {},
      "mime": {}
    },
    "price": {
      "amount": 1,
      "currency": "text"
    },
    "sku_id": "text",
    "gtin": "text",
    "player": {
      "title": "text",
      "icon": "text",
      "description": "text",
      "content": [
        {
          "uri": {},
          "path": {},
          "fileName": {},
          "mime": {}
        }
      ]
    },
    "team": {
      "title": "text",
      "icon": "text",
      "description": "text",
      "content": [
        {
          "uri": {},
          "path": {},
          "fileName": {},
          "mime": {}
        }
      ]
    },
    "tabs": [
      {
        "title": "text",
        "icon": "text",
        "description": "text",
        "type": "list-media",
        "content": [
          {
            "uri": {},
            "path": {},
            "fileName": {},
            "mime": {}
          }
        ]
      }
    ],
    "shop_url": "text"
  },
  "warranty": {
    "product_warranty": true,
    "product_warranty_duration": 1,
    "product_warranty_extend": true,
    "product_warranty_extend_price": {
      "amount": 1,
      "currency": "text"
    },
    "product_warranty_extend_terms": "text",
    "product_warranty_extend_duration": 1,
    "product_warranty_extend_limit": 1
  },
  "care": {
    "product_image": "text",
    "product_document": "text"
  },
  "end_of_life": {
    "title": "text",
    "story": [
      {
        "file": {
          "uri": {},
          "path": {},
          "fileName": {},
          "mime": {}
        },
        "title": "text",
        "description": "text"
      }
    ]
  },
  "history": [
    {
      "date": "text",
      "title": "text",
      "type": "text",
      "sub_title": "text",
      "description": "text",
      "place": "text",
      "document": {
        "uri": "text",
        "path": "text",
        "fileName": "text",
        "mime": "text"
      },
      "asset": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "background": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "timeline_asset": {
        "uri": {},
        "path": {},
        "fileName": {},
        "mime": {}
      },
      "coordinates": {
        "longitude": 1,
        "latitude": 1
      }
    }
  ],
  "video": {
    "title": "text",
    "video": [
      {
        "asset": {
          "uri": {},
          "path": {},
          "fileName": {},
          "mime": {}
        },
        "thumbnail": {
          "uri": {},
          "path": {},
          "fileName": {},
          "mime": {}
        }
      }
    ]
  },
  "slug": "treebike"
}

200Success

{
  "success": true,
  "message": "Request successful",
  "data": "Brand | Product | Notification | ..."
}