Skip to main content

Address

Generic definition of a address, could be a customer address, a billing address or a delivery address

type Address {
  type: AddressType!
  organizationRegistrationId: String
  organizationName: String
  organizationNumber: String
  ssn: String
  firstName: String
  lastName: String
  streetAddress: String
  houseNumber: String
  houseExtension: String
  streetAddress2: String
  streetAddress3: String
  postalCode: String
  city: String
  country: Country
  state: State
  email: String
  phone: String
  reference: String
  doorCode: String
  attention: String
}

Fields​

type ● AddressType!​

The type of address, can be one of: shipping | billing | contact

organizationRegistrationId ● String​

Companys registration id

organizationName ● String​

Name of the company

organizationNumber ● String​

The organization number of the company

ssn ● String​

The social security number of the person

firstName ● String​

The first name of the person

lastName ● String​

The last name of the person

streetAddress ● String​

The street address of the person/company

houseNumber ● String​

The houseNumber part of the street address

houseExtension ● String​

The houseExtension part of the street address

streetAddress2 ● String​

The street address line 2

streetAddress3 ● String​

The street address line 3

postalCode ● String​

The postal code of the address

city ● String​

The city of the address

country ● Country​

The country of the address

state ● State​

The administrative state in the country of the address

email ● String​

The email of the person/company

phone ● String​

The phone number of the address, valid E.164 Phone number (ex. +1123456789)

reference ● String​

Voluntary reference

doorCode ● String​

Voluntary door code

attention ● String​

The intended receiver of the delivery

Example​

{
  "organizationRegistrationId": "SE5566395256",
  "organizationName": "Askås Internet- & Reklambyrå AB",
  "organizationNumber": "556639-5256",
  "ssn": 191212,
  "firstName": "John",
  "lastName": "Doe",
  "streetAddress": "Järnvägsgatan 11",
  "houseNumber": 11,
  "streetAddress2": 11,
  "postalCode": 66133,
  "city": "Säffle",
  "country": "Sverige",
  "state": {
    "country": {
      "phonePrefix": "+46"
    }
  },
  "email": "[email protected]",
  "phone": "+1123456789",
  "reference": "Project 221",
  "doorCode": 1234,
  "attention": "Jane"
}