--- title: SKU slug: _YcZ-sku docTags: createdAt: 2022-04-13T09:34:20.000Z --- 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. *** ::::ExpandableHeading{isOpen="true"} # GET /sku Retrieve a list of SKUs. :::ApiMethodV2 ```json { "tab": "request", "url": "https://instance_name/api/v1.5/sku/", "name": "Request example", "method": "GET", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [ { "kind": "required", "name": "Authorization", "type": "string", "description": "String in \"Token XXXXXX...\" format." } ], "bodyDataParameters": [ { "kind": "optional", "name": "limit", "type": "string", "description": "The number of results to return per page." }, { "kind": "optional", "name": "offset", "type": "string", "description": "The initial index from which to return the results." } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "1rlkLKO5JlhTk3S80Ce0g", "code": "{\n \"count\":2,\n \"next\":\"http://example.com\",\n \"previous\":null,\n \"results\":[\n {\n \"id\":703,\n \"cid\":\"9000101421\",\n \"ean13\":null,\n \"image\":86824084,\n \"name\":\"Bref 2x50g ProNature Fresh Mint\",\n \"brand\":376,\n \"category\":49,\n \"manufacturer\":6,\n \"size_x_mm\":125,\n \"size_y_mm\":176,\n \"size_z_mm\":50\n },\n {\n \"id\":704,\n \"cid\":\"7441078217\",\n \"ean13\":null,\n \"image\":86824149,\n \"name\":\"PAPEL HIGIENICO SUPER MAX 220 MAX 4 ROLLOS\",\n \"brand\":10285,\n \"category\":3235,\n \"manufacturer\":474,\n \"size_x_mm\":200,\n \"size_y_mm\":210,\n \"size_z_mm\":110\n }\n ]\n}", "language": "200", "customLabel": "" } ], "selectedLanguageId": "1rlkLKO5JlhTk3S80Ce0g" }, "examples": { "languages": [ { "id": "Cu1xhLxZ5PHAuLFx_iIf1", "code": "curl –i –X GET\r\n https://test.eyrene.com/api/v1.5/sku/\r\n -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’ \r\n –F \"limit=2\" \\\r\n –F \"offset=0\" ", "language": "curl", "customLabel": "" } ], "selectedLanguageId": "Cu1xhLxZ5PHAuLFx_iIf1" }, "description": "GET /sku", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "request-example", "legacyHash": "LL7E5MIMGvpHqCRhogzHy" } ``` ::: ## Response parameters[​](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/catalog/brands#response-definitions) *** **`count`** *integer* The number of SKUs. *** **`next`** *string (uri)* *Nullable*** Next page. *** **`previous`** *string (uri)* *Nullable*** Previous page. *** **`results`** a*rray 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](https://docs.eyrene.com/uploads#ou-post-uploads) or [/uploads\_by\_url](https://docs.eyrene.com/uploads#qa-post-uploadsuploadsbyurl). - **`name`** *string* Human readable SKU name. - **`brand`** *string*[ Brand](https://docs.eyrene.com/brands) ID. - **`category`** *string*[ Category](https://docs.eyrene.com/categories) ID. - **`manufacturer`** *string* [Manufacturer](https://docs.eyrene.com/manufacturers) 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. *** :::: *** ::::ExpandableHeading{isOpen="true"} # POST /sku Сreate a new sku. :::ApiMethodV2 ```json { "tab": "request", "url": "https://instance_name/api/v1.5/sku/", "name": "Request example", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [ { "kind": "required", "name": "Authorization", "type": "string", "description": "String in \"Token XXXXXX...\" format." } ], "bodyDataParameters": [ { "kind": "optional", "name": "id", "type": "string", "description": "SKU ID." }, { "kind": "optional", "name": "cid", "type": "string", "description": "Client-specific SKU ID, e.g. internal code." }, { "kind": "optional", "name": "ean13", "type": "string", "description": "European Article Number." }, { "kind": "optional", "name": "image", "type": "string", "description": "SKU image ID, available via /uploads or /uploads_by_url." }, { "kind": "optional", "name": "name", "type": "string", "description": "Human readable SKU name." }, { "kind": "optional", "name": "brand", "type": "string", "description": "Brand ID." }, { "kind": "optional", "name": "category", "type": "string", "description": "Category ID." }, { "kind": "optional", "name": "manufacturer", "type": "string", "description": "Manufacturer ID." }, { "kind": "optional", "name": "size_x_mm", "type": "Integer", "description": "Product width in mm." }, { "kind": "optional", "name": "size_y_mm", "type": "Integer", "description": "Product height in mm." }, { "kind": "optional", "name": "size_z_mm", "type": "string", "description": "Product depth in mm." } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "xcVqafQ2RCx_iOpUkQJ43", "code": "{\n \"result\": \"CREATED\"\n}", "language": "201", "customLabel": "" } ], "selectedLanguageId": "xcVqafQ2RCx_iOpUkQJ43" }, "examples": { "languages": [ { "id": "Cu1xhLxZ5PHAuLFx_iIf1", "code": "curl –i –X POST\r\n https://test.eyrene.com/api/v1.5/sku/ \r\n -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’ \r\n -F \"id=704\" \\\r\n -F \"cid=7441078217\" \\\r\n -F \"image=86824149\" \\\r\n -F \"name=PAPEL HIGIENICO SUPER MAX 220 MAX 4 ROLLOS\" \\\r\n -F \"brand=10285\" \\\r\n -F \"category=3235\" \\\r\n -F \"manufacturer=474\" \\\r\n -F \"size_x_mm=200\" \\\r\n -F \"size_x_mm=210\" \\\r\n -F \"size_z_mm=110\" \\", "language": "curl", "customLabel": "" } ], "selectedLanguageId": "Cu1xhLxZ5PHAuLFx_iIf1" }, "description": "POST /sku", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "request-example-1", "legacyHash": "VIHnD70CL4fQOZSpLI6Qz" } ``` ::: :::: *** ::::ExpandableHeading{isOpen="true"} # GET /sku/{id} Retrieve detailed information about SKU by ID. :::ApiMethodV2 ```json { "tab": "request", "url": "https://instance_name/api/v1.5/sku/{id}", "name": "Request example", "method": "GET", "request": { "pathParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "SKU ID." } ], "queryParameters": [], "headerParameters": [ { "kind": "required", "name": "Authorization", "type": "string", "description": "String in \"Token XXXXXX...\" format." } ], "bodyDataParameters": [], "formDataParameters": [] }, "results": { "languages": [ { "id": "BcmDi-d9UM-V1Lp9EpJ4I", "code": "{\n \"id\":703,\n \"cid\":\"9000101421\",\n \"ean13\":null,\n \"image\":86824084,\n \"name\":\"Bref 2x50g ProNature Fresh Mint\",\n \"brand\":376,\n \"category\":49,\n \"manufacturer\":6,\n \"size_x_mm\":125,\n \"size_y_mm\":176,\n \"size_z_mm\":50\n}", "language": "200", "customLabel": "" } ], "selectedLanguageId": "BcmDi-d9UM-V1Lp9EpJ4I" }, "examples": { "languages": [ { "id": "Cu1xhLxZ5PHAuLFx_iIf1", "code": "curl –i –X GET\r\n https://test.eyrene.com/api/v1.5/sku/703/ \r\n -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’ ", "language": "curl", "customLabel": "" } ], "selectedLanguageId": "Cu1xhLxZ5PHAuLFx_iIf1" }, "description": "GET /sku/{id}", "currentNewParameter": { "label": "Path Parameter", "value": "pathParameters" }, "autoGeneratedAnchorSlug": "request-example-2", "legacyHash": "-gQeRwsDdz0gc5UpOHBBf" } ``` ::: ## 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](https://docs.eyrene.com/uploads#ou-post-uploads) or [/uploads\_by\_url](https://docs.eyrene.com/uploads#qa-post-uploadsuploadsbyurl). *** **`name`** *string* Human readable SKU name. *** **`brand`** *string*[](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/sku/brand) [Brand](https://docs.eyrene.com/brands) ID. *** **`category`** *string*[](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/sku/categories) [Category](https://docs.eyrene.com/categories) ID. *** **`manufacturer`** *string*[](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/sku/monofacturers) [Manufacturer](https://docs.eyrene.com/manufacturers) 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. *** [](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/catalog/brands_id#response-definitions) :::: *** ::::ExpandableHeading{isOpen="true"} # PUT /sku/{id} Update all SKU fields. :::ApiMethodV2 ```json { "tab": "request", "url": "https://instance_name/api/v1.5/sku/{id}", "name": "Request example", "method": "PUT", "request": { "pathParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "SKU ID." } ], "queryParameters": [], "headerParameters": [ { "kind": "required", "name": "Authorization", "type": "string", "description": "String in \"Token XXXXXX...\" format." } ], "bodyDataParameters": [ { "kind": "optional", "name": "id", "type": "string", "description": "SKU ID." }, { "kind": "optional", "name": "cid", "type": "string", "description": "Client-specific SKU ID, e.g. internal code." }, { "kind": "optional", "name": "ean13", "type": "string", "description": "European Article Number." }, { "kind": "optional", "name": "image", "type": "string", "description": "SKU image ID, available via /uploads or /uploads_by_url." }, { "kind": "optional", "name": "name", "type": "string", "description": "Human readable SKU name." }, { "kind": "optional", "name": "brand", "type": "string", "description": "Brand ID." }, { "kind": "optional", "name": "category", "type": "string", "description": "Category ID." }, { "kind": "optional", "name": "manufacture", "type": "string", "description": "Manufacturer ID." }, { "kind": "optional", "name": "size_x_mm", "type": "Integer", "description": "Product width in mm." }, { "kind": "optional", "name": "size_y_mm", "type": "string", "description": "Product height in mm." }, { "kind": "optional", "name": "size_z_mm", "type": "string", "description": "Product depth in mm." } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "BcmDi-d9UM-V1Lp9EpJ4I", "code": "{\n \"id\":9846,\n \"cid\":\"9000101421\",\n \"ean13\":null,\n \"image\":86824084,\n \"name\":\"Bref 2x50g ProNature Fresh Mint\",\n \"brand\":376,\n \"category\":49,\n \"manufacturer\":6,\n \"size_x_mm\":125,\n \"size_y_mm\":176,\n \"size_z_mm\":50\n}", "language": "200", "customLabel": "" } ], "selectedLanguageId": "BcmDi-d9UM-V1Lp9EpJ4I" }, "examples": { "languages": [ { "id": "Cu1xhLxZ5PHAuLFx_iIf1", "code": "curl –i –X PUT\r\n https://test.eyrene.com/api/v1.5/sku/704/ \r\n -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’\r\n -F \"id=9846\" \\\r\n -F \"cid=9000101421\" \\\r\n -F \"image=86824084\" \\\r\n -F \"name=Bref 2x50g ProNature Fresh Mint\" \\\r\n -F \"brand=376\" \\\r\n -F \"category=49\" \\\r\n -F \"manufacturer=6\" \\\r\n -F \"size_x_mm=125\" \\\r\n -F \"size_x_mm=176\" \\\r\n -F \"size_z_mm=50\" \\", "language": "curl", "customLabel": "" } ], "selectedLanguageId": "Cu1xhLxZ5PHAuLFx_iIf1" }, "description": "PUT /sku/{id}", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "request-example-3", "legacyHash": "wKq23_Fk8w5nvvQ7g4vwF" } ``` ::: ## Response parameters[​](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/catalog/brands_id#response-definitions-1) *** **`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](https://docs.eyrene.com/uploads#ou-post-uploads) or [/uploads\_by\_url](https://docs.eyrene.com/uploads#qa-post-uploadsuploadsbyurl). *** **`name`** *string* Human readable SKU name. *** **`brand`** *string*[](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/sku/brand) [Brand](https://docs.eyrene.com/brands) ID. *** **`category`** *string*[](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/sku/categories) [Category](https://docs.eyrene.com/categories) ID. *** **`manufacturer`** *string*[](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/sku/monofacturers) [Manufacturer](https://docs.eyrene.com/manufacturers) 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. *** :::: *** ::::ExpandableHeading{isOpen="true"} # PATCH /sku/{id} Update some of SKU . :::ApiMethodV2 ```json { "tab": "request", "url": "https://instance_name/api/v1.5/sku/{id}", "name": "Request example", "method": "PATCH", "request": { "pathParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "SKU ID." } ], "queryParameters": [], "headerParameters": [ { "kind": "required", "name": "Authorization", "type": "string", "description": "String in \"Token XXXXXX...\" format." } ], "bodyDataParameters": [ { "kind": "optional", "name": "id", "type": "string", "description": "SKU ID." }, { "kind": "optional", "name": "cid", "type": "string", "description": "Client-specific SKU ID, e.g. internal code." }, { "kind": "optional", "name": "ean13", "type": "string", "description": "European Article Number." }, { "kind": "optional", "name": "image", "type": "string", "description": "SKU image ID, available via /uploads or /uploads_by_url." }, { "kind": "optional", "name": "name", "type": "string", "description": "Human readable SKU name." }, { "kind": "optional", "name": "brand", "type": "string", "description": "Brand ID." }, { "kind": "optional", "name": "category", "type": "string", "description": "Category ID." }, { "kind": "optional", "name": "manufacturer", "type": "string", "description": "Manufacturer ID." }, { "kind": "optional", "name": "size_x_mm", "type": "Integer", "description": "Product width in mm." }, { "kind": "optional", "name": "size_y_mm", "type": "Integer", "description": "Product height in mm." }, { "kind": "optional", "name": "size_z_mm", "type": "Integer", "description": "Product depth in mm." } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "BcmDi-d9UM-V1Lp9EpJ4I", "code": "{\n \"id\":9846,\n \"cid\":\"9000101421\",\n \"ean13\":null,\n \"image\":86824084,\n \"name\":\"PAPEL HIGIENICO SUPER MAX 220 MAX 4 ROLLOS\",\n \"brand\":376,\n \"category\":49,\n \"manufacturer\":6,\n \"size_x_mm\":125,\n \"size_y_mm\":176,\n \"size_z_mm\":50\n}", "language": "200", "customLabel": "" } ], "selectedLanguageId": "BcmDi-d9UM-V1Lp9EpJ4I" }, "examples": { "languages": [ { "id": "Cu1xhLxZ5PHAuLFx_iIf1", "code": "curl –i –X PATCH\r\n https://test.eyrene.com/api/v1.5/sku/704/ \r\n -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’\r\n -F \"id=9846\" \\\r\n -F \"name=PAPEL HIGIENICO SUPER MAX 220 MAX 4 ROLLOS\" \\", "language": "curl", "customLabel": "" } ], "selectedLanguageId": "Cu1xhLxZ5PHAuLFx_iIf1" }, "description": "PATCH /sku/{id}", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "request-example-4", "legacyHash": "HS11cTs9uyn0tqS_o-Nqe" } ``` ::: ## Response parameters[​](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/catalog/brands_id#response-definitions-1) *** **`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](https://docs.eyrene.com/uploads#ou-post-uploads) or [/uploads\_by\_url](https://docs.eyrene.com/uploads#qa-post-uploadsuploadsbyurl). *** **`name`** *string* Human readable SKU name. *** **`brand`** *string*[](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/sku/brand) [Brand](https://docs.eyrene.com/brands) ID. *** **`category`** *string*[](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/sku/categories) [Category](https://docs.eyrene.com/categories) ID. *** **`manufacturer`** *string*[](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/sku/monofacturers) [Manufacturer](https://docs.eyrene.com/manufacturers) 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. *** :::: *** ::::ExpandableHeading{isOpen="true"} # GET /sku/?cid={cid} List SKU with the given Customer ID (`cid`) field. :::ApiMethodV2 ```json { "tab": "request", "url": "https://instance_name/api/v1.5/sku/?cid={cid}", "name": "Request example", "method": "GET", "request": { "pathParameters": [ { "kind": "required", "name": "cid", "type": "string", "description": "Customer SKU ID." } ], "queryParameters": [], "headerParameters": [ { "kind": "optional", "name": "Authorization", "type": "string", "description": "String in \"Token XXXXXX...\" format" } ], "bodyDataParameters": [], "formDataParameters": [] }, "results": { "languages": [ { "id": "dU9xR9j8Bu4jftmV8BprY", "code": "{\n \"id\":703,\n \"cid\":\"9000101421\",\n \"ean13\":null,\n \"image\":86824084,\n \"name\":\"Bref 2x50g ProNature Fresh Mint\",\n \"brand\":376,\n \"category\":49,\n \"manufacturer\":6,\n \"size_x_mm\":125,\n \"size_y_mm\":176,\n \"size_z_mm\":50\n}", "language": "200", "customLabel": "" } ], "selectedLanguageId": "dU9xR9j8Bu4jftmV8BprY" }, "examples": { "languages": [ { "id": "N8QhhTSDO9fbQybTRclDg", "code": "curl –i –X GET\n https://test.eyrene.com/api/v1.5/sku/?cid=9000101421 \n -H ‘Authorization: Token 39fbb6e9-fbf9-459a-9e1b-416dbcf51875e’", "language": "curl", "customLabel": "" } ], "selectedLanguageId": "N8QhhTSDO9fbQybTRclDg" }, "description": "GET /sku/?cid={cid}", "currentNewParameter": { "label": "Header Parameter", "value": "headerParameters" }, "autoGeneratedAnchorSlug": "request-example-5", "legacyHash": "CNIU13-1XooHuv-85M4XF" } ``` ::: ## 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](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/upload/uploads) or [/uploads\_by\_url](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/upload/uploads_by_url). *** **`name`** *string* Human readable SKU name. *** **`brand`** *string*[](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/sku/brand) [Brand](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/sku/brand) ID. *** **`category`** *string*[](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/sku/categories) [Category](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/sku/categories) ID. *** **`manufacturer`** *string*[](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/sku/monofacturers) [Manufacturer](https://help.inspector-cloud.com/en/docs/api/backend/methods/v1.5/sku/monofacturers) 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. *** :::: ***