COMMERCE SERVICES
/
Customer Service
/
Address
/
Delete delivery address for customer

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
Languages
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

Operations

Address

Contains endpoints for managing addresses on Customer and Company objects.

Operations

Insert delivery address for customer

Request

Inserts a new delivery address for the specified Customer.

Query
customerIdinteger(int32)

The internal id of the Customer to insert the Address for.

updatedByinteger(int32)

Account internal id of current user.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

includeCompaniesstring

(Optional) Include full company data, if any, with the customer. Otherwise only primary company, if any, is included. Default is true.

Bodyapplication/json

The Address to insert. The Address internal id should not have an id specified since it will be generated by Norce.

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.

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/customer/1.1/InsertCustomerDeliveryAddress \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "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"
  }'

Responses

OK

Bodyapplication/json
Idinteger or null(int32)

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

Keystring or null(uuid)

The system wide unique Key of the Customer.

Codestring or null[ 0 .. 50 ] characters

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

Emailstring or null[ 0 .. 255 ] characters

The Email address of the Customer. MaxLength: 255

Ssnstring or null[ 0 .. 50 ] characters

The social security number of the Customer. Used to identify the Customer for some payment methods. MaxLength: 50

FirstNamestring or null[ 0 .. 50 ] characters

The FirstName of the Customer. MaxLength: 50

LastNamestring or null[ 0 .. 50 ] characters

The LastName of the Customer. MaxLength: 50

Phonestring or null[ 0 .. 50 ] characters

The PhoneNumber of the Customer. MaxLength: 50

CellPhonestring or null[ 0 .. 50 ] characters

The CellPhone number of the Customer. MaxLength: 50

ReferIdinteger or null(int32)

Used to tag a Customer with some external id.

ReferUrlstring or null[ 0 .. 255 ] characters

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

Accountobject or null

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.

CompaniesArray of objects or null(Company)

A list of Companies. A Customer can have many Companies. The first will be used as default. In the Checkout process just pass in one Company if any is to be used or the first will be used as default.

DeliveryAddressesArray of objects or null(Address)

A list of delivery Addresses for the Customer. 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

FlagsArray of objects or null(Flag)

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

UseInvoiceAddressAsDeliveryAddressboolean or null

Can be use when updating or inserting addresses on Customer. 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 customer. Use ApplicationService.ListCustomerInfoTypes for id lookup.

PricelistIdsArray of integers or null(int32)

Contains a list of priceList ids valid for this customer. It will be empty if no priceLists exist. It can be used to check products lists if they are from a customer 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.

CrmIdstring or null[ 0 .. 50 ] characters

Used to save the Customers external id from a crm-system. MaxLength: 50

IsActiveboolean or null

Specifies if the Customer is active or not.

Createdstring or null(date-time)

When the customer was created.

Updatedstring or null(date-time)

When the customer was last updated.

Response
application/json
{
  "Id": 0,
  "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  "Code": "string",
  "Email": "string",
  "Ssn": "string",
  "FirstName": "string",
  "LastName": "string",
  "Phone": "string",
  "CellPhone": "string",
  "ReferId": 0,
  "ReferUrl": "string",
  "Account": {
    "Id": 0,
    "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
    "LoginName": "string",
    "Name": "string",
    "Roles": [ … ],
    "Authorizations": [ … ],
    "IsActive": true,
    "NewPassword": "string"
  },
  "Companies": [
    { … }
  ],
  "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"
  },
  "Flags": [
    { … }
  ],
  "UseInvoiceAddressAsDeliveryAddress": true,
  "Info": [
    { … }
  ],
  "PricelistIds": [
    0
  ],
  "CrmId": "string",
  "IsActive": true,
  "Created": "2019-08-24T14:15:22Z",
  "Updated": "2019-08-24T14:15:22Z"
}

Update delivery address for customer

Request

Updates a delivery address for the specified Customer.

Query
customerIdinteger(int32)

The internal id of the Customer to update the Address for.

updatedByinteger(int32)

Account internal id of current user.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

includeCompaniesstring

(Optional) Include full company data, if any, with the customer. Otherwise only primary company, if any, is included. Default is true.

Bodyapplication/json

The Address to update. The address must have a valid internal id specified.

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.

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/customer/1.1/UpdateCustomerDeliveryAddress \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "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"
  }'

