Partner Address API

Manage partner shipping and billing addresses — retrieval, creation, modification, and deletion

Endpoints

GET Get record
GET Get list
POST Save / create
POST Delete

Authentication

Every API request requires sending the X-API-KEY header.

X-API-KEY: {your_api_key}

Still have questions?

Open a ticket with us, or browse our help center.

Base URL

https://{tenant}.logzi.com/api/partner_address/

Every request returns a JSON response. On success result.code == 1; on error result.code == 0. A partner address is a shipping or billing location assigned to a partner — a partner can have multiple addresses.

GET /api/partner_address/get

Retrieve a single partner address by identifier, partner identifier, or checksum.

Query parameters

Parameter	Type	Description
`id`	int	Unique identifier of the address
`partner_id`	int	Partner identifier — the first address is returned
`checksum`	string	Address checksum identifier
`language_id`	int	Language identifier for translation

Example request

GET /api/partner_address/get?id=15
X-API-KEY: {your_api_key}

GET /api/partner_address/list

Paginated retrieval of the partner address list with filtering options.

Query parameters

Parameter	Type	Description
`list_offset`	int	Pagination offset (default: 0)
`partner_id`	int	Filter by partner identifier
`list_condition[partner_id]`	int	Filter by partner identifier (in the condition object)
`list_condition[partner_address_status_id]`	int	Filter by address status
`language_id`	int	Language identifier

Example request

GET /api/partner_address/list?partner_id=42&list_offset=0
X-API-KEY: {your_api_key}

POST /api/partner_address/save

Create or update a partner address. For a new address use data[id] = 0.

POST fields — data object

Field	Type	Description
`id`	int	0 = new address, >0 = update
`partner_id`	int	Partner identifier (required for a new address)
`country_id`	int	Country identifier
`zip`	string	ZIP code
`city`	string	City
`address`	string	Street, house number
`partner_address_type_id`	int	Address type (billing, shipping, etc.)
`address_user_name`	string	Contact person's name at the address
`address_comment`	string	Comment for the address
`address_building`	string	Building designation
`address_door`	string	Door
`address_floor`	string	Floor
`address_number`	string	Door / apartment number
`address_stairwell`	string	Stairwell
`district`	string	District (without a dot, e.g. "XIV")
`partner_address_status_id`	int	Address status identifier
`outer_resource_id`	string	External system identifier

Example request

POST /api/partner_address/save
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "partner_id": 42,
    "country_id": 1,
    "zip": "1051",
    "city": "Budapest",
    "address": "Nádor utca 10.",
    "partner_address_type_id": 1,
    "address_user_name": "Raktáros",
    "district": "V"
  }
}

POST /api/partner_address/delete

Delete a partner address by identifier.

POST fields — data object

Field	Type	Required	Description
`id`	int		Identifier of the address to delete

Example request

POST /api/partner_address/delete
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "id": 15 } }

Get in touch with us

Interested in our software? Feel free to write to us!

Send an inquiry

Need help?

If you can't find the answer and need assistance

Browse the help center

Create your account now,
pay later!

Try it free for 3 days, no risk, no obligation!