Last Updated Aug 19, 2025

Query Colourway

get
/api/inventory/products/colourway

Retrieves detailed information about a specific colourway, including its attributes, stock levels, pricing, and related components.

Request

Field Description
colourway_id [integer] Fetch colourway by its Colourway ID.

 


GET /api/inventory/product/colourway?colourway_id=163 HTTP/1.1
Host: yourcompany.intend.com
api-key: your_api_key_here

Response

A successful request returns HTTP 200 and a JSON response body with colourway data.

Field Description
id [integer] Colourway ID.
code [string] Unique code for the colourway.
name [string] Colourway name.
full_name [string] Full name including product and colourway.
images

[array] Colourway image details (see images object below).
feature_in_website [boolean] Whether the colourway is featured on the website (1 = yes, 0 = no).
created_on [string] Creation date.
updated_on [string] Last updated date.
is_saleable [boolean] Whether the colourway is available for sale (1 = yes, 0 = no).
is_discontinued [boolean] Whether the colourway is discontinued (1 = yes, 0 = no).
discontinued_on [string] Date colourway was discontinued on.
attributes [object] Colourway attributes as defined by Intend, with keys representing attribute names and values as arrays of attribute options. Examples: Composition, Country Of Origin, Useage, Colour, Style, etc.
taxonomies

[object] List of colourway attributes (see taxonomies object below).
stock

[object] Stock availability details (see stock object below).
incoming_stock [array] List of incoming stock details.
prices

[array] Price details for different price types (see prices object below).
components

[array] List of components used in the colourway (see components object below).
type

[string] Product type.

ANTIQUE Single-piece product, no inventory.
GENERAL Products with SKUs.
SAMPLE Sample of a product (e.g., fabric, wallpaper, rug, etc.)
COMPONENT Part or material used to make a product (e.g., fabric, feathers, trimmings for a cushion).
mode

[string] Indicates whether the item is a product or a service.

Product (P) A tangible item that can be sold, stocked, and shipped.
Service (S) An intangible offering, such as handling fees, rug stain treatments, etc.
brand [string] Brand name.
product_id [integer] Parent product ID.
category

[object] Category details (see category object below).
description [string] Colourway description.
selling_unit [string] Selling unit (e.g., Metre).
selling_unit_sm [string] Abbreviation of selling unit.
purchasing_unit [string] Purchasing unit.
purchasing_unit_sm [string] Abbreviation of purchasing unit.
website_category_id [integer] ID of website category.
directly_supplied [boolean] Direct supply flag (1 = yes, 0 = no).
launched_on [string] Launch date.
tax_applicable [boolean] Tax applicability (1 = yes, 0 = no).
tax_ref

[object] Tax reference details (see tax_ref object below).
minimum_order_quantity [string] Minimum quantity allowed per order.
dimension

[object] Colourway dimensions (see dimension object below).
package

[object] Shipping-related details for the colourway (see package object below).

images object

Field Description
file [string] Filename of the image.
url [string] URL of the image.

taxonomies object

Field Description
Lead Time [integer] Lead time in days.
Pattern Repeat [string] Pattern repeat information.
Vertical Repeat [string] Vertical repeat measurement.
Horizontal Repeat [string] Horizontal repeat measurement.
Rub Test [string] Rub test rating.
Fire Code [string] Fire safety code.
Harmonisation Code [string] Harmonisation code for customs.
Cigarette Test [string] Cigarette test result.
Half-drop repeat [string] Half-drop repeat measurement.

stock object

Field Description
in_stock [float] Quantity in stock
reserved [float] Quantity reserved.
allocated [integer] Quantity allocated.
availabe [float] Quantity available.

prices object

Field Description
type [string] Price type (Retail, Trade).
id [integer] Price ID.
base_inclusive_tax [boolean] Flag if price includes tax (0 = No, 1 = Yes).
GBP [float] Price in Pounds.
EUR [float] Price in Euros.
USD [float] Price in US Dollars.

components object

Field Description
id [integer] Component ID.
name [string] Component name.
code [string] Component code.
component_quantity [float] Quantity of the component.
selling_unit [string] Unit used for selling the component.
selling_unit_sm [string] Short form of the selling unit.

category object

