SalesChannelAddresses

Retrieve Sales Channel Address

get

Retrieve a specific Sales Channel Address by ID

Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
chevron-right
200

Sales Channel Address retrieved successfully

application/json
get
/api/v1/channel/{channel_id}/addresses/{id}/

Update Sales Channel Address

put

Update a specific Sales Channel Address by ID

Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
idintegerRequired

Unique identifier of the resource

Example: 1
Body
Responses
chevron-right
200

Sales Channel Address updated

No content

put
/api/v1/channel/{channel_id}/addresses/{id}/

No content

Delete Sales Channel Address

delete

Delete Sales Channel Address for a specific channel.

Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
delete
/api/v1/channel/{channel_id}/addresses/{id}/

No content

Partial Update Sales Channel Address

patch

Partial update a specific Sales Channel Address by ID

Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
idintegerRequired

Unique identifier of the resource

Example: 1
Body
Responses
chevron-right
200

Sales Channel Address updated

No content

patch
/api/v1/channel/{channel_id}/addresses/{id}/

No content

Retrieve Sales Channel Cities with details

get

Retrieve a specific Sales Channel Cities by ID with details

Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
chevron-right
200

Sales Channel Address retrieved successfully with details

application/json
get
/api/v1/channel/{channel_id}/addresses/{id}/detailed/

List Sales Channel Addresses

get

List Sales Channel Addresses

Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
Query parameters
pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1
limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10
pk__ininteger[]Optional

Filter by multiple primary key values (comma-separated list of integers)

emailstring · emailOptional

Email address of the customer

Example: [email protected]
phone_numberstringOptional

Phone number of the customer

Example: +123456789
first_namestringOptional

First name of the customer

Example: John
last_namestringOptional

Last name of the customer

Example: Doe
customer_idintegerOptional

Filter by customer ID.

Example: 123
country_idinteger · min: 1Optional

Filter by County ID

township_idinteger · min: 1Optional

Filter by Township ID

city_idinteger · min: 1Optional

Filter by City ID

district_idinteger · min: 1Optional

Filter by District ID

is_activebooleanOptional

Filter by active status (True or False)

postcodestringOptional

Filter by Postcode

line__exactstringOptional

Filters by exact line

line__iexactstringOptional

Filters case insensitive by exact line

line__containsstringOptional

Filter by line containing the given string

line__icontainsstringOptional

Filter by line case-insensitive containing the given string

title__exactstringOptional

Filters by exact title

title__iexactstringOptional

Filters case insensitive by exact title

title__containsstringOptional

Filter by title containing the given string

title__icontainsstringOptional

Filter by title case-insensitive containing the given string

notes__exactstringOptional

Filters by exact notes

notes__iexactstringOptional

Filters case insensitive by exact notes

notes__containsstringOptional

Filter by notes containing the given string

notes__icontainsstringOptional

Filter by notes case-insensitive containing the given string

company_name__exactstringOptional

Filters by exact company_name

company_name__iexactstringOptional

Filters case insensitive by exact company_name

company_name__containsstringOptional

Filter by company_name containing the given string

company_name__icontainsstringOptional

Filter by company_name case-insensitive containing the given string

tax_office__exactstringOptional

Filters by exact tax_office

tax_office__iexactstringOptional

Filters case insensitive by exact tax_office

tax_office__containsstringOptional

Filter by tax_office containing the given string

tax_office__icontainsstringOptional

Filter by tax_office case-insensitive containing the given string

tax_no__exactstringOptional

Filters by exact tax_no

tax_no__iexactstringOptional

Filters case insensitive by exact tax_no

tax_no__containsstringOptional

Filter by tax_no containing the given string

tax_no__icontainsstringOptional

Filter by tax_no case-insensitive containing the given string

hash_data__exactstringOptional

Filters by exact hash_data

hash_data__iexactstringOptional

Filters case insensitive by exact hash_data

hash_data__containsstringOptional

Filter by hash_data containing the given string

hash_data__icontainsstringOptional

Filter by hash_data case-insensitive containing the given string

e_bill_taxpayerbooleanOptional

Filter by e_bill_taxpayer

city__priorityintegerOptional

Filter by city's priority

Example: 1
city__country_idinteger · min: 1Optional

Filter by City's County ID

city__postcodestringOptional

Filter by City's Postcode

district__city_idinteger · min: 1Optional

Filter by District's City ID

district__township_idinteger · min: 1Optional

Filter by District's Township ID

district__postcodestringOptional

Filter by District's Postcode

township__priorityintegerOptional

Filter by township's priority

Example: 1
township__city_idinteger · min: 1Optional

Filter by Township's City ID

township__postcodestringOptional

Filter by Township's Postcode

retail_store_idinteger · min: 1Optional

Filter by Retail Store ID

mapping__integration_typestring · enumOptional

Filter by integration mapping object's integration type

Possible values:
mapping__code__exactstringOptional

Filter by integration mapping object's code

hyperbooleanOptional

Activate id to hyperlink the response data.

Responses
chevron-right
200

OK

application/json
get
/api/v1/channel/{channel_id}/addresses/

Create Sales Channel Address

post

Create Sales Channel Address for a specific channel.

Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
Body
Responses
post
/api/v1/channel/{channel_id}/addresses/

List Sales Channel Addresses with details

get

List Sales Channel Addresses with details

Authorizations
AuthorizationstringRequired
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
Query parameters
pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1
limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10
pk__ininteger[]Optional

Filter by multiple primary key values (comma-separated list of integers)

emailstring · emailOptional

Email address of the customer

Example: [email protected]
phone_numberstringOptional

Phone number of the customer

Example: +123456789
first_namestringOptional

First name of the customer

Example: John
last_namestringOptional

Last name of the customer

Example: Doe
customer_idintegerOptional

Filter by customer ID.

Example: 123
country_idinteger · min: 1Optional

Filter by County ID

township_idinteger · min: 1Optional

Filter by Township ID

city_idinteger · min: 1Optional

Filter by City ID

district_idinteger · min: 1Optional

Filter by District ID

is_activebooleanOptional

Filter by active status (True or False)

postcodestringOptional

Filter by Postcode

line__exactstringOptional

Filters by exact line

line__iexactstringOptional

Filters case insensitive by exact line

line__containsstringOptional

Filter by line containing the given string

line__icontainsstringOptional

Filter by line case-insensitive containing the given string

title__exactstringOptional

Filters by exact title

title__iexactstringOptional

Filters case insensitive by exact title

title__containsstringOptional

Filter by title containing the given string

title__icontainsstringOptional

Filter by title case-insensitive containing the given string

notes__exactstringOptional

Filters by exact notes

notes__iexactstringOptional

Filters case insensitive by exact notes

notes__containsstringOptional

Filter by notes containing the given string

notes__icontainsstringOptional

Filter by notes case-insensitive containing the given string

company_name__exactstringOptional

Filters by exact company_name

company_name__iexactstringOptional

Filters case insensitive by exact company_name

company_name__containsstringOptional

Filter by company_name containing the given string

company_name__icontainsstringOptional

Filter by company_name case-insensitive containing the given string

tax_office__exactstringOptional

Filters by exact tax_office

tax_office__iexactstringOptional

Filters case insensitive by exact tax_office

tax_office__containsstringOptional

Filter by tax_office containing the given string

tax_office__icontainsstringOptional

Filter by tax_office case-insensitive containing the given string

tax_no__exactstringOptional

Filters by exact tax_no

tax_no__iexactstringOptional

Filters case insensitive by exact tax_no

tax_no__containsstringOptional

Filter by tax_no containing the given string

tax_no__icontainsstringOptional

Filter by tax_no case-insensitive containing the given string

hash_data__exactstringOptional

Filters by exact hash_data

hash_data__iexactstringOptional

Filters case insensitive by exact hash_data

hash_data__containsstringOptional

Filter by hash_data containing the given string

hash_data__icontainsstringOptional

Filter by hash_data case-insensitive containing the given string

e_bill_taxpayerbooleanOptional

Filter by e_bill_taxpayer

city__priorityintegerOptional

Filter by city's priority

Example: 1
city__country_idinteger · min: 1Optional

Filter by City's County ID

city__postcodestringOptional

Filter by City's Postcode

district__city_idinteger · min: 1Optional

Filter by District's City ID

district__township_idinteger · min: 1Optional

Filter by District's Township ID

district__postcodestringOptional

Filter by District's Postcode

township__priorityintegerOptional

Filter by township's priority

Example: 1
township__city_idinteger · min: 1Optional

Filter by Township's City ID

township__postcodestringOptional

Filter by Township's Postcode

retail_store_idinteger · min: 1Optional

Filter by Retail Store ID

mapping__integration_typestring · enumOptional

Filter by integration mapping object's integration type

Possible values:
mapping__code__exactstringOptional

Filter by integration mapping object's code

hyperbooleanOptional

Activate id to hyperlink the response data.

Responses
chevron-right
200

OK

application/json
get
/api/v1/channel/{channel_id}/addresses/detailed/

Last updated

Was this helpful?