Account Bulk Shipment Create V1

post

https://processor-api.uat1.pcaasa.com/?call=account-bulk-shipment-create-v1

Program availability: Prepaid, non-personalized

Body Params

app

string

Defaults to customer-account

customer-account

object

string

Defaults to account-bulk-shipment

account-bulk-shipment

action

string

Defaults to create

create

version

int32

Defaults to 1

sessionUuid

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

externalTranUuid

string

Identifier for tracking this API call

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

brandUuid

string

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

productUuid

string

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

accountSegmentUuid

string

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

accountSegmentReferenceNumber

string

Must be a unique number
If 'null', a new number will be generated

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

customLogo

string

Value defining the desired custom logo for plastic(s) being ordered

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

customDesign

string

Value defining the desired custom design for plastic(s) being ordered
Special characters allowed: dot (.), hyphen (-), underscore (_)

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

shipmentReferenceNumber

string

Must be a unique number
If if none is provided, a new number will be generated.

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

string

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

careOf

string

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

string

Email Address

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

phone

string

Allows hyphen, space, and parentheses

Data type: string
Required: yes
Letters: no
Numbers: yes
Special: no
Min: 10
Max: 20

PhoneCountryCode

int32

Defaults to 1

Current valid value: '1'(USA)
Allows '+' symbol

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

extension

string

Allows leading zeros (0)

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

phoneType

string

enum

Valid values:
- Primary
- Home
- Cell
- Work
- Fax
- Other

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

Allowed:

addressLine1

string

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

addressLine2

string

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

city

string

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

state

string

For U.S. Addresses this should be the 2 character state code.

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

postalCode

string

Allows hyphen and spaces

Data type: string
Required: yes
Letters: yes
Numbers: yes
Special: yes
Min: 3
Max: 20

country

string

Currently only USA

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

quantity

int32

Amount of plastics being created
Allows between 1 and 250

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

rushOrder

boolean

Defaults to false

0 = no
1 = yes
Default is set to 0

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

location

string

Location tracking (e.g. branch number)

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

deliveryInstructions

string

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 0
Max: 1000

200200