Responses

OK

Bodyapplication/json
Idinteger or null(int32)

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

Keystring or null(uuid)

The system wide unique Key of the Customer.

Codestring or null[ 0 .. 50 ] characters

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

Emailstring or null[ 0 .. 255 ] characters

The Email address of the Customer. MaxLength: 255

Ssnstring or null[ 0 .. 50 ] characters

The social security number of the Customer. Used to identify the Customer for some payment methods. MaxLength: 50

FirstNamestring or null[ 0 .. 50 ] characters

The FirstName of the Customer. MaxLength: 50

LastNamestring or null[ 0 .. 50 ] characters

The LastName of the Customer. MaxLength: 50

Phonestring or null[ 0 .. 50 ] characters

The PhoneNumber of the Customer. MaxLength: 50

CellPhonestring or null[ 0 .. 50 ] characters

The CellPhone number of the Customer. MaxLength: 50

ReferIdinteger or null(int32)

Used to tag a Customer with some external id.

ReferUrlstring or null[ 0 .. 255 ] characters

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

Accountobject or null

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.

CompaniesArray of objects or null(Company)

A list of Companies. A Customer can have many Companies. The first will be used as default. In the Checkout process just pass in one Company if any is to be used or the first will be used as default.

DeliveryAddressesArray of objects or null(Address)

A list of delivery Addresses for the Customer. 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

FlagsArray of objects or null(Flag)

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

UseInvoiceAddressAsDeliveryAddressboolean or null

Can be use when updating or inserting addresses on Customer. 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 customer. Use ApplicationService.ListCustomerInfoTypes for id lookup.

PricelistIdsArray of integers or null(int32)

Contains a list of priceList ids valid for this customer. It will be empty if no priceLists exist. It can be used to check products lists if they are from a customer 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.

CrmIdstring or null[ 0 .. 50 ] characters

Used to save the Customers external id from a crm-system. MaxLength: 50

IsActiveboolean or null

Specifies if the Customer is active or not.

Createdstring or null(date-time)

When the customer was created.

Updatedstring or null(date-time)

When the customer was last updated.

Response
application/json
{
  "Id": 0,
  "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  "Code": "string",
  "Email": "string",
  "Ssn": "string",
  "FirstName": "string",
  "LastName": "string",
  "Phone": "string",
  "CellPhone": "string",
  "ReferId": 0,
  "ReferUrl": "string",
  "Account": {
    "Id": 0,
    "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
    "LoginName": "string",
    "Name": "string",
    "Roles": [ … ],
    "Authorizations": [ … ],
    "IsActive": true,
    "NewPassword": "string"
  },
  "Companies": [
    { … }
  ],
  "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"
  },
  "Flags": [
    { … }
  ],
  "UseInvoiceAddressAsDeliveryAddress": true,
  "Info": [
    { … }
  ],
  "PricelistIds": [
    0
  ],
  "CrmId": "string",
  "IsActive": true,
  "Created": "2019-08-24T14:15:22Z",
  "Updated": "2019-08-24T14:15:22Z"
}

Delete delivery address for customer

Request

Deletes a delivery address for the specified Customer.

Query
addressIdinteger(int32)

The internal id of the Address to delete.

customerIdinteger(int32)

The internal id of the Customer to delete the Address for.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

includeCompaniesstring

(Optional) Include full company data, if any, with the customer. Otherwise only primary company, if any, is included. Default is true.

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/customer/1.1/DeleteCustomerDeliveryAddress \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
Idinteger or null(int32)

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

Keystring or null(uuid)

The system wide unique Key of the Customer.

Codestring or null[ 0 .. 50 ] characters

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

Emailstring or null[ 0 .. 255 ] characters

The Email address of the Customer. MaxLength: 255

Ssnstring or null[ 0 .. 50 ] characters

The social security number of the Customer. Used to identify the Customer for some payment methods. MaxLength: 50

FirstNamestring or null[ 0 .. 50 ] characters

The FirstName of the Customer. MaxLength: 50

LastNamestring or null[ 0 .. 50 ] characters

The LastName of the Customer. MaxLength: 50

Phonestring or null[ 0 .. 50 ] characters

The PhoneNumber of the Customer. MaxLength: 50

CellPhonestring or null[ 0 .. 50 ] characters

