Fleet Management API Beta

Sections

Theme switcher

Create a batch order of cards

Header Parameters

Authorizationstring

Body Parameters

account_idstring

A unique identifier for the account.

Min length
1
address_typestring

Specifies the type of shipping address to use for an order, impacting how the address is processed.

Values:

  • SPECIAL: Requires providing full address information in the request. Use this value when the shipping address is unique and not associated with an existing address on file.

  • ADMIN, MAILING, BILLING (etc.): For these address types, the shipping address will be retrieved from the address on file associated with the specified type.

  • CARD_SHIPPING: (Only incl...

Enum values:
AdminBillingCard ShippingMailingPhysicalPrimarySpecialTax
batch_order_numberinteger Required

Batch order number associated with card creation. Use this value to group cards together and order them as a single batch. This value can be set by the user on the card creation request.

carrier_namestring

Name of the shipping carrier. Required if useCustomerShipping is true.

requested_bystring

If no value is present the client id will be used.

shipping_informationobject

Information required to ship items on an order

Show child attributes

Response

207
Object

The batch order that was created.

Response Attributes

batch_order_numberinteger

Batch order number associated with card creation. Use this value to group cards together and order them as a single batch. This value can be set by the user on the card creation request.

order_responseobject

Results from placing one or many card orders

Show child attributes

400
Object

Invalid request body

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
401
Object

401 (Unauthorized)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
403
Object

403 (Forbidden)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
500
Object

500 (Internal Server Error)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?