API
Image Recognition API

MHL record

Methods allow you to get a complete list or a specific MHL record in Eyrene, view information about them, update all fields, or only select MHL record fields. Also, you can delete the MHL record by ID.



Retrieve an MHL record.

GET /mhl_record
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 MHL records.



next string (uri) Nullable

Next page.



previous string (uri) Nullable

Previous page.



results array of objects

An array of objects with information about MHL records.

  • id string Unique ID.
  • name string Human-readable name.
  • musthavelist string Must-have list ID.
  • sku string SKU ID.
  • sku1 string SKU ID.
  • sku2 string SKU ID.
  • sku3 string SKU ID.
  • sku4 string SKU ID.
  • sku5 string SKU ID.
  • sku6 string SKU ID.


Six optional sku1-sku6 fields are combined with logical OR when checking the MHL compliance:

Compliant = (sku is present) OR (sku1 is present) OR (sku2 is present) ... OR (sku6 is present)







Сreate a new MHL record.

POST /mhl_record
POST
Request
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
Unique ID.
name
optional
String
Human-readable name.
musthavelist
optional
String
Must have list ID.
sku
optional
String
SKU ID.
sku1-sku6
optional
String
SKU ID.



Retrieve detailed information about MHL records by ID.

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


Response parameters



count integer

The number of MHL records.



next string (uri) Nullable

Next page.



previous string (uri) Nullable

Previous page.



results array of objects

An array of objects with information about MHL records.

  • id string Unique ID.
  • name string Human-readable name.
  • musthavelist string Must-have list ID.
  • sku string SKU ID.
  • sku1 string SKU ID.
  • sku2 string SKU ID.
  • sku3 string SKU ID.
  • sku4 string SKU ID.
  • sku5 string SKU ID.
  • sku6 string SKU ID.


Six optional sku1-sku6 fields are combined with logical OR when checking the MHL compliance:

Compliant = (sku is present) OR (sku1 is present) OR (sku2 is present) ... OR (sku6 is present)







Update all fields of the MHL record.

PUT /mhl_record/{id}
PUT
Request
Path Params
id
required
String
MHL record ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
Unique ID.
name
optional
String
Human-readable name.
musthavelist
optional
String
MHL ID.
sku
optional
String
SKU ID.
sku1-sku6
optional
String
SKU ID.


​Response parameters



count integer

The number of MHL records.



next string (uri) Nullable

Next page.



previous string (uri) Nullable

Previous page.



results array of objects

An array of objects with information about MHL records.

  • id string Unique ID.
  • name string Human-readable name.
  • musthavelist string Must-have list ID.
  • sku string SKU ID.
  • sku1 string SKU ID.
  • sku2 string SKU ID.
  • sku3 string SKU ID.
  • sku4 string SKU ID.
  • sku5 string SKU ID.
  • sku6 string SKU ID.


Six optional sku1-sku6 fields are combined with logical OR when checking the MHL compliance:

Compliant = (sku is present) OR (sku1 is present) OR (sku2 is present) ... OR (sku6 is present)







Update some of the fields in the MHL record.

PATCH /mhl_record/{id}
PATCH
Request
Path Params
id
required
String
MHL record ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.
Body Parameters
id
optional
String
Unique ID.
name
optional
String
Human-readable name.
musthavelist
optional
String
MHL ID.
sku
optional
String
SKU ID.
sku1-sku6
optional
String
SKU ID.


Response parameters​



count integer

The number of MHL records.



next string (uri) Nullable

Next page.



previous string (uri) Nullable

Previous page.



results array of objects

An array of objects with information about MHL records.

  • id string Unique ID.
  • name string Human-readable name.
  • musthavelist string Must-have list ID.
  • sku string SKU ID.
  • sku1 string SKU ID.
  • sku2 string SKU ID.
  • sku3 string SKU ID.
  • sku4 string SKU ID.
  • sku5 string SKU ID.
  • sku6 string SKU ID.


Six optional sku1-sku6 fields are combined with logical OR when checking the MHL compliance:

Compliant = (sku is present) OR (sku1 is present) OR (sku2 is present) ... OR (sku6 is present)







Delete MHL record by ID.

DELETE /mhl_record/{id}
DELETE
Request
Path Params
id
required
String
MHL record ID.
Header Parameters
Authorization
required
String
String in "Token XXXXXX..." format.









Updated 03 Mar 2023
Did this page help you?
PREVIOUS
MHL
NEXT
Planograms
Docs powered by Archbee