COMMERCE SERVICES

Shopping Service

Update delivery information

Norce Commerce Shopping v1.1 service (1.1)

Entities and methods to handle baskets and payments. The Shopping service is used to create and manage baskets, and prepare them for the checkout process. Commonly the checkout process is handled by the Norce Checkout API, only the legacy checkout process is handled here. For product or pricing data, use the Product service. For order history, use the Order service. To change or manage promotions use the Management API.

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/

Basket

Contains endpoints for manage baskets and their lifecycle, see more information here.

Operations

Checkout

Contains endpoints for initialized the checkout process, read more about it here. There is also the old legacy purchase endpoints, still used by older solutions and Non-PSP purchases.

Operations

Update payer information (v2)

Request

Updates Payer information on a basket. This should be used when Payer differs from Buyer.

Query

basketIdinteger(int32)

The internal id of the basket to update.

updatedByinteger(int32)

Account internal id of current user.

pricelistSeedstring

(Optional) A comma separated list of internal pricelist ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

cultureCodestring

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

currencyIdstring

(Optional) Internal id that specifies in which currency to display prices. If none is supplied, value is resolved from Application.

Bodyapplication/json

The actual Customer to use as Payer. The Customer can optionally have one Company. If more than one Company is specified, the first will be used. Addresses will be resolve by first looking at the Company and then on the Customer. If no invoice address is specified no address will be used.

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.

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/shopping/1.1/UpdatePayer2 \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "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": [
        0
      ],
      "Authorizations": [
        {
          "Id": 0,
          "Value": "string",
          "Code": "string"
        }
      ],
      "IsActive": true,
      "NewPassword": "string"
    },
    "Companies": [
      {
        "Id": 0,
        "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
        "Code": "string",
        "Name": "string",
        "OrgNo": "string",
        "Phone": "string",
        "ReferId": 0,
        "ReferUrl": "string",
        "DeliveryAddresses": [
          {
            "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"
          }
        ],
        "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": [
          {
            "Id": 0,
            "Value": "string",
            "Code": "string"
          }
        ],
        "PricelistIds": [
          0
        ],
        "ParentId": 0,
        "DeliveryMethodIds": [
          0
        ],
        "PaymentMethodIds": [
          0
        ],
        "Email": "string",
        "Flags": [
          {
            "Id": 0,
            "Name": "string",
            "Group": 0,
            "IsSelected": true
          }
        ],
        "VatNo": "string"
      }
    ],
    "DeliveryAddresses": [
      {
        "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"
      }
    ],
    "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": [
      {
        "Id": 0,
        "Name": "string",
        "Group": 0,
        "IsSelected": true
      }
    ],
    "UseInvoiceAddressAsDeliveryAddress": true,
    "Info": [
      {
        "Id": 0,
        "Value": "string",
        "Code": "string"
      }
    ],
    "PricelistIds": [
      0
    ],
    "CrmId": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "Updated": "2019-08-24T14:15:22Z"
  }'

Responses

Success

Bodyapplication/json

Basketobject or null

Represents a basket where you can add/remove/update items and information such as discountcodes and pass forward information types.

Buyerobject or null

Information about a Customer.

Payerobject or null

Information about a Customer.

ShipToobject or null

Information about a Customer.

PaymentMethodsArray of objects or null(PaymentMethod)

List of available payment methods for this checkout. May be changed depending on basket contents. Generated by Norce.

DeliveryMethodsArray of objects or null(DeliveryMethod)

List of available delivery methods for this checkout. May be changed depending on basket contents. Generated by Norce.

PaymentsArray of objects or null(Payment)

List of payment attemtps made for this checkout. Each payment method selected will create it's own entry in this list.

Response

application/json

{
  "Basket": {
    "Id": 0,
    "CustomerId": 0,
    "CompanyId": 0,
    "SalesContactId": 0,
    "StatusId": 0,
    "CurrencyId": 0,
    "CurrencyCode": "str",
    "Comment": "string",
    "OrderReference": "string",
    "DiscountCode": "string",
    "ReferId": 0,
    "ReferUrl": "string",
    "ValidTo": "2019-08-24T14:15:22Z",
    "IsEditable": true,
    "Items": [ … ],
    "Info": [ … ],
    "Summary": { … },
    "AppliedPromotions": [ … ],
    "IpAddress": "string",
    "AttestedBy": 0,
    "TypeId": 0,
    "DoHold": true,
    "IsBuyable": true,
    "InvoiceReference": "string",
    "PaymentMethodId": 0,
    "DeliveryMethodId": 0,
    "SalesAreaId": 0,
    "ExternalDiscountCode": "string"
  },
  "Buyer": {
    "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": { … },
    "Companies": [ … ],
    "DeliveryAddresses": [ … ],
    "InvoiceAddress": { … },
    "Flags": [ … ],
    "UseInvoiceAddressAsDeliveryAddress": true,
    "Info": [ … ],
    "PricelistIds": [ … ],
    "CrmId": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "Updated": "2019-08-24T14:15:22Z"
  },
  "Payer": {
    "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": { … },
    "Companies": [ … ],
    "DeliveryAddresses": [ … ],
    "InvoiceAddress": { … },
    "Flags": [ … ],
    "UseInvoiceAddressAsDeliveryAddress": true,
    "Info": [ … ],
    "PricelistIds": [ … ],
    "CrmId": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "Updated": "2019-08-24T14:15:22Z"
  },
  "ShipTo": {
    "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": { … },
    "Companies": [ … ],
    "DeliveryAddresses": [ … ],
    "InvoiceAddress": { … },
    "Flags": [ … ],
    "UseInvoiceAddressAsDeliveryAddress": true,
    "Info": [ … ],
    "PricelistIds": [ … ],
    "CrmId": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "Updated": "2019-08-24T14:15:22Z"
  },
  "PaymentMethods": [
    { … }
  ],
  "DeliveryMethods": [
    { … }
  ],
  "Payments": [
    { … }
  ]
}

Update delivery information

Request

Updates ShipTo information on a basket. This should be used when ShipTo differs from Buyer.

Query

basketIdinteger(int32)

The internal id of the basket to update.

updatedByinteger(int32)

Account internal id of current user.

pricelistSeedstring

cultureCodestring

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

currencyIdstring

(Optional) Internal id that specifies in which currency to display prices. If none is supplied, value is resolved from Application.

Bodyapplication/json

The actual Customer to use as ShipTo. The Customer can optionally have one Company. If more than one Company is specified, the first will be used. Addresses will be resolve by first looking at the Company and then on the Customer. If no delivery address is specified, the invoice address will be used as delivery address. If more than one delivery address is specified, the first will be used.

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

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)

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

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)

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.

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/shopping/1.1/UpdateShipTo \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "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": [
        0
      ],
      "Authorizations": [
        {
          "Id": 0,
          "Value": "string",
          "Code": "string"
        }
      ],
      "IsActive": true,
      "NewPassword": "string"
    },
    "Companies": [
      {
        "Id": 0,
        "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
        "Code": "string",
        "Name": "string",
        "OrgNo": "string",
        "Phone": "string",
        "ReferId": 0,
        "ReferUrl": "string",
        "DeliveryAddresses": [
          {
            "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"
          }
        ],
        "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": [
          {
            "Id": 0,
            "Value": "string",
            "Code": "string"
          }
        ],
        "PricelistIds": [
          0
        ],
        "ParentId": 0,
        "DeliveryMethodIds": [
          0
        ],
        "PaymentMethodIds": [
          0
        ],
        "Email": "string",
        "Flags": [
          {
            "Id": 0,
            "Name": "string",
            "Group": 0,
            "IsSelected": true
          }
        ],
        "VatNo": "string"
      }
    ],
    "DeliveryAddresses": [
      {
        "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"
      }
    ],
    "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": [
      {
        "Id": 0,
        "Name": "string",
        "Group": 0,
        "IsSelected": true
      }
    ],
    "UseInvoiceAddressAsDeliveryAddress": true,
    "Info": [
      {
        "Id": 0,
        "Value": "string",
        "Code": "string"
      }
    ],
    "PricelistIds": [
      0
    ],
    "CrmId": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "Updated": "2019-08-24T14:15:22Z"
  }'

Responses

Success

Bodyapplication/json

Basketobject or null

Represents a basket where you can add/remove/update items and information such as discountcodes and pass forward information types.

Buyerobject or null

Information about a Customer.

Payerobject or null

Information about a Customer.

ShipToobject or null

Information about a Customer.

PaymentMethodsArray of objects or null(PaymentMethod)

List of available payment methods for this checkout. May be changed depending on basket contents. Generated by Norce.

DeliveryMethodsArray of objects or null(DeliveryMethod)

List of available delivery methods for this checkout. May be changed depending on basket contents. Generated by Norce.

PaymentsArray of objects or null(Payment)

List of payment attemtps made for this checkout. Each payment method selected will create it's own entry in this list.

Response

application/json

{
  "Basket": {
    "Id": 0,
    "CustomerId": 0,
    "CompanyId": 0,
    "SalesContactId": 0,
    "StatusId": 0,
    "CurrencyId": 0,
    "CurrencyCode": "str",
    "Comment": "string",
    "OrderReference": "string",
    "DiscountCode": "string",
    "ReferId": 0,
    "ReferUrl": "string",
    "ValidTo": "2019-08-24T14:15:22Z",
    "IsEditable": true,
    "Items": [ … ],
    "Info": [ … ],
    "Summary": { … },
    "AppliedPromotions": [ … ],
    "IpAddress": "string",
    "AttestedBy": 0,
    "TypeId": 0,
    "DoHold": true,
    "IsBuyable": true,
    "InvoiceReference": "string",
    "PaymentMethodId": 0,
    "DeliveryMethodId": 0,
    "SalesAreaId": 0,
    "ExternalDiscountCode": "string"
  },
  "Buyer": {
    "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": { … },
    "Companies": [ … ],
    "DeliveryAddresses": [ … ],
    "InvoiceAddress": { … },
    "Flags": [ … ],
    "UseInvoiceAddressAsDeliveryAddress": true,
    "Info": [ … ],
    "PricelistIds": [ … ],
    "CrmId": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "Updated": "2019-08-24T14:15:22Z"
  },
  "Payer": {
    "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": { … },
    "Companies": [ … ],
    "DeliveryAddresses": [ … ],
    "InvoiceAddress": { … },
    "Flags": [ … ],
    "UseInvoiceAddressAsDeliveryAddress": true,
    "Info": [ … ],
    "PricelistIds": [ … ],
    "CrmId": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "Updated": "2019-08-24T14:15:22Z"
  },
  "ShipTo": {
    "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": { … },
    "Companies": [ … ],
    "DeliveryAddresses": [ … ],
    "InvoiceAddress": { … },
    "Flags": [ … ],
    "UseInvoiceAddressAsDeliveryAddress": true,
    "Info": [ … ],
    "PricelistIds": [ … ],
    "CrmId": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "Updated": "2019-08-24T14:15:22Z"
  },
  "PaymentMethods": [
    { … }
  ],
  "DeliveryMethods": [
    { … }
  ],
  "Payments": [
    { … }
  ]
}

Update delivery information (v2)

Request

Updates ShipTo information on a basket. This should be used when ShipTo differs from Buyer.

Query

basketIdinteger(int32)

The internal id of the basket to update.

updatedByinteger(int32)

Account internal id of current user.

pricelistSeedstring

cultureCodestring

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

currencyIdstring

(Optional) Internal id that specifies in which currency to display prices. If none is supplied, value is resolved from Application.

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

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)

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

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)

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.

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/shopping/1.1/UpdateShipTo2 \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "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": [
        0
      ],
      "Authorizations": [
        {
          "Id": 0,
          "Value": "string",
          "Code": "string"
        }
      ],
      "IsActive": true,
      "NewPassword": "string"
    },
    "Companies": [
      {
        "Id": 0,
        "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
        "Code": "string",
        "Name": "string",
        "OrgNo": "string",
        "Phone": "string",
        "ReferId": 0,
        "ReferUrl": "string",
        "DeliveryAddresses": [
          {
            "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"
          }
        ],
        "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": [
          {
            "Id": 0,
            "Value": "string",
            "Code": "string"
          }
        ],
        "PricelistIds": [
          0
        ],
        "ParentId": 0,
        "DeliveryMethodIds": [
          0
        ],
        "PaymentMethodIds": [
          0
        ],
        "Email": "string",
        "Flags": [
          {
            "Id": 0,
            "Name": "string",
            "Group": 0,
            "IsSelected": true
          }
        ],
        "VatNo": "string"
      }
    ],
    "DeliveryAddresses": [
      {
        "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"
      }
    ],
    "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": [
      {
        "Id": 0,
        "Name": "string",
        "Group": 0,
        "IsSelected": true
      }
    ],
    "UseInvoiceAddressAsDeliveryAddress": true,
    "Info": [
      {
        "Id": 0,
        "Value": "string",
        "Code": "string"
      }
    ],
    "PricelistIds": [
      0
    ],
    "CrmId": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "Updated": "2019-08-24T14:15:22Z"
  }'

Responses

Success

Bodyapplication/json

