The Packing Slip 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

delivery_note string required
from_case_no integer required
to_case_no integer
net_weight_pkg number
net_weight_uom string
gross_weight_pkg number
gross_weight_uom string
letter_head string
The Packing Slip object 
{
  "id": "packing-slip_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "delivery_note": "delivery_note_example",
  "from_case_no": 0,
  "to_case_no": 0,
  "net_weight_pkg": 0,
  "net_weight_uom": "net_weight_uom_example",
  "gross_weight_pkg": 0,
  "gross_weight_uom": "gross_weight_uom_example",
  "letter_head": "letter_head_example"
}
GET /api/stock/packing-slip/{id}

Retrieve a packing slip

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

Path parameters

id string required

The identifier of the packing slip to retrieve.

Returns

Returns the packing slip object if a valid identifier was provided.

GET /api/stock/packing-slip/{id} 
curl https://api.overplane.dev/api/stock/packing-slip/packing-slip_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "packing-slip_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "delivery_note": "delivery_note_example",
  "from_case_no": 0,
  "to_case_no": 0,
  "net_weight_pkg": 0,
  "net_weight_uom": "net_weight_uom_example",
  "gross_weight_pkg": 0,
  "gross_weight_uom": "gross_weight_uom_example",
  "letter_head": "letter_head_example"
}
GET /api/stock/packing-slip

List all packing slips

Returns a list of packing slips. 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 packing slip objects.

GET /api/stock/packing-slip 
curl https://api.overplane.dev/api/stock/packing-slip \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "packing-slip_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "delivery_note": "delivery_note_example",
      "from_case_no": 0,
      "to_case_no": 0,
      "net_weight_pkg": 0,
      "net_weight_uom": "net_weight_uom_example",
      "gross_weight_pkg": 0,
      "gross_weight_uom": "gross_weight_uom_example",
      "letter_head": "letter_head_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/stock/packing-slip

Create a packing slip

Creates a new packing slip object.

Body parameters

status string

Default: draft

delivery_note string required
from_case_no integer required
to_case_no integer
net_weight_pkg number
net_weight_uom string
gross_weight_pkg number
gross_weight_uom string
letter_head string

Returns

Returns the newly created packing slip object if the call succeeded.

POST /api/stock/packing-slip 
curl https://api.overplane.dev/api/stock/packing-slip \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"delivery_note":"delivery_note_example","from_case_no":0}'
Response 
{
  "id": "packing-slip_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "delivery_note": "delivery_note_example",
  "from_case_no": 0,
  "to_case_no": 0,
  "net_weight_pkg": 0,
  "net_weight_uom": "net_weight_uom_example",
  "gross_weight_pkg": 0,
  "gross_weight_uom": "gross_weight_uom_example",
  "letter_head": "letter_head_example"
}
PATCH /api/stock/packing-slip/{id}

Update a packing slip

Updates the specified packing slip 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 packing slip to update.

Body parameters

status string

Default: draft

delivery_note string
from_case_no integer
to_case_no integer
net_weight_pkg number
net_weight_uom string
gross_weight_pkg number
gross_weight_uom string
letter_head string

Returns

Returns the updated packing slip object.

PATCH /api/stock/packing-slip/{id} 
curl https://api.overplane.dev/api/stock/packing-slip/packing-slip_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","delivery_note":"delivery_note_example"}'
Response 
{
  "id": "packing-slip_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "delivery_note": "delivery_note_example",
  "from_case_no": 0,
  "to_case_no": 0,
  "net_weight_pkg": 0,
  "net_weight_uom": "net_weight_uom_example",
  "gross_weight_pkg": 0,
  "gross_weight_uom": "gross_weight_uom_example",
  "letter_head": "letter_head_example"
}
DELETE /api/stock/packing-slip/{id}

Delete a packing slip

Permanently deletes a packing slip. This cannot be undone.

Path parameters

id string required

The identifier of the packing slip to delete.

Returns

Returns a confirmation that the packing slip has been deleted.

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

Submit a packing slip

Submits a draft packing slip, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the packing slip to act on.

Returns

Returns the packing slip object with updated status.

POST /api/stock/packing-slip/{id}/submit 
curl https://api.overplane.dev/api/stock/packing-slip/packing-slip_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "packing-slip_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "delivery_note": "delivery_note_example",
  "from_case_no": 0,
  "to_case_no": 0,
  "net_weight_pkg": 0,
  "net_weight_uom": "net_weight_uom_example",
  "gross_weight_pkg": 0,
  "gross_weight_uom": "gross_weight_uom_example",
  "letter_head": "letter_head_example"
}
POST /api/stock/packing-slip/{id}/cancel

Cancel a packing slip

Cancels a submitted packing slip, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the packing slip to act on.

Returns

Returns the packing slip object with updated status.

POST /api/stock/packing-slip/{id}/cancel 
curl https://api.overplane.dev/api/stock/packing-slip/packing-slip_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "packing-slip_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "delivery_note": "delivery_note_example",
  "from_case_no": 0,
  "to_case_no": 0,
  "net_weight_pkg": 0,
  "net_weight_uom": "net_weight_uom_example",
  "gross_weight_pkg": 0,
  "gross_weight_uom": "gross_weight_uom_example",
  "letter_head": "letter_head_example"
}

Line items

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

Packing Slip Item

Attributes

idx integer
packing_slip_id string required
item_code string required
item_name string
batch_no string
description string
qty number required
net_weight number
stock_uom string
weight_uom string
page_break boolean
dn_detail string
pi_detail string

Endpoints

GET /api/stock/packing-slip-item?parent_id={id}
POST /api/stock/packing-slip-item
PATCH /api/stock/packing-slip-item/{id}
DELETE /api/stock/packing-slip-item/{id}
POST /api/stock/packing-slip-item/reorder
Packing Slip Item object 
{
  "id": "packing-slip-item_abc123",
  "idx": 1,
  "packing_slip_id": "packing_slip_id_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "batch_no": "batch_no_example",
  "description": "description_example",
  "qty": 0,
  "net_weight": 0,
  "stock_uom": "stock_uom_example",
  "weight_uom": "weight_uom_example",
  "page_break": false,
  "dn_detail": "dn_detail_example",
  "pi_detail": "pi_detail_example"
}