catalog

Get All Catalog Bundles

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
query Parameters
format
string
Enum: "csv" "json"
order_by
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

search
string

A search term.

Responses
200
Response Schema:
object
Array of objects (CatalogItemBundleRead)
get/api/v3/catalog-bundles/
Response samples
{
  • "metadata": {
    },
  • "data": [
    ]
}

Get All Catalog Items

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
query Parameters
bundle
integer
department
string

A comma-separated list of integers.

format
string
Enum: "csv" "json"
internalSKU
string
location
string

A comma-separated list of integers.

max_price
number
min_price
number
order_by
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

pref_vendor
integer
search
string

A search term.

Responses
200
Response Schema:
object
Array of objects (CatalogItemRead)
get/api/v3/catalog-items/
Response samples
{
  • "metadata": {
    },
  • "data": [
    ]
}

Create Catalog Item

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
query Parameters
format
string
Enum: "csv" "json"
Request Body schema:
required
id
integer
name
required
string [ 1 .. 255 ] characters
image
string
unitType
string <= 30 characters
pref_vendor
integer or null
account_code
integer or null
internalSKU
string <= 50 characters
description
string or null
product_url
string or null
currency
required
integer
price
string <decimal> ^-?\d{0,13}(?:\.\d{0,8})?$
rfo_lock
boolean
departments
Array of integers
required
Array of objects
Responses
201
Response Schema:
object
Default: {}
required
object (CatalogItemRead)
post/api/v3/catalog-items/
Request samples
{
  • "id": 0,
  • "name": "string",
  • "image": "string",
  • "unitType": "string",
  • "pref_vendor": 0,
  • "account_code": 0,
  • "internalSKU": "string",
  • "description": "string",
  • "product_url": "string",
  • "currency": 0,
  • "price": "string",
  • "rfo_lock": true,
  • "departments": [
    ],
  • "custom_fields": [
    ]
}
Response samples
{
  • "metadata": { },
  • "data": {
    }
}

Update Catalog Item

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
path Parameters
id
required
integer

A unique integer value identifying this catalog items.

query Parameters
format
string
Enum: "csv" "json"
Request Body schema:
required
id
integer
name
required
string [ 1 .. 255 ] characters
image
string
unitType
string <= 30 characters
pref_vendor
integer or null
account_code
integer or null
internalSKU
string <= 50 characters
description
string or null
product_url
string or null
currency
required
integer
price
string <decimal> ^-?\d{0,13}(?:\.\d{0,8})?$
rfo_lock
boolean
departments
Array of integers
required
Array of objects
Responses
200
Response Schema:
object
Default: {}
required
object (CatalogItemRead)
put/api/v3/catalog-items/{id}/
Request samples
{
  • "id": 0,
  • "name": "string",
  • "image": "string",
  • "unitType": "string",
  • "pref_vendor": 0,
  • "account_code": 0,
  • "internalSKU": "string",
  • "description": "string",
  • "product_url": "string",
  • "currency": 0,
  • "price": "string",
  • "rfo_lock": true,
  • "departments": [
    ],
  • "custom_fields": [
    ]
}
Response samples
{
  • "metadata": { },
  • "data": {
    }
}