COMMERCE SERVICES

Customer Service

AgreementAccount

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

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
}

Company

Information about a Company.

Idinteger or null(int32)

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

Keystring or null(uuid)

The system wide unique Key of the Company.

Codestring or null[ 0 .. 50 ] characters

The external code. Usually the id in the erp system. MaxLength: 50

Namestring or null[ 0 .. 100 ] characters

The Name of the Company. MaxLength: 100

OrgNostring or null[ 0 .. 50 ] characters

The organizational number of the Company. Used to identify the Company for some payment methods. The combination of OrgNo and Name must be unique. MaxLength: 50

Phonestring or null[ 0 .. 50 ] characters

The Phone number of the Company. MaxLength: 50

ReferIdinteger or null(int32)

Used to tag a Company with some external id.

ReferUrlstring or null[ 0 .. 255 ] characters

Used to tag a Company with an incoming URL. MaxLength: 255

DeliveryAddressesArray of objects or null(Address)

A list of delivery Addresses for the Company. When needed the first address in the list will be used. So it is vital in the checkout process to either sort them or just supply one delivery address. Company addresses will override Customer addresses if both exists in the Checkout process.

InvoiceAddressobject or null

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

UseInvoiceAddressAsDeliveryAddressboolean or null

Can be used when updating or inserting addresses on Company. If set to true the invoice address will be used as a delivery address as well. Then just an invoice address needs to be passed in. The deliveryAddress will be ignored. If set to false both invoice address and delivery address must be specified.

InfoArray of objects or null(IdValue)

Contains a list of id-value pairs specific to the client for this company. Use ApplicationService.ListCompanyInfoTypes for id lookup.

PricelistIdsArray of integers or null(int32)

Contains a list of priceList ids valid for this company. It will be empty if no priceLists exist. It can be used to check products lists if they are from a company specific priceList. No need to pass this into List-methods since they are considered any way in the methods. This property should be considered as ReadOnly as priceLists are maintained else where.

ParentIdinteger or null(int32)

Points to an optional parent company. Used when companies are connected some how.

DeliveryMethodIdsArray of integers or null(int32)

Contains a list of delivery method ids valid for this company. It will be empty if no delivery methods exist.

PaymentMethodIdsArray of integers or null(int32)

Contains a list of payment method ids valid for this company. It will be empty if no payment methods exist.

Emailstring or null[ 0 .. 255 ] characters

The Email address of the Company. MaxLength: 255

FlagsArray of objects or null(Flag)

A list of Flags of the Company. See Flag for information about flags. Flags can be used in Promotions or otherwise to provide custom handling of specific Companies.

VatNostring or null[ 0 .. 50 ] characters

This is the VAT registration number for the company. MaxLength: 50

{
  "Id": 0,
  "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  "Code": "string",
  "Name": "string",
  "OrgNo": "string",
  "Phone": "string",
  "ReferId": 0,
  "ReferUrl": "string",
  "DeliveryAddresses": [
    { … }
  ],
  "InvoiceAddress": {
    "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"
  },
  "UseInvoiceAddressAsDeliveryAddress": true,
  "Info": [
    { … }
  ],
  "PricelistIds": [
    0
  ],
  "ParentId": 0,
  "DeliveryMethodIds": [
    0
  ],
  "PaymentMethodIds": [
    0
  ],
  "Email": "string",
  "Flags": [
    { … }
  ],
  "VatNo": "string"
}