Product Warehouse
/
Update a warehouse

Management API (v1)

The Norce Management API lets you manage configurations and metadata on a client.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/

Schemas

Settings ApplicationCountry

Operations

Settings ApplicationCulture

Operations

Settings ApplicationCurrency

Operations

Settings ApplicationSalesArea

Operations

Settings Application

Operations

Category

Operations

CategoryParametric

Operations

Settings ClientAssortment

Operations

Settings ClientCurrency

Operations

Settings ClientSalesArea

Operations

Customer FlagGroup

Operations

Customer Flag

Operations

Customer InfoType

Operations

Product Family

Operations

Product File

Operations

Product Manufacturer

Operations

Parametric Group

Operations

Parametric List

Operations

Parametric Multiple

Operations

Parametric

Operations

PriceList Population

Operations

PriceList Pricing

Operations

PriceList

Operations

PriceList SupplierPriceList

Operations

PriceList Warehouse

Operations

Product FlagGroup

Operations

Product Flag

Operations

Product InfoType

Operations

Product Type

Operations

Promotion

Operations

Product RelationType

Operations

PriceList RoundingRule

Operations

Shopping InfoType

Operations

Store Application

Operations

Store PriceList

Operations

Store

Operations

Store Warehouse

Operations

Supplier PriceList

Operations

Supplier PriceListWarehouse

Operations

Supplier

Operations

Supplier Warehouse

Operations

Supplier WarehouseLocation

Operations

Product VariantGroup

Operations

Product WarehouseLocation

Operations

Product Warehouse

Operations

Get a warehouse

Request

Get a specific warehouse by its internal id

Path
idinteger(int32)required

Warehouse id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

curl -i -X GET \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/warehouse/{id}' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the Warehouse

Bodyapplication/json
Idinteger(int32)

The warehouse identifier

TypeIdinteger(int32)

The warehouse type identifier, see WarehouseTypeModel

TypeNamestring or null

The name of the warehouse type

Codestring or null

The warehouse code, must be unique for the client setup.

Namestring or null[ 0 .. 50 ] characters

The name of the warehouse in the current culture

LocationsArray of objects(WarehouseLocationModel)

The list of locations associated with this warehouse

LocationIdinteger or null(int32)

The first or default location identifier for this warehouse

LocationNamestring or null

The name of the first or default location for this warehouse

IsStandardboolean

Indicates whether this is a standard warehouse, only one warehouse can be marked as standard for a client.

StandardLeadTimeDayCountinteger or null(int32)

The standard lead time in commonly measured in days for this warehouse

IsActiveboolean

Indicates whether the warehouse is active

Changedstring or null

The date and time when the warehouse was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the warehouse

Response
application/json
{
  "Id": 0,
  "TypeId": 0,
  "TypeName": "string",
  "Code": "string",
  "Name": "string",
  "Locations": [
    { … }
  ],
  "LocationId": 0,
  "LocationName": "string",
  "IsStandard": true,
  "StandardLeadTimeDayCount": 0,
  "IsActive": true,
  "Changed": "string",
  "ChangedBy": "string"
}

Update a warehouse

Request

Update a specific warehouse by its internal id

Path
idinteger(int32)required

Warehouse id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Warehouse

Idinteger(int32)

The warehouse identifier

TypeIdinteger(int32)

The warehouse type identifier, see WarehouseTypeModel

TypeNamestring or null

The name of the warehouse type

Codestring or null

The warehouse code, must be unique for the client setup.

Namestring or null[ 0 .. 50 ] characters

The name of the warehouse in the current culture

LocationsArray of objects(WarehouseLocationModel)

The list of locations associated with this warehouse

LocationIdinteger or null(int32)

The first or default location identifier for this warehouse

LocationNamestring or null

The name of the first or default location for this warehouse

IsStandardboolean

Indicates whether this is a standard warehouse, only one warehouse can be marked as standard for a client.

StandardLeadTimeDayCountinteger or null(int32)

The standard lead time in commonly measured in days for this warehouse

IsActiveboolean

Indicates whether the warehouse is active

Changedstring or null

The date and time when the warehouse was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the warehouse

curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/warehouse/{id}' \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "TypeId": 0,
    "TypeName": "string",
    "Code": "string",
    "Name": "string",
    "Locations": [
      {
        "Id": 0,
        "Code": "string",
        "Name": "string",
        "IsStandard": true,
        "StandardLeadTimeDayCount": 0,
        "IsIncludedInStockCalculation": true,
        "PrimaryPriceListId": 0,
        "PrimaryPriceListName": "string",
        "Changed": "string",
        "ChangedBy": "string"
      }
    ],
    "LocationId": 0,
    "LocationName": "string",
    "IsStandard": true,
    "StandardLeadTimeDayCount": 0,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string"
  }'

