BaseError

Address

typestring

The type of customer

Enum"person""organization"

Example: "Person"

givenNamestring

Given name or first name.

Example: "Rosalinainho"

familyNamestring

Family name or last name.

Example: "Undulatsson"

careOfstring

Care of.

Example: "Olleinho Jyckesson"

referencestring

Reference to the customer

organizationNamestring

Name of the Organization

Example: "Storm"

streetAddressstring

Address or street name, first line.

Example: "Adaptivevägen 18"

streetAddress2string

Address or street name, second line.

Example: "Lgh 1203"

postalCodestring

Postal code, zip or post code.

Example: "955 60"

citystring

City.

Example: "Boden"

regionstring

State or region.

Example: "Norrbotten"

countrystring^[A-Za-z]{2,2}$

Country. ISO 3166 alpha-2.

Example: "SE"

phonestring

Phone number.

Example: "0753892233"

emailstring

E-mail address.

Example: "rosalinainho.undulatsson@example.com"

nationalIdentificationNumberstring

Number used to identify individuals. E.g. could be used for Personal identity number (personnummer) in Sweden.

Example: "890201-3286"

organizationIdentificationNumberstring

Number used to identify organizations or legal persons. E.g. could be used for Corporate identity number. (organisationsnummer in Sweden)

Example: "212000-1355"

attributesobject

Allows you to store any custom attributes for the address.

{
  "type": "Person",
  "givenName": "Rosalinainho",
  "familyName": "Undulatsson",
  "careOf": "Olleinho Jyckesson",
  "reference": "string",
  "organizationName": "Storm",
  "streetAddress": "Adaptivevägen 18",
  "streetAddress2": "Lgh 1203",
  "postalCode": "955 60",
  "city": "Boden",
  "region": "Norrbotten",
  "country": "SE",
  "phone": "0753892233",
  "email": "rosalinainho.undulatsson@example.com",
  "nationalIdentificationNumber": "890201-3286",
  "organizationIdentificationNumber": "212000-1355",
  "attributes": {
    "property1": null,
    "property2": null
  }
}

Callback

idstringread-only

Unique ID for the callback.

Example: "oc_BaDIudFOjBEuFmLlmDExePUFTh"

adapterIdstring

Callback Adapter ID.

Example: "jetshop_adapter"

urlstring

Full valid url to be called by POST. If the url contains the substring '{order_id}' it will be replaced with the orders id before call is performed.

Example: "http://specific-feature-adapter.norce.io/api/v1/callbacks/orders/{order_id}/specific-callback"

{
  "id": "oc_BaDIudFOjBEuFmLlmDExePUFTh",
  "adapterId": "jetshop_adapter",
  "url": "http://specific-feature-adapter.norce.io/api/v1/callbacks/orders/{order_id}/specific-callback"
}

Norce Checkout - Order Management API (0.1)

Schemas

Address

BaseError

Callback

Checkout

Checkout Payment

Checkout Shipping