2 augustus 2024
List brand portals
GET
https://api.pack.cloud/v1/organizations/{organizationId}/brand-portals
Request
Path parameters
organizationIdstring
Query parameters
filter[brand_id]string
filter[subdomain]string
Response
OK
Body
idstring
ID of the brand portal
return_payment_integration_idstringnull
ID of the integration used for return shipping payments
return_payment_profile_referencestringnull
Profile reference for the return payment integration
Example:prl_9492402
subdomainstring
Subdomain of the portal
Example:demo-shop
urlstring
Url of the portal
Example:https://demo-shop.packcloud.me
color_primarystringnull
Primary color (HEX)
color_secondarystringnull
Secondary color (HEX)
color_backgroundstringnull
Background color (HEX)
order_reference_examplestringnull
Order reference example
Example:#1234
Enabled return methods
return_reason_requiredboolean
Return reason required
Enabled return refund types
return_period_in_daysinteger
Return period in days used in communication
Example:14
return_period_in_days_hardinteger
Return period in days used used to block new requests
Example:17
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25
OK
Body
idstring
ID of the brand portal
return_payment_integration_idstringnull
ID of the integration used for return shipping payments
return_payment_profile_referencestringnull
Profile reference for the return payment integration
Example:prl_9492402
subdomainstring
Subdomain of the portal
Example:demo-shop
urlstring
Url of the portal
Example:https://demo-shop.packcloud.me
color_primarystringnull
Primary color (HEX)
color_secondarystringnull
Secondary color (HEX)
color_backgroundstringnull
Background color (HEX)
order_reference_examplestringnull
Order reference example
Example:#1234
Enabled return methods
return_reason_requiredboolean
Return reason required
Enabled return refund types
return_period_in_daysinteger
Return period in days used in communication
Example:14
return_period_in_days_hardinteger
Return period in days used used to block new requests
Example:17
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25
OK
Body
idstring
ID of the brand portal
return_payment_integration_idstringnull
ID of the integration used for return shipping payments
return_payment_profile_referencestringnull
Profile reference for the return payment integration
Example:prl_9492402
subdomainstring
Subdomain of the portal
Example:demo-shop
urlstring
Url of the portal
Example:https://demo-shop.packcloud.me
color_primarystringnull
Primary color (HEX)
color_secondarystringnull
Secondary color (HEX)
color_backgroundstringnull
Background color (HEX)
order_reference_examplestringnull
Order reference example
Example:#1234
Enabled return methods
return_reason_requiredboolean
Return reason required
Enabled return refund types
return_period_in_daysinteger
Return period in days used in communication
Example:14
return_period_in_days_hardinteger
Return period in days used used to block new requests
Example:17
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25
OK
Body
idstring
ID of the brand portal
return_payment_integration_idstringnull
ID of the integration used for return shipping payments
return_payment_profile_referencestringnull
Profile reference for the return payment integration
Example:prl_9492402
subdomainstring
Subdomain of the portal
Example:demo-shop
urlstring
Url of the portal
Example:https://demo-shop.packcloud.me
color_primarystringnull
Primary color (HEX)
color_secondarystringnull
Secondary color (HEX)
color_backgroundstringnull
Background color (HEX)
order_reference_examplestringnull
Order reference example
Example:#1234
Enabled return methods
return_reason_requiredboolean
Return reason required
Enabled return refund types
return_period_in_daysinteger
Return period in days used in communication
Example:14
return_period_in_days_hardinteger
Return period in days used used to block new requests
Example:17
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25
OK
Body
idstring
ID of the brand portal
return_payment_integration_idstringnull
ID of the integration used for return shipping payments
return_payment_profile_referencestringnull
Profile reference for the return payment integration
Example:prl_9492402
subdomainstring
Subdomain of the portal
Example:demo-shop
urlstring
Url of the portal
Example:https://demo-shop.packcloud.me
color_primarystringnull
Primary color (HEX)
color_secondarystringnull
Secondary color (HEX)
color_backgroundstringnull
Background color (HEX)
order_reference_examplestringnull
Order reference example
Example:#1234
Enabled return methods
return_reason_requiredboolean
Return reason required
Enabled return refund types
return_period_in_daysinteger
Return period in days used in communication
Example:14
return_period_in_days_hardinteger
Return period in days used used to block new requests
Example:17
created_atstring
Creation time of resource
updated_atstring
Latest update time of resource
prevstringnull
Link to previous page
nextstringnull
Link to next page
per_pageinteger
Item count per page
Example:25
