API Reference
Knowledge Base

List all sales order addresses

get
https://api.katanamrp.com/v1/sales_order_addresses

Returns a list of sales order addresses you’ve previously created. The sales order addresses are returned in sorted order, with the most recent sales order addresses appearing first.

Query Params
ids
array of integers

Filters sales order addresses by an array of IDs

ids
sales_order_ids
array of integers

Filters sales order addresses by an array of sales order IDs

sales_order_ids
enum

Filters sales order addresses by a entity_type

Allowed:
string

Filters sales order addresses by a first_name

string

Filters sales order addresses by a last_name

string

Filters sales order addresses by an company

string

Filters sales order addresses by a line_1

string

Filters sales order addresses by a line_2

string

Filters sales order addresses by a city

string

Filters sales order addresses by a state

string

Filters sales order addresses by a zip

string

Filters sales order addresses by a country

string

Filters sales order addresses by a phone

boolean

Soft-deleted data is excluded from result set by default. Set to true to include it.

string

Used for pagination (default is 50)

string

Used for pagination (default is 1)

string

Minimum value for created_at range. Must be compatible with ISO 8601 format

string

Maximum value for created_at range. Must be compatible with ISO 8601 format

string

Minimum value for updated_at range. Must be compatible with ISO 8601 format

string

Maximum value for updated_at range. Must be compatible with ISO 8601 format

Responses

Updated 7 months ago

Language
Credentials
Bearer
Response 
 Choose an example:
application/json
Updated 7 months ago