The Shipment object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

status string

Default: draft

pickup_from_type string

Default: Company

pickup_company string
pickup_customer string
pickup_supplier string
pickup string
pickup_address_name string required
pickup_address string
pickup_contact_name string
pickup_contact_email string
pickup_contact string
delivery_to_type string

Default: Customer

delivery_company string
delivery_customer string
delivery_supplier string
delivery_to string
delivery_address_name string required
delivery_address string
delivery_contact_name string
delivery_contact_email string
delivery_contact string
parcel_template string
pallets string

Default: No

value_of_goods number required
pickup_date string required
pickup_from string

Default: 09:00

pickup_to string

Default: 17:00

shipment_type string

Default: Goods

pickup_type string

Default: Pickup

description_of_content string required
service_provider string
shipment_id string
shipment_amount number
tracking_url string
carrier string
carrier_service string
awb_number string
tracking_status string
tracking_status_info string
incoterm string
pickup_contact_person string
total_weight number
The Shipment object 
{
  "id": "shipment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "pickup_from_type": "Company",
  "pickup_company": "Example Corp",
  "pickup_customer": "pickup_customer_example",
  "pickup_supplier": "pickup_supplier_example",
  "pickup": "pickup_example",
  "pickup_address_name": "pickup_address_name_example",
  "pickup_address": "pickup_address_example",
  "pickup_contact_name": "pickup_contact_name_example",
  "pickup_contact_email": "user@example.com",
  "pickup_contact": "pickup_contact_example",
  "delivery_to_type": "Customer",
  "delivery_company": "Example Corp",
  "delivery_customer": "delivery_customer_example",
  "delivery_supplier": "delivery_supplier_example",
  "delivery_to": "delivery_to_example",
  "delivery_address_name": "delivery_address_name_example",
  "delivery_address": "delivery_address_example",
  "delivery_contact_name": "delivery_contact_name_example",
  "delivery_contact_email": "user@example.com",
  "delivery_contact": "delivery_contact_example",
  "parcel_template": "parcel_template_example",
  "pallets": "No",
  "value_of_goods": 0,
  "pickup_date": "2024-01-15",
  "pickup_from": "09: 00",
  "pickup_to": "17: 00",
  "shipment_type": "Goods",
  "pickup_type": "Pickup",
  "description_of_content": "description_of_content_example",
  "service_provider": "service_provider_example",
  "shipment_id": "shipment_id_example",
  "shipment_amount": 0,
  "tracking_url": "tracking_url_example",
  "carrier": "carrier_example",
  "carrier_service": "carrier_service_example",
  "awb_number": "awb_number_example",
  "tracking_status": "tracking_status_example",
  "tracking_status_info": "tracking_status_info_example",
  "incoterm": "incoterm_example",
  "pickup_contact_person": "pickup_contact_person_example",
  "total_weight": 0
}
GET /api/stock/shipment/{id}

Retrieve a shipment

Retrieves the details of an existing shipment. Supply the unique shipment ID that was returned from a previous request.

Path parameters

id string required

The identifier of the shipment to retrieve.

Returns

Returns the shipment object if a valid identifier was provided.