The CellPhone number of the Customer. MaxLength: 50

ReferIdinteger or null(int32)

Used to tag a Customer with some external id.

ReferUrlstring or null[ 0 .. 255 ] characters

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

Accountobject or null

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.

CompaniesArray of objects or null(Company)

A list of Companies. A Customer can have many Companies. The first will be used as default. In the Checkout process just pass in one Company if any is to be used or the first will be used as default.

DeliveryAddressesArray of objects or null(Address)

A list of delivery Addresses for the Customer. 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

FlagsArray of objects or null(Flag)

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

UseInvoiceAddressAsDeliveryAddressboolean or null

Can be use when updating or inserting addresses on Customer. 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 customer. Use ApplicationService.ListCustomerInfoTypes for id lookup.

PricelistIdsArray of integers or null(int32)

Contains a list of priceList ids valid for this customer. It will be empty if no priceLists exist. It can be used to check products lists if they are from a customer 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.

CrmIdstring or null[ 0 .. 50 ] characters

Used to save the Customers external id from a crm-system. MaxLength: 50

IsActiveboolean or null

Specifies if the Customer is active or not.

Createdstring or null(date-time)

When the customer was created.

Updatedstring or null(date-time)

When the customer was last updated.

Response
application/json
{
  "Id": 0,
  "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  "Code": "string",
  "Email": "string",
  "Ssn": "string",
  "FirstName": "string",
  "LastName": "string",
  "Phone": "string",
  "CellPhone": "string",
  "ReferId": 0,
  "ReferUrl": "string",
  "Account": {
    "Id": 0,
    "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
    "LoginName": "string",
    "Name": "string",
    "Roles": [ … ],
    "Authorizations": [ … ],
    "IsActive": true,
    "NewPassword": "string"
  },
  "Companies": [
    { … }
  ],
  "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"
  },
  "Flags": [
    { … }
  ],
  "UseInvoiceAddressAsDeliveryAddress": true,
  "Info": [
    { … }
  ],
  "PricelistIds": [
    0
  ],
  "CrmId": "string",
  "IsActive": true,
  "Created": "2019-08-24T14:15:22Z",
  "Updated": "2019-08-24T14:15:22Z"
}

Insert delivery address for company

Request

Inserts a new delivery address for the specified Company.

Query
companyIdinteger(int32)

The internal id of the Company to insert the Address for.

customerIdinteger(int32)

The internal id of a Customer belonging to the Company.

updatedByinteger(int32)

Account internal id of current user.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

includeCompaniesstring

(Optional) Include full company data, if any, with the customer. Otherwise only primary company, if any, is included. Default is true.

Bodyapplication/json

The Address to insert. The Address internal id should not have an id specified since it will be generated by Norce.

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.

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/customer/1.1/InsertCompanyDeliveryAddress \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "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"
  }'

Responses

OK

Bodyapplication/json
Idinteger or null(int32)

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

Keystring or null(uuid)

The system wide unique Key of the Customer.

Codestring or null[ 0 .. 50 ] characters

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

Emailstring or null[ 0 .. 255 ] characters

The Email address of the Customer. MaxLength: 255

Ssnstring or null[ 0 .. 50 ] characters

The social security number of the Customer. Used to identify the Customer for some payment methods. MaxLength: 50

FirstNamestring or null[ 0 .. 50 ] characters

The FirstName of the Customer. MaxLength: 50

LastNamestring or null[ 0 .. 50 ] characters

The LastName of the Customer. MaxLength: 50

Phonestring or null[ 0 .. 50 ] characters

The PhoneNumber of the Customer. MaxLength: 50

CellPhonestring or null[ 0 .. 50 ] characters

The CellPhone number of the Customer. MaxLength: 50

ReferIdinteger or null(int32)

Used to tag a Customer with some external id.

ReferUrlstring or null[ 0 .. 255 ] characters

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

Accountobject or null

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.

CompaniesArray of objects or null(Company)

A list of Companies. A Customer can have many Companies. The first will be used as default. In the Checkout process just pass in one Company if any is to be used or the first will be used as default.

DeliveryAddressesArray of objects or null(Address)

A list of delivery Addresses for the Customer. 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

FlagsArray of objects or null(Flag)

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

UseInvoiceAddressAsDeliveryAddressboolean or null