Responses

If the warehouse was successfully updated

Bodyapplication/json
integer(int32)
Response
application/json
0

List active warehouses

Request

Get a list of all active warehouses on the client

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/warehouse \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of active warehouses

Bodyapplication/jsonArray [
Idinteger(int32)

The warehouse identifier

TypeIdinteger(int32)

The warehouse type identifier, see WarehouseTypeModel

TypeNamestring or null

The name of the warehouse type

Codestring or null

The warehouse code, must be unique for the client setup.

Namestring or null[ 0 .. 50 ] characters

The name of the warehouse in the current culture

LocationsArray of objects(WarehouseLocationModel)

The list of locations associated with this warehouse

LocationIdinteger or null(int32)

The first or default location identifier for this warehouse

LocationNamestring or null

The name of the first or default location for this warehouse

IsStandardboolean

Indicates whether this is a standard warehouse, only one warehouse can be marked as standard for a client.

StandardLeadTimeDayCountinteger or null(int32)

The standard lead time in commonly measured in days for this warehouse

IsActiveboolean

Indicates whether the warehouse is active

Changedstring or null

The date and time when the warehouse was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the warehouse

]
Response
application/json
[
  {
    "Id": 0,
    "TypeId": 0,
    "TypeName": "string",
    "Code": "string",
    "Name": "string",
    "Locations": [ … ],
    "LocationId": 0,
    "LocationName": "string",
    "IsStandard": true,
    "StandardLeadTimeDayCount": 0,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string"
  }
]

Add a warehouse

Request

Add a new warehouse to the client

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Warehouse

Idinteger(int32)

The warehouse identifier

TypeIdinteger(int32)

The warehouse type identifier, see WarehouseTypeModel

TypeNamestring or null

The name of the warehouse type

Codestring or null

The warehouse code, must be unique for the client setup.

Namestring or null[ 0 .. 50 ] characters

The name of the warehouse in the current culture

LocationsArray of objects(WarehouseLocationModel)

The list of locations associated with this warehouse

LocationIdinteger or null(int32)

The first or default location identifier for this warehouse

LocationNamestring or null

The name of the first or default location for this warehouse

IsStandardboolean

Indicates whether this is a standard warehouse, only one warehouse can be marked as standard for a client.

StandardLeadTimeDayCountinteger or null(int32)

The standard lead time in commonly measured in days for this warehouse

IsActiveboolean

Indicates whether the warehouse is active

Changedstring or null

The date and time when the warehouse was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the warehouse

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/warehouse \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "TypeId": 0,
    "TypeName": "string",
    "Code": "string",
    "Name": "string",
    "Locations": [
      {
        "Id": 0,
        "Code": "string",
        "Name": "string",
        "IsStandard": true,
        "StandardLeadTimeDayCount": 0,
        "IsIncludedInStockCalculation": true,
        "PrimaryPriceListId": 0,
        "PrimaryPriceListName": "string",
        "Changed": "string",
        "ChangedBy": "string"
      }
    ],
    "LocationId": 0,
    "LocationName": "string",
    "IsStandard": true,
    "StandardLeadTimeDayCount": 0,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string"
  }'

Responses

If the warehouse was successfully added

Bodyapplication/json
integer(int32)
Response
application/json
0

List deleted warehouses

Request

Get a list of all deleted warehouses on the client, update a deleted supplier warehouse with IsActive = true to activate it again

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/warehouse/deleted \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of deleted warehouses

Bodyapplication/jsonArray [
Idinteger(int32)

The warehouse identifier

TypeIdinteger(int32)

The warehouse type identifier, see WarehouseTypeModel

TypeNamestring or null

The name of the warehouse type

Codestring or null

The warehouse code, must be unique for the client setup.

Namestring or null[ 0 .. 50 ] characters

The name of the warehouse in the current culture

LocationsArray of objects(WarehouseLocationModel)

The list of locations associated with this warehouse

LocationIdinteger or null(int32)

The first or default location identifier for this warehouse

LocationNamestring or null

The name of the first or default location for this warehouse

IsStandardboolean

Indicates whether this is a standard warehouse, only one warehouse can be marked as standard for a client.

StandardLeadTimeDayCountinteger or null(int32)

The standard lead time in commonly measured in days for this warehouse

IsActiveboolean

Indicates whether the warehouse is active

Changedstring or null

The date and time when the warehouse was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the warehouse

]
Response
application/json
[
  {
    "Id": 0,
    "TypeId": 0,
    "TypeName": "string",
    "Code": "string",
    "Name": "string",
    "Locations": [ … ],
    "LocationId": 0,
    "LocationName": "string",
    "IsStandard": true,
    "StandardLeadTimeDayCount": 0,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string"
  }
]