COMMERCE QUERY
/
Query API 3.0
/
Application
/
Get client supplier

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 suppliers

Request

Gets all client suppliers.

Headers
ApplicationIdintegerrequired

Application ID

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

Responses

A queryable collection of client suppliers.

Bodyapplication/jsonArray [
supplierIdinteger(int32)

The supplier identifier.

supplierCodePrefixstring or null[ 0 .. 10 ] characters

The supplier code prefix, not used anymore.

supplierCodestring or null[ 0 .. 50 ] characters

The supplier code.

namestring or null[ 0 .. 100 ] characters

The name of the client supplier.

isActiveboolean

Indicates whether the client supplier is active.

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.

infosArray of objects or null(ClientSupplierInfo)
warehousesArray of objects or null(ClientSupplierWarehouse)
warehouseLocationsArray of objects or null(ClientSupplierWarehouseLocation)
supplier(Supplier (object or null))
One of:
]
Response
application/json
[
  {
    "supplierId": 0,
    "supplierCodePrefix": "string",
    "supplierCode": "string",
    "name": "string",
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "infos": [ … ],
    "warehouses": [ … ],
    "warehouseLocations": [ … ],
    "supplier": { … }
  }
]

Get client supplier

Request

Gets a single client supplier by its identifier.

Path
idinteger(int32)required

The supplier identifier.

Headers
ApplicationIdintegerrequired

Application ID

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

Responses

A single client supplier matching the specified identifier.

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

List client warehouses

Request

Gets all client warehouses.

Headers
ApplicationIdintegerrequired

Application ID

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

Responses

A queryable collection of client warehouses.

Bodyapplication/jsonArray [
warehouseIdinteger(int32)

The warehouse identifier.

typeIdinteger(int32)

The type identifier, Warehouse (1), Store (2), Transport (3), Other (4).

codestring or null[ 0 .. 50 ] characters

The code of the client warehouse.

namestring or null[ 0 .. 50 ] characters

The name of the client warehouse.

isStandardboolean

Indicates whether the client warehouse is standard, only one standard warehouse is allowed per client.

standardLeadTimeDayCountinteger or null(int32)

The standard lead time day count, used for calculating the expected delivery time.

freightCostnumber or null(decimal)

The freight cost, not used anymore.

costBlockinteger or null(int32)

The cost block, not used anymore.

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.

locationsArray of objects or null(ClientWarehouseLocation)
]
Response
application/json
[
  {
    "warehouseId": 0,
    "typeId": 0,
    "code": "string",
    "name": "string",
    "isStandard": true,
    "standardLeadTimeDayCount": 0,
    "freightCost": 0,
    "costBlock": 0,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "locations": [ … ]
  }
]

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations