PrepBusiness LogoAPI Documentation

Inbound Shipments

GET/shipments/inbound

List inbound shipments

Get a paginated list of active (non-archived) inbound shipments.

Optional attributes

  • Name
    filters[not_received]
    Type
    boolean
    Description
    When true, only return shipments that have not yet been received
  • Name
    page
    Type
    integer
    Description
    The page number to retrieve (1-indexed) 1
  • Name
    per_page
    Type
    integer
    Description
    The number of items per page 15

Request

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

Create an inbound shipment

Create a new inbound shipment for the current merchant.

Required attributes

  • Name
    name
    Type
    string
    Description
    The name of the shipment January Restock 2024
  • Name
    warehouse_id
    Type
    integer
    Description
    The ID of the destination warehouse 5

Optional attributes

  • Name
    notes
    Type
    string
    Description
    Optional notes about the shipment Handle with care

Request

POST/shipments/inbound
curl -X POST https://YOUR_DOMAIN/api/shipments/inbound \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "January Restock 2024",
    "warehouse_id": 5,
    "notes": "Handle with care"
}'
Loading response...
GET/shipments/inbound/archived

List archived inbound shipments

Get a paginated list of archived inbound shipments.

Optional attributes

  • Name
    page
    Type
    integer
    Description
    The page number to retrieve (1-indexed) 1
  • Name
    per_page
    Type
    integer
    Description
    The number of items per page 15

Request

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

Show an inbound shipment

Get a single inbound shipment by its ID, including attachments, service lines, warehouse, and tags.

Required attributes

  • Name
    inbound_shipment
    Type
    integer
    Description
    The ID of the inbound shipment 1001

Request

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

Update an inbound shipment

Update an existing inbound shipment.

Required attributes

  • Name
    inbound_shipment
    Type
    integer
    Description
    The ID of the inbound shipment 1001

Optional attributes

  • Name
    name
    Type
    string
    Description
    The name of the shipment January Restock 2024 (Updated)
  • Name
    notes
    Type
    string
    Description
    Notes about the shipment Handle with care
  • Name
    internal_notes
    Type
    string
    Description
    Internal notes visible only to staff Priority processing requested
  • Name
    eta
    Type
    string
    Description
    The estimated time of arrival 2024-01-24T00:00:00Z

Request

PUT/shipments/inbound/{inbound_shipment}
curl -X PUT https://YOUR_DOMAIN/api/shipments/inbound/{inbound-shipment} \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "January Restock 2024 (Updated)",
    "notes": "Handle with care",
    "internal_notes": "Priority processing requested",
    "eta": "2024-01-24T00:00:00Z"
}'
Loading response...
DELETE/shipments/inbound/{inbound_shipment}

Delete an inbound shipment

Delete an inbound shipment by its ID

Required attributes

  • Name
    inbound_shipment
    Type
    integer
    Description
    The ID of the inbound shipment 1001

Request

DELETE/shipments/inbound/{inbound_shipment}
curl -X DELETE https://YOUR_DOMAIN/api/shipments/inbound/{inbound-shipment} \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
POST/shipments/inbound/{inbound_shipment}/submit

Submit an inbound shipment

Mark an inbound shipment as shipped. Optionally include a carrier and tracking numbers.

Required attributes

  • Name
    inbound_shipment
    Type
    integer
    Description
    The ID of the inbound shipment 1001

Optional attributes

  • Name
    carrier
    Type
    string
    Description
    The carrier used for shipping ups
  • Name
    tracking_numbers
    Type
    array<string>
    Description
    List of tracking numbers. Required when carrier is provided.

Request

POST/shipments/inbound/{inbound_shipment}/submit
curl -X POST https://YOUR_DOMAIN/api/shipments/inbound/{inbound-shipment}/submit \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "carrier": "ups",
    "tracking_numbers": [
        "1Z999AA10123456784"
    ]
}'
Loading response...
POST/shipments/inbound/{inbound_shipment}/receive

Receive an inbound shipment

Mark an inbound shipment as received at the warehouse.

Required attributes

  • Name
    inbound_shipment
    Type
    integer
    Description
    The ID of the inbound shipment 1001

Request

POST/shipments/inbound/{inbound_shipment}/receive
curl -X POST https://YOUR_DOMAIN/api/shipments/inbound/{inbound-shipment}/receive \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"
Loading response...
POST/shipments/inbound/{inbound_shipment}/add-tracking

Add tracking to an inbound shipment

Add tracking numbers from one carrier to an inbound shipment. The numbers are added alongside the shipment's existing tracking; a number the shipment already has is left unchanged. When no carrier is provided, the shipment is not changed.

Required attributes

  • Name
    inbound_shipment
    Type
    integer
    Description
    The ID of the inbound shipment 1001

Optional attributes

  • Name
    carrier
    Type
    string
    Description
    The carrier the tracking numbers belong to ups
  • Name
    tracking_numbers
    Type
    array<string>
    Description
    The tracking numbers to add. Required when carrier is provided.

Request

POST/shipments/inbound/{inbound_shipment}/add-tracking
curl -X POST https://YOUR_DOMAIN/api/shipments/inbound/{inbound-shipment}/add-tracking \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "carrier": "ups",
    "tracking_numbers": [
        "1Z999AA10123456784"
    ]
}'
Loading response...
POST/shipments/inbound/batch/archive

Batch archive inbound shipments

Archive multiple inbound shipments at once.

Required attributes

  • Name
    shipment_ids
    Type
    array<integer>
    Description
    The IDs of the shipments to archive

Request

POST/shipments/inbound/batch/archive
curl -X POST https://YOUR_DOMAIN/api/shipments/inbound/batch/archive \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "shipment_ids": [
        1001
    ]
}'
Loading response...