COMMERCE QUERY
/
Query API 3.0
/
Application
/
Gets all product families.

Query (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://norcecommerce.api-se.norce.tech/commerce/query/3.0/

Schemas

Application

Operations

Gets all client warehouses.

Request

Headers
ApplicationIdintegerrequired

Application ID

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

Responses

A queryable collection of client warehouses.

Bodyapplication/jsonArray [
clientIdinteger(int32)

The client identifier.

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)
warehouse(Warehouse (object or null))
One of:
]
Response
application/json
[
  {
    "clientId": 0,
    "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": [ … ],
    "warehouse": { … }
  }
]

Gets all product families.

Request

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Application/Families \
  -H 'ApplicationId: 0'

Responses

A queryable collection of product families.

Bodyapplication/jsonArray [
idinteger(int32)

The unique identifier of the productfamily.

clientIdinteger(int32)

The client identifier.

codestring or null[ 0 .. 50 ] characters

The code of the product family.

defaultNamestring[ 0 .. 50 ] charactersrequired

The default name of the product family.

defaultDescriptionstring or null

The default description of the product family.

defaultImagePathstring or null[ 0 .. 255 ] characters

The default image path, not used anymore.

defaultThumbnailImagePathstring or null[ 0 .. 255 ] characters

The default thumbnail image path, not used anymore.

defaultCampaignImagePathstring or null[ 0 .. 255 ] characters

The default campaign image path, not used anymore.

defaultLargeImagePathstring or null[ 0 .. 255 ] characters

The default large image path, not used anymore.

isActiveboolean

Indicates whether the product family 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.

imageKeystring or null(guid)

The image key.

culturesArray of objects or null(FamilyCulture)
productFamilyArray of objects or null(ProductFamily)
]
Response
application/json
[
  {
    "id": 0,
    "clientId": 0,
    "code": "string",
    "defaultName": "string",
    "defaultDescription": "string",
    "defaultImagePath": "string",
    "defaultThumbnailImagePath": "string",
    "defaultCampaignImagePath": "string",
    "defaultLargeImagePath": "string",
    "isActive": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "imageKey": "string",
    "cultures": [ … ],
    "productFamily": [ … ]
  }
]

Gets all file info records.

Request

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Application/FileInfos \
  -H 'ApplicationId: 0'

Responses

A queryable collection of file info records and client-configured file and image types; these are called file types in the admin, Connect, and Commerce services.

Bodyapplication/jsonArray [
fileIdinteger(int32)

The file type identifier.

clientIdinteger(int32)

The client identifier.

codestring or null[ 0 .. 50 ] characters

The code of the file type.

sortOrderinteger or null(int32)

The sort order for display purposes.

updatedstring(date-time)

The date and time the record was last updated.

updatedByinteger(int32)

The identifier of the user who last updated the record.

]
Response
application/json
[
  {
    "fileId": 0,
    "clientId": 0,
    "code": "string",
    "sortOrder": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0
  }
]

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations