COMMERCE QUERY
/
Query API 3.0
/
Application
/
List client price list types

Commerce Query API (v3.0)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Playground

https://{slug}.api-se.playground.norce.tech/commerce/query/3.0/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/query/3.0/

Production

https://{slug}.api-se.norce.tech/commerce/query/3.0/

Schemas

Application

Operations

List client SKU types

Request

Gets all client SKU types.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/query/3.0/Application/ClientSkuTypes \
  -H 'ApplicationId: 0'

Responses

A queryable collection of client SKU types. Called product types in admin.

Bodyapplication/jsonArray [
typeIdinteger(int32)

The type identifier.

namestring or null[ 0 .. 50 ] characters

The name of the client product sku type for the client.

descriptionstring or null[ 0 .. 500 ] characters

The description of the client product sku type for the client.

sortOrderinteger or null(int32)

The sort order for display purposes.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

culturesArray of objects or null(ClientProductSkuTypeCulture)
]
Response
application/json
[
  {
    "typeId": 0,
    "name": "string",
    "description": "string",
    "sortOrder": 0,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "cultures": [ … ]
  }
]

List client price list types

Request

Gets all client price list types.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/query/3.0/Application/PriceListTypes \
  -H 'ApplicationId: 0'

Responses

A queryable collection of client price list types.

Bodyapplication/jsonArray [
typeIdinteger(int32)

The price list type identifier.

codestring or null[ 0 .. 50 ] characters

The code of the price list type.

sortOrderinteger(int32)

The sort order of the price list type.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

priorityinteger or null(int32)

The priority of the price list type, used by best price calculation when the UsePriceListPriority client setting is enabled.

defaultNamestring or null[ 0 .. 50 ] characters

The default name of the price list type.

defaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the price list type.

apiEditableboolean or null

Whether the price list type is editable through the API.

culturesArray of objects or null(PriceListTypeCulture)
]
Response
application/json
[
  {
    "typeId": 0,
    "code": "string",
    "sortOrder": 0,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "priority": 0,
    "defaultName": "string",
    "defaultDescription": "string",
    "apiEditable": true,
    "cultures": [ … ]
  }
]

Get client price list type

Request

Gets a single client price list type by its identifier.

Path
idinteger(int32)required

The price list type identifier.

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  'https://customer-slug.api-se.playground.norce.tech/commerce/query/3.0/Application/PriceListTypes({id})' \
  -H 'ApplicationId: 0'

Responses

A single client price list type matching the specified identifier.

Bodyapplication/json
queryableArray of objects or null
Response
application/json
{
  "queryable": [
    { … }
  ]
}

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations