MANAGEMENT API
/
Customer Flag
/
Create a customer or company flag

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

Get customer or company flag

Request

Get a specific customer or company flag by its internal id

Path
idinteger(int32)required

Flag 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/customer/flag/{id}' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the CustomerFlag

Bodyapplication/json
Idinteger(int32)

Internal identifier for the customer flag. Client-specific.

Codestring or null[ 0 .. 50 ] characters

External reference code for the customer flag, used for integration purposes.

GroupIdinteger(int32)

The identifier of the group this customer flag belongs to.

GroupNamestring or null

The name of the group this customer flag belongs to.

Namestring or null[ 0 .. 50 ] characters

The customer flag name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The customer flag name for the default language.

IsNameInheritedboolean

If true, the specific language doesn't have its own name and instead inherits from the default name.

Descriptionstring or null[ 0 .. 500 ] characters

A longer description for the customer flag explaining it in more detail.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The customer flag description in the default language.

IsDescriptionInheritedboolean

If true, the description is inherited from the default language rather than being its own text.

AvailableOnCustomerboolean

Indicates whether this flag can be assigned to customers.

AvailableOnCompanyboolean

Indicates whether this flag can be assigned to companies.

IsActiveboolean

False if the customer flag is soft deleted, removes it from the admin interface and non-functional but easily reactivatable.

Changedstring or null

The date and time when the customer flag entity was last changed.

ChangedBystring or null

The name of the user who last changed the customer flag entity, null if never changed.

IsDefaultboolean

Indicates whether this is a system default flag that cannot be deleted.

SortOrderinteger or null(int32)

The sort order for displaying this flag in lists and interfaces.

CulturesArray of objects(CustomerFlagCultureModel)

List of all culture-specific text fields for the customer flag.

Response
application/json
{
  "Id": 0,
  "Code": "string",
  "GroupId": 0,
  "GroupName": "string",
  "Name": "string",
  "DefaultName": "string",
  "IsNameInherited": true,
  "Description": "string",
  "DefaultDescription": "string",
  "IsDescriptionInherited": true,
  "AvailableOnCustomer": true,
  "AvailableOnCompany": true,
  "IsActive": true,
  "Changed": "string",
  "ChangedBy": "string",
  "IsDefault": true,
  "SortOrder": 0,
  "Cultures": [
    { … }
  ]
}

Update customer or company flag

Request

Update an existing customer or company flag on the client

Path
idinteger(int32)required

Flag id to update

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Flag to update

Idinteger(int32)

Internal identifier for the customer flag. Client-specific.

Codestring or null[ 0 .. 50 ] characters

External reference code for the customer flag, used for integration purposes.

GroupIdinteger(int32)

The identifier of the group this customer flag belongs to.

GroupNamestring or null

The name of the group this customer flag belongs to.

Namestring or null[ 0 .. 50 ] characters

The customer flag name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The customer flag name for the default language.

IsNameInheritedboolean

If true, the specific language doesn't have its own name and instead inherits from the default name.

Descriptionstring or null[ 0 .. 500 ] characters

A longer description for the customer flag explaining it in more detail.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The customer flag description in the default language.

IsDescriptionInheritedboolean

If true, the description is inherited from the default language rather than being its own text.

AvailableOnCustomerboolean

Indicates whether this flag can be assigned to customers.

AvailableOnCompanyboolean

Indicates whether this flag can be assigned to companies.

IsActiveboolean

False if the customer flag is soft deleted, removes it from the admin interface and non-functional but easily reactivatable.

Changedstring or null

The date and time when the customer flag entity was last changed.

ChangedBystring or null

The name of the user who last changed the customer flag entity, null if never changed.

IsDefaultboolean

Indicates whether this is a system default flag that cannot be deleted.

SortOrderinteger or null(int32)

The sort order for displaying this flag in lists and interfaces.

CulturesArray of objects(CustomerFlagCultureModel)

List of all culture-specific text fields for the customer flag.

curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/customer/flag/{id}' \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "Code": "string",
    "GroupId": 0,
    "GroupName": "string",
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "AvailableOnCustomer": true,
    "AvailableOnCompany": true,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string",
    "IsDefault": true,
    "SortOrder": 0,
    "Cultures": [
      {
        "CultureCode": "string",
        "IsTranslated": true,
        "Name": "string",
        "IsNameInherited": true,
        "Description": "string",
        "IsDescriptionInherited": true
      }
    ]
  }'

Responses

If the customer or company flag was successfully updated

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

List active customer and company flags

Request

Get a list of all active customer and company flags 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/customer/flag \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of customer and company flags, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

Internal identifier for the customer flag. Client-specific.

Codestring or null[ 0 .. 50 ] characters

External reference code for the customer flag, used for integration purposes.

GroupIdinteger(int32)

The identifier of the group this customer flag belongs to.

GroupNamestring or null

The name of the group this customer flag belongs to.

Namestring or null[ 0 .. 50 ] characters

The customer flag name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The customer flag name for the default language.

IsNameInheritedboolean

If true, the specific language doesn't have its own name and instead inherits from the default name.

Descriptionstring or null[ 0 .. 500 ] characters

A longer description for the customer flag explaining it in more detail.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The customer flag description in the default language.

