Skip to main content

Method list

List of Recognition API v1.5 methods for Inspector Cloud backend.

Uploading images


POST /uploads

Upload images to the service.


POST /uploads/upload_by_url

Upload image to the service by URL.


GET /uploads/{id}

Get the details of the previously uploaded image.


Image Recognition


POST /recognize

Create a request for processing a group of photos.


POST /recognition_error

Create a recognition error message.


Reports


GET /reports

Retrieves a list of all available reports.


GET reports/{report_id}

Get report details by ID.


POST /reports/force_update

Updates report details.


Catalogs


GET POST /brands

Retrieves a list of brands or creates a new one.


GET PUT PATCH /brands/{id}

Retrieve detailed brand information by ID, or updates the fields in the brand card (specified or all).


GET POST /categories

Retrieves a list of categories or creates a new one.


GET PUT PATCH /categories/{id}

Retrieve detailed category information by ID, or updates the fields in the category card (specified or all).


GET POST /manufacturers

Retrieves a list of manufacturers or creates a new one.


GET PUT PATCH /manufacturers/{id}

Retrieve detailed manufacturer information by ID, or updates the fields in the manufacturer card (specified or all).


GET POST /sku

Retrieves a list of SKU or creates a new one.


GET PUT PATCH /sku/{id}

Retrieve detailed SKU information by ID, or updates the fields in the SKU card (specified or all).


GET /sku/?cid={cid}

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


Master data


GET POST /displays

Retrieves a list of displays or creates a new one.


GET PUT PATCH DELETE /displays/{id}

Retrieve detailed display information by ID, or updates the fields in the display (specified or all). Also allows you to delete display via DELETE method.


GET POST /visits

Retrieves a list of visits records or creates a new one.


GET PUT PATCH /visits/{id}

Retrieve detailed information about visit by ID, or updates the fields in the visit (specified or all).


GET POST /mhl

Retrieves a list of MHL or creates a new one.


GET PUT PATCH DELETE /mhl/{id}

Retrieve detailed MHL information by ID, or updates the fields in the MHL (specified or all). Also allows you to delete the MHL via DELETE method.


GET POST /mhl_record

Retrieves a list of MHL records or creates a new one.


GET PUT PATCH DELETE /mhl_record/{id}

Retrieve detailed MHL record information by ID, or updates the fields in the MHL record (specified or all). Also allows you to delete the MHL record via DELETE method.


GET POST /planograms

Retrieves a list of planograms or creates a new one.


GET PUT PATCH DELETE /planograms/{id}

Retrieve detailed planogram information by ID, or updates the fields in the planogram (specified or all). Also allows you to delete the planogram via DELETE method.


GET POST /planogram_records

Retrieves a list of planograms records or creates a new one.


GET PUT PATCH DELETE /planogram_records/{id}

Retrieve detailed planogram record information by ID, or updates the fields in the planogram record (specified or all). Also allows you to delete the planogram record via DELETE method.


Other

POST /oos_reason

Allows to set an out-of-stock reason for SKU in a scene.