API
Image Recognition API

SKU

Methods allow you to get a complete list or a specific SKU in Eyrene, view information about them, update all fields, or only select SKU fields.



Retrieve a list of SKUs.

GET /sku
GET
Request
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
limit
optional
String
The number of results to return per page.
offset
optional
String
The initial index from which to return the results.


Response parameters



count integer

The number of SKUs.



next string (uri) Nullable

Next page.



previous string (uri) Nullable

Previous page.



results array of objects

An array of objects with information about SKUs:

  • id string SKU ID.
  • cid string Client-specific SKU ID, e.g. internal code.
  • ean13 string European Article Number.
  • image string SKU image ID, available via /uploads or /uploads_by_url.
  • name string Human readable SKU name.
  • brand string Brand ID.
  • category string Category ID.
  • manufacturer string Manufacturer ID.
  • size_x_mm float Product width in mm.
  • size_y_mm float Product height in mm.
  • size_z_mm float Product depth in mm.






Сreate a new sku.

POST /sku
POST
Request
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
SKU ID.
cid
optional
String
Client-specific SKU ID, e.g. internal code.
ean13
optional
String
European Article Number.
image
optional
String
SKU image ID, available via /uploads or /uploads_by_url.
name
optional
String
Human readable SKU name.
brand
optional
String
Brand ID.
category
optional
String
Category ID.
manufacturer
optional
String
Manufacturer ID.
size_x_mm
optional
Integer
Product width in mm.
size_y_mm
optional
Integer
Product height in mm.
size_z_mm
optional
String
Product depth in mm.



Retrieve detailed information about SKU by ID.

GET /sku/{id}
GET
Request
Path Params
id
required
String
SKU ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.


Response parameters





id string

SKU ID.



cid string

Client-specific SKU ID, e.g. internal code.



ean13 string

European Article Number.



image string

SKU image ID, available via /uploads or /uploads_by_url.



name string

Human readable SKU name.



brand string

Brand ID.



category string

Category ID.



manufacturer string

Manufacturer ID.



size_x_mm float

Product width in mm.



size_y_mm float

Product height in mm.



size_z_mm float

Product depth in mm.









Update all SKU fields.

PUT /sku/{id}
PUT
Request
Path Params
id
required
String
SKU ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
SKU ID.
cid
optional
String
Client-specific SKU ID, e.g. internal code.
ean13
optional
String
European Article Number.
image
optional
String
SKU image ID, available via /uploads or /uploads_by_url.
name
optional
String
Human readable SKU name.
brand
optional
String
Brand ID.
category
optional
String
Category ID.
manufacture
optional
String
Manufacturer ID.
size_x_mm
optional
Integer
Product width in mm.
size_y_mm
optional
String
Product height in mm.
size_z_mm
optional
String
Product depth in mm.


Response parameters





id string

SKU ID.



cid string

Client-specific SKU ID, e.g. internal code.



ean13 string

European Article Number.



image string

SKU image ID, available via /uploads or /uploads_by_url.



name string

Human readable SKU name.



brand string

Brand ID.



category string

Category ID.



manufacturer string

Manufacturer ID.



size_x_mm float

Product width in mm.



size_y_mm float

Product height in mm.



size_z_mm float

Product depth in mm.









Update some of SKU .

PATCH /sku/{id}
PATCH
Request
Path Params
id
required
String
SKU ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
SKU ID.
cid
optional
String
Client-specific SKU ID, e.g. internal code.
ean13
optional
String
European Article Number.
image
optional
String
SKU image ID, available via /uploads or /uploads_by_url.
name
optional
String
Human readable SKU name.
brand
optional
String
Brand ID.
category
optional
String
Category ID.
manufacturer
optional
String
Manufacturer ID.
size_x_mm
optional
Integer
Product width in mm.
size_y_mm
optional
Integer
Product height in mm.
size_z_mm
optional
Integer
Product depth in mm.


Response parameters





id string

SKU ID.



cid string

Client-specific SKU ID, e.g. internal code.



ean13 string

European Article Number.



image string

SKU image ID, available via /uploads or /uploads_by_url.



name string

Human readable SKU name.



brand string

Brand ID.



category string

Category ID.



manufacturer string

Manufacturer ID.



size_x_mm float

Product width in mm.



size_y_mm float

Product height in mm.



size_z_mm float

Product depth in mm.









List SKU with the given Customer ID (cid) field.

GET /sku/?cid={cid}
GET
Request
Path Params
cid
required
String
Customer SKU ID.
Header Parameters
Authorization
optional
String
String in "Token XXXXXX..." format


Response parameters



id string

SKU ID.



cid string

Client-specific SKU ID, e.g. internal code



ean13 string

European Article Number.



image string

SKU image ID, available via /uploads or /uploads_by_url.



name string

Human readable SKU name.



brand string

Brand ID.



category string

Category ID.



manufacturer string

Manufacturer ID.



size_x_mm float

Product width in mm.



size_y_mm float

Product height in mm.



size_z_mm float

Product depth in mm.









Updated 03 Mar 2023
Did this page help you?