Outbound

POST Create a shipment

Use the POST method to send a new or update an outbound shipment.

If the shipment is successfully received, you'll get a response code of 202 ACCEPTED. This means the order was accepted to be processed into our system. Shipments generally process into the system rather quickly, depending on system load. You can retrive the status of the shipment using the status call or the order details call.

Request

POST /v2/outboud/{order_number}

Requirements Example #1 Example #2
  • Each request contains only one shipment.
  • The order_number in the URL must match the order_number field in the body of the request.
  • The request body is the shipment resource.
Required fields
Field name Data type Description
order_number string The order number associated with this shipment; must match the order_number in the URL
business_unit string Your company code in our system.
shipping.service_code string This is the shipping method to use.
shipping.address address The address in which to send the shipment.

The following address fields are required:

  • name
  • address1
  • city
  • province_code
  • zip
  • country_code
line_items array The items in which to ship.

The following fields must be included in each item entry:

  • line_number
  • item
  • qty

Response JSON 

    HTTP/1.1 202 Accepted
    {
        "status": "Pending"    
    }

GET Retrieve Shipment Status

Request

GET /v2/outbound/status?order_number={order_number}

Parameters
order_number string
The order number used when creating the shipment
Statuses
Pending The shipment is still being processed. You should retry the request at a later time.
Processed The shipment was successfully created.
Review The shipment was created, but there are issues that require staff review. Staff will review the order and contact you if needed.
Failed The shipment could not be created.

Response JSON 

    HTTP/1.1 200 OK
    {
        "order_number": "ORD1234"
        "status": "Processed"    
    }

GET Retrieve Shipment(s)

Request

GET /v2/outboud?order_number={order_number}

Parameters
order_number string
The order number used when creating the shipment.
Response

This returns the shipment object, which includes an additional property containers. The containers property contains the information about the shipment's boxes and tracking information.

Response JSON 

HTTP/1.1 200 OK
{
    "shipment": {
        "order_number": "SO1234",
        "business_unit": "C1234",
        "co_number": "CO123456",
        "created_date": "2025-06-16 08:31:32.0",
        "updated_date": "2025-06-16 09:57:10.0",
        "status": "Complete",
        "custom1": "12345678",
        "shipping": {
            "service_code": "UPR",
            "address": {
                "name": "John Doe",
                "address1": "6402 Corporate Drive",
                "city": "Indianapolis",
                "province_code": "IN",
                "zip": "46278",
                "country_code": "US",
                "phone": "555-555-5555",
                "email": "john.doe@email.com"
            }
        },
        "line_items": [{
            "line_number": "987654321",
            "item": "ITM123",
            "qty": 1,
            "shipped_qty": 1
        }],
        "containers": [{
            "ship_date": "2024-07-19T12:08:07-05:00",
            "ship_via": "UPS Mail Innovations",
            "weight": 1.2,            
            "tracking_number": "9999999999",
            "tracking_url": "http://wwwapps.ups.com/WebTracking/track?track=yes&loc=en_us&trackNums=9999999999",
            "items": [{
                "line_number": "987654321",
                "item": "ITM123",
                "shipped_qty": 1
            }]
        }]
    }
}
©2024 Verde Fulfillment USA