PrepBusiness LogoAPI Documentation

Outbound Shipments

GET/shipments/outbound

List outbound shipments

Optional attributes

  • Name
    filters[not_shipped]
    Type
    boolean
    Description
    Filter to only return shipments that have not been shipped

Request

GET/shipments/outbound
curl -G https://YOUR_DOMAIN/api/shipments/outbound \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
Loading response...
POST/shipments/outbound

Create an outbound shipment

Required attributes

  • Name
    name
    Type
    string
    Description
    The name of the outbound shipment My FBA Shipment
  • Name
    warehouse_id
    Type
    integer
    Description
    The ID of the warehouse for this shipment 1

Optional attributes

  • Name
    notes
    Type
    string
    Description
    Optional notes for the outbound shipment

Request

POST/shipments/outbound
curl -X POST https://YOUR_DOMAIN/api/shipments/outbound \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My FBA Shipment",
    "warehouse_id": 1
}'
Loading response...
GET/shipments/outbound/archived

List archived outbound shipments

Request

GET/shipments/outbound/archived
curl -G https://YOUR_DOMAIN/api/shipments/outbound/archived \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
GET/shipments/outbound/{outbound_shipment}

Get an outbound shipment

Required attributes

  • Name
    outbound_shipment
    Type
    integer
    Description
    The ID of the outbound shipment 1

Request

GET/shipments/outbound/{outbound_shipment}
curl -G https://YOUR_DOMAIN/api/shipments/outbound/{outbound-shipment} \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
Loading response...
POST/shipments/outbound/{outbound_shipment}/attachment

Upload an attachment to an outbound shipment

Required attributes

  • Name
    outbound_shipment
    Type
    integer
    Description
    The ID of the outbound shipment 1

Request

POST/shipments/outbound/{outbound_shipment}/attachment
curl -X POST https://YOUR_DOMAIN/api/shipments/outbound/{outbound-shipment}/attachment \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
Loading response...