GuidesAPI Reference
API Reference

Create a Shipment

post
https://test.apruve.com/api/v4/invoices//shipments
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the Invoice owning the Shipments

Body Params
integer

The total amount, in cents, of the items in the shipment. Ideally, this would be the sum of the price of all ShipmentItems, plus tax and shipping amounts, but this is not required. The amount_cents is used as the shipment total if it is supplied. Otherwise, the total will be calculated from the other values.

integer

The total tax amount, in cents, of the taxes for this shipment.

integer

The total shipping amount, in cents, for the shipping charges for this shipment.

string

Only USD is supported at this time.

string

The name of the shipping company

string

The tracking number from the shipper

string
required

The ISO8601 date that the shipment was sent

string

The ISO8601 date which represents when the shipment was delivered to the customer

string

Notes from the merchant to the customer

string
enum
Defaults to fulfilled

The status of the shipment. Indicates if this shipment fulfills all the items on the invoice.

Allowed:
string

Optional shipment ID from the merchant's system

shipment_items
array of objects

The items included in this Shipment

shipment_items
Responses

Updated 9 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago