Account Bulk Shipment Search V1

Body Params
string
Defaults to customer-account

customer-account

string
Defaults to account-bulk-shipment

account-bulk-shipment

string
Defaults to search

search

int32
Defaults to 1

1

string

The unique identifier that pertains to a particular session and is used to validate permissions

Data type: uuid
Required: yes
Letters: yes
Numbers: yes
Special: yes
Min: 36
Max: 36

string

Identifier for tracking this API call

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 36
Max: 36

string

Either brand uuid or shipment reference number must be provided

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 36
Max: 36

string



Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 36
Max: 36

string



Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 6
Max: 50

string



Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 36
Max: 36

string

Either shipment reference number or brand uuid must be provided

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 6
Max: 50

string
enum

Statuses are specified in order of process
Valid Values:
- Pending
- Canceled
- Processing
- Confirmed Received

Data type: string
Required: no
Letters: yes
Numbers: no
Special: no
Min: 4
Max: 50

Allowed:
string

Location tracking (e.g. branch number)

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 2
Max: 50

int32
Defaults to 0

Default is set to 0

Data type: number
Required: yes
Letters: no
Numbers: yes
Special: no
Min: 0
Max: 999,999

int32
Defaults to 100

Default set to 100

Data type: number
Required: yes
Letters: no
Numbers: yes
Special: no
Min: 1
Max: 1000

boolean
Defaults to false

Default is set to 0

Data type: boolean
Required: no
Letters: no
Numbers: yes
Special: no
Min: 1
Max: 1

Response

Language
Response
Choose an example:
application/json