GET /api/stock/shipment/{id} 
curl https://api.overplane.dev/api/stock/shipment/shipment_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "shipment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "pickup_from_type": "Company",
  "pickup_company": "Example Corp",
  "pickup_customer": "pickup_customer_example",
  "pickup_supplier": "pickup_supplier_example",
  "pickup": "pickup_example",
  "pickup_address_name": "pickup_address_name_example",
  "pickup_address": "pickup_address_example",
  "pickup_contact_name": "pickup_contact_name_example",
  "pickup_contact_email": "user@example.com",
  "pickup_contact": "pickup_contact_example",
  "delivery_to_type": "Customer",
  "delivery_company": "Example Corp",
  "delivery_customer": "delivery_customer_example",
  "delivery_supplier": "delivery_supplier_example",
  "delivery_to": "delivery_to_example",
  "delivery_address_name": "delivery_address_name_example",
  "delivery_address": "delivery_address_example",
  "delivery_contact_name": "delivery_contact_name_example",
  "delivery_contact_email": "user@example.com",
  "delivery_contact": "delivery_contact_example",
  "parcel_template": "parcel_template_example",
  "pallets": "No",
  "value_of_goods": 0,
  "pickup_date": "2024-01-15",
  "pickup_from": "09: 00",
  "pickup_to": "17: 00",
  "shipment_type": "Goods",
  "pickup_type": "Pickup",
  "description_of_content": "description_of_content_example",
  "service_provider": "service_provider_example",
  "shipment_id": "shipment_id_example",
  "shipment_amount": 0,
  "tracking_url": "tracking_url_example",
  "carrier": "carrier_example",
  "carrier_service": "carrier_service_example",
  "awb_number": "awb_number_example",
  "tracking_status": "tracking_status_example",
  "tracking_status_info": "tracking_status_info_example",
  "incoterm": "incoterm_example",
  "pickup_contact_person": "pickup_contact_person_example",
  "total_weight": 0
}
GET /api/stock/shipment

List all shipments

Returns a list of shipments. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of shipment objects.

GET /api/stock/shipment 
curl https://api.overplane.dev/api/stock/shipment \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "shipment_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "pickup_from_type": "Company",
      "pickup_company": "Example Corp",
      "pickup_customer": "pickup_customer_example",
      "pickup_supplier": "pickup_supplier_example",
      "pickup": "pickup_example",
      "pickup_address_name": "pickup_address_name_example",
      "pickup_address": "pickup_address_example",
      "pickup_contact_name": "pickup_contact_name_example",
      "pickup_contact_email": "user@example.com",
      "pickup_contact": "pickup_contact_example",
      "delivery_to_type": "Customer",
      "delivery_company": "Example Corp",
      "delivery_customer": "delivery_customer_example",
      "delivery_supplier": "delivery_supplier_example",
      "delivery_to": "delivery_to_example",
      "delivery_address_name": "delivery_address_name_example",
      "delivery_address": "delivery_address_example",
      "delivery_contact_name": "delivery_contact_name_example",
      "delivery_contact_email": "user@example.com",
      "delivery_contact": "delivery_contact_example",
      "parcel_template": "parcel_template_example",
      "pallets": "No",
      "value_of_goods": 0,
      "pickup_date": "2024-01-15",
      "pickup_from": "09: 00",
      "pickup_to": "17: 00",
      "shipment_type": "Goods",
      "pickup_type": "Pickup",
      "description_of_content": "description_of_content_example",
      "service_provider": "service_provider_example",
      "shipment_id": "shipment_id_example",
      "shipment_amount": 0,
      "tracking_url": "tracking_url_example",
      "carrier": "carrier_example",
      "carrier_service": "carrier_service_example",
      "awb_number": "awb_number_example",
      "tracking_status": "tracking_status_example",
      "tracking_status_info": "tracking_status_info_example",
      "incoterm": "incoterm_example",
      "pickup_contact_person": "pickup_contact_person_example",
      "total_weight": 0
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/stock/shipment

Create a shipment

Creates a new shipment object.

Body parameters

status string

Default: draft

pickup_from_type string

Default: Company

pickup_company string
pickup_customer string
pickup_supplier string
pickup string
pickup_address_name string required
pickup_address string
pickup_contact_name string
pickup_contact_email string
pickup_contact string
delivery_to_type string

Default: Customer

delivery_company string
delivery_customer string
delivery_supplier string
delivery_to string
delivery_address_name string required
delivery_address string
delivery_contact_name string
delivery_contact_email string
delivery_contact string
parcel_template string
pallets string

Default: No

value_of_goods number required
pickup_date string required
pickup_from string

Default: 09:00

pickup_to string

Default: 17:00

shipment_type string

Default: Goods

pickup_type string

Default: Pickup

description_of_content string required
service_provider string
shipment_id string
shipment_amount number
tracking_url string
carrier string
carrier_service string
awb_number string
tracking_status string
tracking_status_info string
incoterm string
pickup_contact_person string
total_weight number

Returns

Returns the newly created shipment object if the call succeeded.

POST /api/stock/shipment 
curl https://api.overplane.dev/api/stock/shipment \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"pickup_address_name":"pickup_address_name_example","delivery_address_name":"delivery_address_name_example","value_of_goods":0,"pickup_date":"2024-01-15","description_of_content":"description_of_content_example"}'
Response 
{
  "id": "shipment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "pickup_from_type": "Company",
  "pickup_company": "Example Corp",
  "pickup_customer": "pickup_customer_example",
  "pickup_supplier": "pickup_supplier_example",
  "pickup": "pickup_example",
  "pickup_address_name": "pickup_address_name_example",
  "pickup_address": "pickup_address_example",
  "pickup_contact_name": "pickup_contact_name_example",
  "pickup_contact_email": "user@example.com",
  "pickup_contact": "pickup_contact_example",
  "delivery_to_type": "Customer",
  "delivery_company": "Example Corp",
  "delivery_customer": "delivery_customer_example",
  "delivery_supplier": "delivery_supplier_example",
  "delivery_to": "delivery_to_example",
  "delivery_address_name": "delivery_address_name_example",
  "delivery_address": "delivery_address_example",
  "delivery_contact_name": "delivery_contact_name_example",
  "delivery_contact_email": "user@example.com",
  "delivery_contact": "delivery_contact_example",
  "parcel_template": "parcel_template_example",
  "pallets": "No",
  "value_of_goods": 0,
  "pickup_date": "2024-01-15",
  "pickup_from": "09: 00",
  "pickup_to": "17: 00",
  "shipment_type": "Goods",
  "pickup_type": "Pickup",
  "description_of_content": "description_of_content_example",
  "service_provider": "service_provider_example",
  "shipment_id": "shipment_id_example",
  "shipment_amount": 0,
  "tracking_url": "tracking_url_example",
  "carrier": "carrier_example",
  "carrier_service": "carrier_service_example",
  "awb_number": "awb_number_example",
  "tracking_status": "tracking_status_example",
  "tracking_status_info": "tracking_status_info_example",
  "incoterm": "incoterm_example",
  "pickup_contact_person": "pickup_contact_person_example",
  "total_weight": 0
}
PATCH /api/stock/shipment/{id}

Update a shipment

Updates the specified shipment by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the shipment to update.

Body parameters

status string

Default: draft

pickup_from_type string

Default: Company

pickup_company string
pickup_customer string
pickup_supplier string
pickup string
pickup_address_name string
pickup_address string
pickup_contact_name string
pickup_contact_email string
pickup_contact string
delivery_to_type string

Default: Customer

delivery_company string
delivery_customer string
delivery_supplier string
delivery_to string
delivery_address_name string
delivery_address string
delivery_contact_name string
delivery_contact_email string
delivery_contact string
parcel_template string
pallets string

Default: No

value_of_goods number
pickup_date string
pickup_from string

Default: 09:00

pickup_to string

Default: 17:00

shipment_type string

Default: Goods

pickup_type string

Default: Pickup

description_of_content string
service_provider string
shipment_id string
shipment_amount number
tracking_url string
carrier string
carrier_service string
awb_number string
tracking_status string
tracking_status_info string
incoterm string
pickup_contact_person string
total_weight number

Returns

Returns the updated shipment object.

PATCH /api/stock/shipment/{id} 
curl https://api.overplane.dev/api/stock/shipment/shipment_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","pickup_from_type":"Company"}'
Response 
{
  "id": "shipment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "pickup_from_type": "Company",
  "pickup_company": "Example Corp",
  "pickup_customer": "pickup_customer_example",
  "pickup_supplier": "pickup_supplier_example",
  "pickup": "pickup_example",
  "pickup_address_name": "pickup_address_name_example",
  "pickup_address": "pickup_address_example",
  "pickup_contact_name": "pickup_contact_name_example",
  "pickup_contact_email": "user@example.com",
  "pickup_contact": "pickup_contact_example",
  "delivery_to_type": "Customer",
  "delivery_company": "Example Corp",
  "delivery_customer": "delivery_customer_example",
  "delivery_supplier": "delivery_supplier_example",
  "delivery_to": "delivery_to_example",
  "delivery_address_name": "delivery_address_name_example",
  "delivery_address": "delivery_address_example",
  "delivery_contact_name": "delivery_contact_name_example",
  "delivery_contact_email": "user@example.com",
  "delivery_contact": "delivery_contact_example",
  "parcel_template": "parcel_template_example",
  "pallets": "No",
  "value_of_goods": 0,
  "pickup_date": "2024-01-15",
  "pickup_from": "09: 00",
  "pickup_to": "17: 00",
  "shipment_type": "Goods",
  "pickup_type": "Pickup",
  "description_of_content": "description_of_content_example",
  "service_provider": "service_provider_example",
  "shipment_id": "shipment_id_example",
  "shipment_amount": 0,
  "tracking_url": "tracking_url_example",
  "carrier": "carrier_example",
  "carrier_service": "carrier_service_example",
  "awb_number": "awb_number_example",
  "tracking_status": "tracking_status_example",
  "tracking_status_info": "tracking_status_info_example",
  "incoterm": "incoterm_example",
  "pickup_contact_person": "pickup_contact_person_example",
  "total_weight": 0
}
DELETE /api/stock/shipment/{id}

Delete a shipment

Permanently deletes a shipment. This cannot be undone.

Path parameters

id string required

The identifier of the shipment to delete.

Returns

Returns a confirmation that the shipment has been deleted.

DELETE /api/stock/shipment/{id} 
curl https://api.overplane.dev/api/stock/shipment/shipment_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "shipment_abc123",
  "deleted": true
}
POST /api/stock/shipment/{id}/submit

Submit a shipment

Submits a draft shipment, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the shipment to act on.

Returns

Returns the shipment object with updated status.

POST /api/stock/shipment/{id}/submit 
curl https://api.overplane.dev/api/stock/shipment/shipment_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "shipment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "pickup_from_type": "Company",
  "pickup_company": "Example Corp",
  "pickup_customer": "pickup_customer_example",
  "pickup_supplier": "pickup_supplier_example",
  "pickup": "pickup_example",
  "pickup_address_name": "pickup_address_name_example",
  "pickup_address": "pickup_address_example",
  "pickup_contact_name": "pickup_contact_name_example",
  "pickup_contact_email": "user@example.com",
  "pickup_contact": "pickup_contact_example",
  "delivery_to_type": "Customer",
  "delivery_company": "Example Corp",
  "delivery_customer": "delivery_customer_example",
  "delivery_supplier": "delivery_supplier_example",
  "delivery_to": "delivery_to_example",
  "delivery_address_name": "delivery_address_name_example",
  "delivery_address": "delivery_address_example",
  "delivery_contact_name": "delivery_contact_name_example",
  "delivery_contact_email": "user@example.com",
  "delivery_contact": "delivery_contact_example",
  "parcel_template": "parcel_template_example",
  "pallets": "No",
  "value_of_goods": 0,
  "pickup_date": "2024-01-15",
  "pickup_from": "09: 00",
  "pickup_to": "17: 00",
  "shipment_type": "Goods",
  "pickup_type": "Pickup",
  "description_of_content": "description_of_content_example",
  "service_provider": "service_provider_example",
  "shipment_id": "shipment_id_example",
  "shipment_amount": 0,
  "tracking_url": "tracking_url_example",
  "carrier": "carrier_example",
  "carrier_service": "carrier_service_example",
  "awb_number": "awb_number_example",
  "tracking_status": "tracking_status_example",
  "tracking_status_info": "tracking_status_info_example",
  "incoterm": "incoterm_example",
  "pickup_contact_person": "pickup_contact_person_example",
  "total_weight": 0
}
POST /api/stock/shipment/{id}/cancel