Can be use when updating or inserting addresses on Customer. 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 customer. Use ApplicationService.ListCustomerInfoTypes for id lookup.

PricelistIdsArray of integers or null(int32)

Contains a list of priceList ids valid for this customer. It will be empty if no priceLists exist. It can be used to check products lists if they are from a customer 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.

CrmIdstring or null[ 0 .. 50 ] characters

Used to save the Customers external id from a crm-system. MaxLength: 50

IsActiveboolean or null

Specifies if the Customer is active or not.

Createdstring or null(date-time)

When the customer was created.

Updatedstring or null(date-time)

When the customer was last updated.

Response
application/json
{
  "Id": 0,
  "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  "Code": "string",
  "Email": "string",
  "Ssn": "string",
  "FirstName": "string",
  "LastName": "string",
  "Phone": "string",
  "CellPhone": "string",
  "ReferId": 0,
  "ReferUrl": "string",
  "Account": {
    "Id": 0,
    "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
    "LoginName": "string",
    "Name": "string",
    "Roles": [ … ],
    "Authorizations": [ … ],
    "IsActive": true,
    "NewPassword": "string"
  },
  "Companies": [
    { … }
  ],
  "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"
  },
  "Flags": [
    { … }
  ],
  "UseInvoiceAddressAsDeliveryAddress": true,
  "Info": [
    { … }
  ],
  "PricelistIds": [
    0
  ],
  "CrmId": "string",
  "IsActive": true,
  "Created": "2019-08-24T14:15:22Z",
  "Updated": "2019-08-24T14:15:22Z"
}

Update delivery address for company

Request

Updates a delivery address for the specified Company.

Query
customerIdinteger(int32)

The internal id of a Customer belonging to the Company.

updatedByinteger(int32)

Account internal id of current user.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

includeCompaniesstring

(Optional) Include full company data, if any, with the customer. Otherwise only primary company, if any, is included. Default is true.

Bodyapplication/json

The Address to update. The address internal id must have a valid id specified.

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.

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/customer/1.1/UpdateCompanyDeliveryAddress \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "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"
  }'

Responses

OK

Bodyapplication/json
Idinteger or null(int32)

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

Keystring or null(uuid)

The system wide unique Key of the Customer.

Codestring or null[ 0 .. 50 ] characters

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

Emailstring or null[ 0 .. 255 ] characters

The Email address of the Customer. MaxLength: 255

Ssnstring or null[ 0 .. 50 ] characters

The social security number of the Customer. Used to identify the Customer for some payment methods. MaxLength: 50

FirstNamestring or null[ 0 .. 50 ] characters

The FirstName of the Customer. MaxLength: 50

LastNamestring or null[ 0 .. 50 ] characters

The LastName of the Customer. MaxLength: 50

Phonestring or null[ 0 .. 50 ] characters

The PhoneNumber of the Customer. MaxLength: 50

CellPhonestring or null[ 0 .. 50 ] characters

The CellPhone number of the Customer. MaxLength: 50

ReferIdinteger or null(int32)

Used to tag a Customer with some external id.

ReferUrlstring or null[ 0 .. 255 ] characters

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

Accountobject or null

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.

CompaniesArray of objects or null(Company)

A list of Companies. A Customer can have many Companies. The first will be used as default. In the Checkout process just pass in one Company if any is to be used or the first will be used as default.

DeliveryAddressesArray of objects or null(Address)

A list of delivery Addresses for the Customer. 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

FlagsArray of objects or null(Flag)

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

UseInvoiceAddressAsDeliveryAddressboolean or null

Can be use when updating or inserting addresses on Customer. 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 customer. Use ApplicationService.ListCustomerInfoTypes for id lookup.

PricelistIdsArray of integers or null(int32)

Contains a list of priceList ids valid for this customer. It will be empty if no priceLists exist. It can be used to check products lists if they are from a customer 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.

CrmIdstring or null[ 0 .. 50 ] characters

Used to save the Customers external id from a crm-system. MaxLength: 50

IsActiveboolean or null

Specifies if the Customer is active or not.

Createdstring or null(date-time)

When the customer was created.

Updatedstring or null(date-time)

When the customer was last updated.

Response
application/json
{
  "Id": 0,
  "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  "Code": "string",
  "Email": "string",
  "Ssn": "string",
  "FirstName": "string",
  "LastName": "string",
  "Phone": "string",
  "CellPhone": "string",
  "ReferId": 0,
  "ReferUrl": "string",
  "Account": {
    "Id": 0,
    "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
    "LoginName": "string",
    "Name": "string",
    "Roles": [ … ],
    "Authorizations": [ … ],
    "IsActive": true,
    "NewPassword": "string"
  },
  "Companies": [
    { … }
  ],
  "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"
  },
  "Flags": [
    { … }
  ],
  "UseInvoiceAddressAsDeliveryAddress": true,
  "Info": [
    { … }
  ],
  "PricelistIds": [
    0
  ],
  "CrmId": "string",
  "IsActive": true,
  "Created": "2019-08-24T14:15:22Z",
  "Updated": "2019-08-24T14:15:22Z"
}

Delete delivery address for company

Request

Deletes a delivery address for the specified Company.

Query
addressIdinteger(int32)

The internal id of the Address to delete.

customerIdinteger(int32)

The internal id of a Customer belonging to the Company.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

includeCompaniesstring

(Optional) Include full company data, if any, with the customer. Otherwise only primary company, if any, is included. Default is true.

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/customer/1.1/DeleteCompanyDeliveryAddress \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
Idinteger or null(int32)

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

Keystring or null(uuid)

The system wide unique Key of the Customer.

Codestring or null[ 0 .. 50 ] characters

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

Emailstring or null[ 0 .. 255 ] characters

The Email address of the Customer. MaxLength: 255

Ssnstring or null[ 0 .. 50 ] characters

The social security number of the Customer. Used to identify the Customer for some payment methods. MaxLength: 50

FirstNamestring or null[ 0 .. 50 ] characters

The FirstName of the Customer. MaxLength: 50

LastNamestring or null[ 0 .. 50 ] characters

The LastName of the Customer. MaxLength: 50

Phonestring or null[ 0 .. 50 ] characters

The PhoneNumber of the Customer. MaxLength: 50

CellPhonestring or null[ 0 .. 50 ] characters

The CellPhone number of the Customer. MaxLength: 50

ReferIdinteger or null(int32)

Used to tag a Customer with some external id.

ReferUrlstring or null[ 0 .. 255 ] characters

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

Accountobject or null

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.

CompaniesArray of objects or null(Company)

A list of Companies. A Customer can have many Companies. The first will be used as default. In the Checkout process just pass in one Company if any is to be used or the first will be used as default.

DeliveryAddressesArray of objects or null(Address)

A list of delivery Addresses for the Customer. 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

FlagsArray of objects or null(Flag)

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

UseInvoiceAddressAsDeliveryAddressboolean or null

Can be use when updating or inserting addresses on Customer. 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 customer. Use ApplicationService.ListCustomerInfoTypes for id lookup.

PricelistIdsArray of integers or null(int32)

Contains a list of priceList ids valid for this customer. It will be empty if no priceLists exist. It can be used to check products lists if they are from a customer 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.

CrmIdstring or null[ 0 .. 50 ] characters

Used to save the Customers external id from a crm-system. MaxLength: 50

IsActiveboolean or null

Specifies if the Customer is active or not.

Createdstring or null(date-time)

When the customer was created.

Updatedstring or null(date-time)

When the customer was last updated.

Response
application/json
{
  "Id": 0,
  "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  "Code": "string",
  "Email": "string",
  "Ssn": "string",
  "FirstName": "string",
  "LastName": "string",
  "Phone": "string",
  "CellPhone": "string",
  "ReferId": 0,
  "ReferUrl": "string",
  "Account": {
    "Id": 0,
    "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
    "LoginName": "string",
    "Name": "string",
    "Roles": [ … ],
    "Authorizations": [ … ],
    "IsActive": true,
    "NewPassword": "string"
  },
  "Companies": [
    { … }
  ],
  "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"
  },
  "Flags": [
    { … }
  ],
  "UseInvoiceAddressAsDeliveryAddress": true,
  "Info": [
    { … }
  ],
  "PricelistIds": [
    0
  ],
  "CrmId": "string",
  "IsActive": true,
  "Created": "2019-08-24T14:15:22Z",
  "Updated": "2019-08-24T14:15:22Z"
}

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