MANAGEMENT API
/
Settings ClientSalesArea
/
List client sales areas

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

Get client sales area

Request

Get a specific sales area assigned to the client by its unique internal Norce Id

Path
idinteger(int32)required

Client sales area 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/client/salesarea/{id}' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Bodyapplication/json
Idinteger(int32)required

The sales area identifier.

Namestring or null[ 0 .. 255 ] characters

The name of the sales area.

Codestring or null[ 0 .. 50 ] characters

The code of the sales area.

IsPrimarybooleanrequired

Indicates whether this is the primary sales area for the client.

VatCodesArray of objects or null(ClientSalesAreaVatCodeModel)

The collection of VAT codes associated with this sales area for the client.

PrimaryVatCodeIdinteger(int32)required

The identifier of the primary VAT code for this sales area.

Changedstring or null

The date and time when the ClientSalesArea entity was last changed.

ChangedBystring or null

The name of the user who last changed the ClientSalesArea entity.

Response
application/json
{
  "Id": 0,
  "Name": "string",
  "Code": "string",
  "IsPrimary": true,
  "VatCodes": [
    { … }
  ],
  "PrimaryVatCodeId": 0,
  "Changed": "string",
  "ChangedBy": "string"
}

Update client sales area

Request

Update an existing client sales area

Path
idinteger(int32)required

Id of the sales area to update

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Updated client sales area data

Idinteger(int32)required

The sales area identifier.

Namestring or null[ 0 .. 255 ] characters

The name of the sales area.

Codestring or null[ 0 .. 50 ] characters

The code of the sales area.

IsPrimarybooleanrequired

Indicates whether this is the primary sales area for the client.

VatCodesArray of objects or null(ClientSalesAreaVatCodeModel)

The collection of VAT codes associated with this sales area for the client.

PrimaryVatCodeIdinteger(int32)required

The identifier of the primary VAT code for this sales area.

Changedstring or null

The date and time when the ClientSalesArea entity was last changed.

ChangedBystring or null

The name of the user who last changed the ClientSalesArea entity.

curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/client/salesarea/{id}' \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "Name": "string",
    "Code": "string",
    "IsPrimary": true,
    "VatCodes": [
      {
        "Id": 0,
        "Name": "string",
        "Value": 0
      }
    ],
    "PrimaryVatCodeId": 0,
    "Changed": "string",
    "ChangedBy": "string"
  }'

Responses

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

List client sales areas

Request

Get a list of all client sales areas assigned to 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/client/salesarea \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of client sales areas, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)required

The sales area identifier.

Namestring or null[ 0 .. 255 ] characters

The name of the sales area.

Codestring or null[ 0 .. 50 ] characters

The code of the sales area.

IsPrimarybooleanrequired

Indicates whether this is the primary sales area for the client.

VatCodesArray of objects or null(ClientSalesAreaVatCodeModel)

The collection of VAT codes associated with this sales area for the client.

PrimaryVatCodeIdinteger(int32)required

The identifier of the primary VAT code for this sales area.

Changedstring or null

The date and time when the ClientSalesArea entity was last changed.

ChangedBystring or null

The name of the user who last changed the ClientSalesArea entity.

]
Response
application/json
[
  {
    "Id": 0,
    "Name": "string",
    "Code": "string",
    "IsPrimary": true,
    "VatCodes": [ … ],
    "PrimaryVatCodeId": 0,
    "Changed": "string",
    "ChangedBy": "string"
  }
]

Add sales area to the client

Request

Add a new sales area to the client from a predefined list of sales areas from Norce

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Client sales area to add

Idinteger(int32)required

The sales area identifier.

Namestring or null[ 0 .. 255 ] characters

The name of the sales area.

Codestring or null[ 0 .. 50 ] characters

The code of the sales area.

IsPrimarybooleanrequired

Indicates whether this is the primary sales area for the client.

VatCodesArray of objects or null(ClientSalesAreaVatCodeModel)

The collection of VAT codes associated with this sales area for the client.

PrimaryVatCodeIdinteger(int32)required

The identifier of the primary VAT code for this sales area.

Changedstring or null

The date and time when the ClientSalesArea entity was last changed.

ChangedBystring or null

The name of the user who last changed the ClientSalesArea entity.

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/client/salesarea \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "Name": "string",
    "Code": "string",
    "IsPrimary": true,
    "VatCodes": [
      {
        "Id": 0,
        "Name": "string",
        "Value": 0
      }
    ],
    "PrimaryVatCodeId": 0,
    "Changed": "string",
    "ChangedBy": "string"
  }'

Responses

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

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