Skip to main content
PUT
Update an Equipment Order

Authorizations

Authorization
string
header
required

Enter token in following format: Bearer

Path Parameters

leadId
string
required
equipmentOrderId
string
required

Body

application/json
shipping
enum<string> | null
Available options:
ups_ground,
ups_overnight
shippingAddress
enum<string> | null
Available options:
dba,
legal,
mailing,
iso,
other
address
string | null
Maximum string length: 250
billTo
enum<string> | null
Available options:
merchant,
partner,
signapay
status
enum<string> | null
Available options:
in_queue,
halted,
missing_info,
deployment_completed,
returned
trackingNumber
string | null
specialInstructions
string | null
Maximum string length: 200

Response

The updated equipment order.

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
entityId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
entityType
enum<string>
required
Available options:
lead,
client,
user,
processor,
document,
ticket,
transactions,
batch,
statement
shipping
enum<string> | null
required
Available options:
ups_ground,
ups_overnight
shippingAddress
enum<string> | null
required
Available options:
dba,
legal,
mailing,
iso,
other
address
string | null
required
Maximum string length: 250
billTo
enum<string> | null
required
Available options:
merchant,
partner,
signapay
status
enum<string> | null
required
Available options:
in_queue,
halted,
missing_info,
deployment_completed,
returned
trackingNumber
string | null
required
specialInstructions
string | null
required
Maximum string length: 200
createdAt
string
required
createdBy
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
updatedAt
string
required
updatedBy
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$