Addressr Resource

Introduction

Every business partner may have several addresses. Addresses may be used for invoicing and shipping slips.

Example URL

https://api.openpublishing.com/resource/v3/business_partners/[ID]/addresses/[ID]

Allowed methods: GET, PUT, DELETE.

To create an address POST an object to https://api.openpublishing.com/resource/v3/business_partners/[ID]/addresses.

List all addresses:

https://api.openpublishing.com/resource/v3/business_partners/[ID]/addresses

Fields

Academic title

academic_title refers to the academic title of the person addressed in the address.

First name and last name

first_name and last_name refer to the name of the person addressed in the address.

Company

company refer to the company name addressed in the address.

Street, Zip, City, State and country

street, zip, city point to the location of the address. state may describe a federal state and country the two character code of a country.

Additional information

additional_information may contain additional information for the address, e.g. floor, building section etc.

Phone number

phone_number is the phone number for a contact - may be used to contact the recipient prior delivery.

Post office box

post_office_box Post office box address.

Preferred invoice and shipping address

preferred_invoice_address and preferred_shipping_address are flags which indicate if an address is the preferred shipping address. If one address is marked as preferred, all previously marked addresses are unmarked.

Example JSON

{
   "_id": 1,
   "academic_title": "Dr.",
   "additional_information": null,
   "city": "Munich",
   "company": null,
   "country": "DE",
   "first_name": "John",
   "last_name": "Doe",
   "phone_number": "089\/1234567890",
   "post_office_box": null,
   "preferred_invoice_address": false,
   "preferred_shipping_address": false,
   "state": null,
   "street": "Trappentreustrasse 1",
   "zip": "81000"
}