COMMERCE SERVICES

Customer Service

Address

Norce Commerce Customer v1.1 service (1.1)

The Customers namespace has Entities and Operations concerned with Customer and Company management.

Download OpenAPI description

openapi-v1.json

openapi-v1.yaml

Servers

Playground

https://{slug}.api-se.playground.norce.tech/commerce/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/

Production

https://{slug}.api-se.norce.tech/commerce/

Accounts

Contains endpoints for managing Accounts and handling authentication using the Account functionality in Norce. More on Account authentication

Operations

Address

Contains endpoints for managing addresses on Customer and Company objects.

Operations

Companies

Contains endpoints for managing Company data and related information.

Operations

Customers

Contains endpoints for managing Customer data and related information.

Operations

Flags

Contains endpoints for viewing Customer and Company flags.

Operations

InfoTypes

Contains endpoints for viewing metadata about Customer and Company extended fields.

Operations

PriceLists

Contains endpoints for managing company connected price lists.

Operations

Schemas

Account

An Account is related to a Customer. Each Account can belong to only one Application. When creating Customers you need to define a Customer.Account if you want the customer to be able to login. This is useful when the application supports My page with order history and such.

Idinteger or null(int32)

The internal Id of the Account. This value should be used as updatedBy/createdBy in API-Methods. When creating a new Account on a Customer leave this blank as Norce will generate the Id.

Keystring or null(uuid)

The system wide unique Key for the Account.

LoginNamestring or null[ 0 .. 255 ] characters

This is the login name used when logging in. Normally this is the email address. Care must be taken when user updates their emailAddress. Normally this update is just for Customer.Email. It is up to the Application to keep Customer.Email in sync with Account.LoginName if they are the same. MaxLength: 255

Namestring or null[ 0 .. 100 ] characters

This is the full name of the connected Customer's first and last name. MaxLength: 100

RolesArray of integers or null(int32)

This is an integer list of Role.Ids. See Application.Roles for available roles for the Application. This can be used to authorize roles to different parts of an Application.

AuthorizationsArray of objects or null(IdValue)

This is an IdValue list of Authorizations. See Application.Authorizations for available values for the Application. This can be used to authorize users to different parts of an Application.

IsActiveboolean or null

Indicates if the Account is Active or not. Use UpdateAccountStatus to change this value.

NewPasswordstring or null

New password that can be set when creating or updating a customer.

{
  "Id": 0,
  "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  "LoginName": "string",
  "Name": "string",
  "Roles": [
    0
  ],
  "Authorizations": [
    { … }
  ],
  "IsActive": true,
  "NewPassword": "string"
}

Address

Information about an address. Addresses appear as InvoiceAddress or DeliveryAddresses or when ever an Address is needed

Idinteger or null(int32)

The internal Id of the Address. When creating a new Address leave this blank as Norce will generate the Id.

CareOfstring or null[ 0 .. 100 ] characters

The CareOf of the Address. MaxLength: 100

Line1string or null[ 0 .. 255 ] characters

The first address line of the Address. MaxLength: 255

Line2string or null[ 0 .. 255 ] characters

The second address line of the Address. MaxLength: 255

Zipstring or null[ 0 .. 50 ] characters

The zip code of the Address. MaxLength: 50

Citystring or null[ 0 .. 50 ] characters

The City of the Address. MaxLength: 50

CountryIdinteger or null(int32)

The internal Id for the country associated to the Address. When creating or updating Country on an Address either specify the CountryId or just the Country string. If Id is specified it will be used to resolve the Name. If none is specified the default for the Application will be used.

Countrystring or null[ 0 .. 50 ] characters

The country name of the Address. When creating or updating Country on an Address either specify the CountryId or just the Country string. If Name is specified it will be used to resolve the Name and Id. Name should then be specified as Country.Code since Names are culture specific. If none is specified the default for the Application will be used. MaxLength: 50

Regionstring or null[ 0 .. 50 ] characters

The Region of the Address. MaxLength: 50

IsValidatedboolean or null

Indicates if the address had been validated. It is up to the Application to validate addresses. Use normal address-methods to update this value.

GlobalLocationNostring or null[ 0 .. 50 ] characters

The Global Location Number (GLN) is part of the GS1 systems of standards. It is a simple tool used to identify a location and can identify locations uniquely where required. This is only used for invoice addresses. MaxLength: 50

ShippingPhoneNumberstring or null[ 0 .. 50 ] characters

Phone number for shipping address. Only applicable in shipping addresses. MaxLength: 50

Codestring or null

An external Code of the Address identifying this addess to external address.

{
  "Id": 0,
  "CareOf": "string",
  "Line1": "string",
  "Line2": "string",
  "Zip": "string",
  "City": "string",
  "CountryId": 0,
  "Country": "string",
  "Region": "string",
  "IsValidated": true,
  "GlobalLocationNo": "string",
  "ShippingPhoneNumber": "string",
  "Code": "string"
}

AgreementAccount

An AgreementAccount is a special account connected to a priceList. Users can login to an AgreementAccount if the priceList is setup with a code. Note that when using AgreementAccounts any agreement code must be unique amongst all priceLists.

PricelistIdinteger or null(int32)

The PriceListId of the PriceList logged in to.

Namestring or null

The Name of the AgreementAccount/PriceList.

StartDatestring or null(date-time)

The StartDate of the AgreementAccount/PriceList.

EndDatestring or null(date-time)

The EndDate of the AgreementAccount/PriceList.

ImageKeystring or null(uuid)

A unique id for the image at our image server. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

ShowPricesIncVatboolean or null

Indicates if prices should be shown inc or ex VAT.

{
  "PricelistId": 0,
  "Name": "string",
  "StartDate": "2019-08-24T14:15:22Z",
  "EndDate": "2019-08-24T14:15:22Z",
  "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c",
  "ShowPricesIncVat": true
}