IsDescriptionInheritedboolean

If true, the description is inherited from the default language rather than being its own text.

AvailableOnCustomerboolean

Indicates whether this flag can be assigned to customers.

AvailableOnCompanyboolean

Indicates whether this flag can be assigned to companies.

IsActiveboolean

False if the customer flag is soft deleted, removes it from the admin interface and non-functional but easily reactivatable.

Changedstring or null

The date and time when the customer flag entity was last changed.

ChangedBystring or null

The name of the user who last changed the customer flag entity, null if never changed.

IsDefaultboolean

Indicates whether this is a system default flag that cannot be deleted.

SortOrderinteger or null(int32)

The sort order for displaying this flag in lists and interfaces.

CulturesArray of objects(CustomerFlagCultureModel)

List of all culture-specific text fields for the customer flag.

]
Response
application/json
[
  {
    "Id": 0,
    "Code": "string",
    "GroupId": 0,
    "GroupName": "string",
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "AvailableOnCustomer": true,
    "AvailableOnCompany": true,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string",
    "IsDefault": true,
    "SortOrder": 0,
    "Cultures": [ … ]
  }
]

Create a customer or company flag

Request

Add a new customer or company flag to the client

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Customer or company flag to create

Idinteger(int32)

Internal identifier for the customer flag. Client-specific.

Codestring or null[ 0 .. 50 ] characters

External reference code for the customer flag, used for integration purposes.

GroupIdinteger(int32)

The identifier of the group this customer flag belongs to.

GroupNamestring or null

The name of the group this customer flag belongs to.

Namestring or null[ 0 .. 50 ] characters

The customer flag name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The customer flag name for the default language.

IsNameInheritedboolean

If true, the specific language doesn't have its own name and instead inherits from the default name.

Descriptionstring or null[ 0 .. 500 ] characters

A longer description for the customer flag explaining it in more detail.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The customer flag description in the default language.

IsDescriptionInheritedboolean

If true, the description is inherited from the default language rather than being its own text.

AvailableOnCustomerboolean

Indicates whether this flag can be assigned to customers.

AvailableOnCompanyboolean

Indicates whether this flag can be assigned to companies.

IsActiveboolean

False if the customer flag is soft deleted, removes it from the admin interface and non-functional but easily reactivatable.

Changedstring or null

The date and time when the customer flag entity was last changed.

ChangedBystring or null

The name of the user who last changed the customer flag entity, null if never changed.

IsDefaultboolean

Indicates whether this is a system default flag that cannot be deleted.

SortOrderinteger or null(int32)

The sort order for displaying this flag in lists and interfaces.

CulturesArray of objects(CustomerFlagCultureModel)

List of all culture-specific text fields for the customer flag.

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/customer/flag \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "Code": "string",
    "GroupId": 0,
    "GroupName": "string",
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "AvailableOnCustomer": true,
    "AvailableOnCompany": true,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string",
    "IsDefault": true,
    "SortOrder": 0,
    "Cultures": [
      {
        "CultureCode": "string",
        "IsTranslated": true,
        "Name": "string",
        "IsNameInherited": true,
        "Description": "string",
        "IsDescriptionInherited": true
      }
    ]
  }'

Responses

If the customer or company flag was successfully created

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

Lists deleted customer and company flags

Request

Get a list of all deleted customer and company flags on the client, update a deleted flag 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/customer/flag/deleted \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of deleted customer and company flags, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

Internal identifier for the customer flag. Client-specific.

Codestring or null[ 0 .. 50 ] characters

External reference code for the customer flag, used for integration purposes.

GroupIdinteger(int32)

The identifier of the group this customer flag belongs to.

GroupNamestring or null

The name of the group this customer flag belongs to.

Namestring or null[ 0 .. 50 ] characters

The customer flag name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The customer flag name for the default language.

IsNameInheritedboolean

If true, the specific language doesn't have its own name and instead inherits from the default name.

Descriptionstring or null[ 0 .. 500 ] characters

A longer description for the customer flag explaining it in more detail.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The customer flag description in the default language.

IsDescriptionInheritedboolean

If true, the description is inherited from the default language rather than being its own text.

AvailableOnCustomerboolean

Indicates whether this flag can be assigned to customers.

AvailableOnCompanyboolean

Indicates whether this flag can be assigned to companies.

IsActiveboolean

False if the customer flag is soft deleted, removes it from the admin interface and non-functional but easily reactivatable.

Changedstring or null

The date and time when the customer flag entity was last changed.

ChangedBystring or null

The name of the user who last changed the customer flag entity, null if never changed.

IsDefaultboolean

Indicates whether this is a system default flag that cannot be deleted.

SortOrderinteger or null(int32)

The sort order for displaying this flag in lists and interfaces.

CulturesArray of objects(CustomerFlagCultureModel)

List of all culture-specific text fields for the customer flag.

]
Response
application/json
[
  {
    "Id": 0,
    "Code": "string",
    "GroupId": 0,
    "GroupName": "string",
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "AvailableOnCustomer": true,
    "AvailableOnCompany": true,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string",
    "IsDefault": true,
    "SortOrder": 0,
    "Cultures": [ … ]
  }
]

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