Field Description
id [integer] Category ID.
name [string] Category name.

tax_ref object

Field Description
code [string] Tax code.
value [integer] Tax percentage value.

dimension object

Field Description
height [float] Height measurement.
width [float] Width measurement.
depth [float] Depth measurement.
unit [string] Unit of measurement for dimensions.
weight [float] Weight value.
weight_unit [string] Unit of measurement for weight.

package object

Field Description
shipping_category [string] Shipping category name.

 


{
   "status": 200,
   "response": true,
   "data": {
       "id": 6,
       "code": "ABC0478",
       "name": "Duck Egg",
       "full_name": "Agusta - Duck Egg",
       "images": [
           {
               "file": "1721886139-1550212438-4481-1-1.webp",
               "url": "https://example.com/storage/uploads/products/1721886139-1550212438-4481-1-1.webp"
           },
           {
               "file": "1721886175-1687501435-1550212438-4481-1-1.webp",
               "url": "https://example.com/storage/uploads/products/1721886175-1687501435-1550212438-4481-1-1.webp"
           }
       ],
       "feature_in_website": null,
       "created_on": "2018-12-12T16:24:26.000000Z",
       "updated_on": "2024-09-23T20:42:09.000000Z",
       "is_saleable": 1,
       "is_discontinued": 0,
       "discontinued_on": "",
       "attributes": {
           "Style": [
               "Textured Plain"
           ],
           "Colour": [
               "Duck Egg"
           ],
           "Uses": [
               "Curtains",
               "Blinds",
               "Upholstery, Soft Furnishings"
           ],
           "Composition": [
               "46% Viscose",
               "38% Cotton",
               "16% Flax"
           ],
           "Type": [
               "Cotton"
           ]
       },
       "taxonomies": {
           "Lead Time": null,
           "Pattern Repeat": "",
           "Repeat": "11",
           "Horizontal Repeat": "140",
           "Harmonisation Code": "540-00123456",
           "Fire Code": "N",
           "Rub Test": "13000",
           "Cigarette Test": "PASS"
       },
       "stock": {
           "in_stock": 325.7,
           "reserved": 177.11,
           "allocated": 104.25,
           "available": 221.45
       },
       "incoming_stock": [
           {
               "purchase_order": "PO000064",
               "order_quantity": 25,
               "available_quantity": 25,
               "stock_available_date": "2024-11-07 10:21:27",
               "eta_warehouse": null
           }
       ],
       "prices": [
           {
               "type": "Retail",
               "id": 1,
               "base_inclusive_tax": 0,
               "GBP": 127.5,
               "EUR": 133.28,
               "USD": 136.03
           },
           {
               "type": "Trade",
               "id": 2,
               "base_inclusive_tax": 0,
               "GBP": 120.63,
               "EUR": 124.96,
               "USD": 127.02
           }
       ],
       "components": [
           {
               "id": 11,
               "name": "Linen Cloth",
               "code": "LIN16C",
               "component_quantity": 1,
               "selling_unit": "Metre",
               "selling_unit_sm": "m"
           },
           {
               "id": 10,
               "name": "Colour Printing",
               "code": "PRSRV-01",
               "component_quantity": 1,
               "selling_unit": "Piece",
               "selling_unit_sm": "pc"
           }
       ],
       "type": "general",
       "mode": "product",
       "brand": null,
       "product_id": 2,
       "category": {
           "id": 1,
           "name": "Fabrics"
       },
       "description": "Agusta fabric is the epitome. . .",
       "selling_unit": "Metre",
       "selling_unit_sm": "m",
       "purchasing_unit": "Metre",
       "purchasing_unit_sm": "m",
       "website_category_id": 1,
       "directly_supplied": 0,
       "launched_on": "2022-09-15T00:00:00.000000Z",
       "tax_applicable": 1,
       "tax_ref": {
           "code": "T1",
           "value": 20
       },
       "minimum_order_quantity": "1.00",
       "dimension": {
           "height": 0,
           "width": 140,
           "depth": 0,
           "unit": "cm",
           "weight": 450,
           "weight_unit": "gm"
       },
       "package": {
           "shipping_category": "Standard"
       }
   },
   "msg": "Request Successful"
}