Cancel a shipment

Cancels a submitted shipment, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the shipment to act on.

Returns

Returns the shipment object with updated status.

POST /api/stock/shipment/{id}/cancel 
curl https://api.overplane.dev/api/stock/shipment/shipment_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "shipment_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "pickup_from_type": "Company",
  "pickup_company": "Example Corp",
  "pickup_customer": "pickup_customer_example",
  "pickup_supplier": "pickup_supplier_example",
  "pickup": "pickup_example",
  "pickup_address_name": "pickup_address_name_example",
  "pickup_address": "pickup_address_example",
  "pickup_contact_name": "pickup_contact_name_example",
  "pickup_contact_email": "user@example.com",
  "pickup_contact": "pickup_contact_example",
  "delivery_to_type": "Customer",
  "delivery_company": "Example Corp",
  "delivery_customer": "delivery_customer_example",
  "delivery_supplier": "delivery_supplier_example",
  "delivery_to": "delivery_to_example",
  "delivery_address_name": "delivery_address_name_example",
  "delivery_address": "delivery_address_example",
  "delivery_contact_name": "delivery_contact_name_example",
  "delivery_contact_email": "user@example.com",
  "delivery_contact": "delivery_contact_example",
  "parcel_template": "parcel_template_example",
  "pallets": "No",
  "value_of_goods": 0,
  "pickup_date": "2024-01-15",
  "pickup_from": "09: 00",
  "pickup_to": "17: 00",
  "shipment_type": "Goods",
  "pickup_type": "Pickup",
  "description_of_content": "description_of_content_example",
  "service_provider": "service_provider_example",
  "shipment_id": "shipment_id_example",
  "shipment_amount": 0,
  "tracking_url": "tracking_url_example",
  "carrier": "carrier_example",
  "carrier_service": "carrier_service_example",
  "awb_number": "awb_number_example",
  "tracking_status": "tracking_status_example",
  "tracking_status_info": "tracking_status_info_example",
  "incoterm": "incoterm_example",
  "pickup_contact_person": "pickup_contact_person_example",
  "total_weight": 0
}

Line items

Child objects that belong to this shipment. These are accessed via the parent's ID.

Shipment Delivery Note

Attributes

idx integer
shipment_id string required
delivery_note string required
grand_total number

Endpoints

GET /api/stock/shipment-delivery-note?parent_id={id}
POST /api/stock/shipment-delivery-note
PATCH /api/stock/shipment-delivery-note/{id}
DELETE /api/stock/shipment-delivery-note/{id}
POST /api/stock/shipment-delivery-note/reorder
Shipment Delivery Note object 
{
  "id": "shipment-delivery-note_abc123",
  "idx": 1,
  "shipment_id": "shipment_id_example",
  "delivery_note": "delivery_note_example",
  "grand_total": 0
}

Shipment Parcel

Attributes

idx integer
shipment_id string required
length number
width number
height number
weight number required
count integer

Endpoints

GET /api/stock/shipment-parcel?parent_id={id}
POST /api/stock/shipment-parcel
PATCH /api/stock/shipment-parcel/{id}
DELETE /api/stock/shipment-parcel/{id}
POST /api/stock/shipment-parcel/reorder
Shipment Parcel object 
{
  "id": "shipment-parcel_abc123",
  "idx": 1,
  "shipment_id": "shipment_id_example",
  "length": 0,
  "width": 0,
  "height": 0,
  "weight": 0,
  "count": 1
}