List SKUs - UMG-UK

Request

Path Params

businessUnitId

string

required

Query Params

sortField

enum<string>

optional

Field to sort by

Allowed values:

skuIdupcnamedescription

Default:

skuId

sortDirection

enum<string>

optional

Direction in which to sort the sortField

Allowed values:

ASCDESC

Default:

ASC

offset

integer

optional

This offsets the start of each page by the number specified.

Default:

0

limit

integer

optional

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit due to filtering.

Default:

100

skuId

string

optional

Filter to orders where skuId begins with this string.

upc

string

optional

Filter to orders where upc begins with this string.

name

string

optional

Filter to orders where name begins with this string.

description

string

optional

Filter to orders where description begins with this string.

active

boolean

optional

If present, filter results by active or inactive status. Otherwise, return both.

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200List of SKUs returned succesfully. If there are no results, the data array will be empty. All SKU attributes are returned for each item in the list.

application/json

Body

data

array[object (SkuSummary) {5}]

required

skuId

string

optional

<= 30 characters

name

string

optional

<= 255 characters

description

string

optional

upc

string

optional

<= 25 characters

active

boolean

optional

Example

{
    "data": [
        {
            "skuId": "string",
            "name": "string",
            "description": "string",
            "upc": "string",
            "active": true
        }
    ]
}

🟠404Business Unit not found

🔴500Internal Server Error