Basketobject or null

Represents a basket where you can add/remove/update items and information such as discountcodes and pass forward information types.

Buyerobject or null

Information about a Customer.

Payerobject or null

Information about a Customer.

ShipToobject or null

Information about a Customer.

PaymentMethodsArray of objects or null(PaymentMethod)

List of available payment methods for this checkout. May be changed depending on basket contents. Generated by Norce.

DeliveryMethodsArray of objects or null(DeliveryMethod)

List of available delivery methods for this checkout. May be changed depending on basket contents. Generated by Norce.

PaymentsArray of objects or null(Payment)

List of payment attemtps made for this checkout. Each payment method selected will create it's own entry in this list.

Response

application/json

{
  "Basket": {
    "Id": 0,
    "CustomerId": 0,
    "CompanyId": 0,
    "SalesContactId": 0,
    "StatusId": 0,
    "CurrencyId": 0,
    "CurrencyCode": "str",
    "Comment": "string",
    "OrderReference": "string",
    "DiscountCode": "string",
    "ReferId": 0,
    "ReferUrl": "string",
    "ValidTo": "2019-08-24T14:15:22Z",
    "IsEditable": true,
    "Items": [ … ],
    "Info": [ … ],
    "Summary": { … },
    "AppliedPromotions": [ … ],
    "IpAddress": "string",
    "AttestedBy": 0,
    "TypeId": 0,
    "DoHold": true,
    "IsBuyable": true,
    "InvoiceReference": "string",
    "PaymentMethodId": 0,
    "DeliveryMethodId": 0,
    "SalesAreaId": 0,
    "ExternalDiscountCode": "string"
  },
  "Buyer": {
    "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": { … },
    "Companies": [ … ],
    "DeliveryAddresses": [ … ],
    "InvoiceAddress": { … },
    "Flags": [ … ],
    "UseInvoiceAddressAsDeliveryAddress": true,
    "Info": [ … ],
    "PricelistIds": [ … ],
    "CrmId": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "Updated": "2019-08-24T14:15:22Z"
  },
  "Payer": {
    "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": { … },
    "Companies": [ … ],
    "DeliveryAddresses": [ … ],
    "InvoiceAddress": { … },
    "Flags": [ … ],
    "UseInvoiceAddressAsDeliveryAddress": true,
    "Info": [ … ],
    "PricelistIds": [ … ],
    "CrmId": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "Updated": "2019-08-24T14:15:22Z"
  },
  "ShipTo": {
    "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": { … },
    "Companies": [ … ],
    "DeliveryAddresses": [ … ],
    "InvoiceAddress": { … },
    "Flags": [ … ],
    "UseInvoiceAddressAsDeliveryAddress": true,
    "Info": [ … ],
    "PricelistIds": [ … ],
    "CrmId": "string",
    "IsActive": true,
    "Created": "2019-08-24T14:15:22Z",
    "Updated": "2019-08-24T14:15:22Z"
  },
  "PaymentMethods": [
    { … }
  ],
  "DeliveryMethods": [
    { … }
  ],
  "Payments": [
    { … }
  ]
}

DeliveryMethods

Contains endpoints for viewing metadata about configured delivery methods, when using Norces internal shipping logic.

Operations

InfoTypes

Contains endpoints for viewing metadata for extended fields on the basket and basketitems.

Operations

OnHand

Contains endpoints for looking up availability on baskets.

Operations

OrderRequest

Contains endpoints for viewing orders snapshots.

Operations

Payments

Contains endpoints for legacy purchases, still used by older solutions and Non-PSP purchases.

Operations

Promotions

Contains endpoints for viewing more promotion information.

Operations

Norce Commerce Shopping v1.1 service (1.1)

Basket

Checkout

Update payer information (v2)

Request

Responses

Did the information on the page help you?

Update delivery information

Request

Responses

Did the information on the page help you?

Update delivery information (v2)

Request

Responses

Did the information on the page help you?

DeliveryMethods

InfoTypes

OnHand

OrderRequest

Payments

Promotions

Schemas

Norce Commerce Shopping v1.1 service (1.1)

Basket

Checkout

Update payer information (v2)

RequestExpand all

Responses

Did the information on the page help you?

Update delivery information

RequestExpand all

Responses

Did the information on the page help you?

Update delivery information (v2)

RequestExpand all

Responses

Did the information on the page help you?

DeliveryMethods

InfoTypes

OnHand

OrderRequest

Payments

Promotions

Schemas

Request

Request

Request