The Blanket Order 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

blanket_order_type string required
customer string
customer_name string
supplier string
supplier_name string
from_date string required
to_date string required
company string required
tc_name string
terms string
order_no string
order_date string
The Blanket Order object 
{
  "id": "blanket-order_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "blanket_order_type": "blanket_order_type_example",
  "customer": "customer_example",
  "customer_name": "customer_name_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "company": "Example Corp",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "order_no": "order_no_example",
  "order_date": "2024-01-15"
}
GET /api/manufacturing/blanket-order/{id}

Retrieve a blanket order

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

Path parameters

id string required

The identifier of the blanket order to retrieve.

Returns

Returns the blanket order object if a valid identifier was provided.

GET /api/manufacturing/blanket-order/{id} 
curl https://api.overplane.dev/api/manufacturing/blanket-order/blanket-order_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "blanket-order_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "blanket_order_type": "blanket_order_type_example",
  "customer": "customer_example",
  "customer_name": "customer_name_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "company": "Example Corp",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "order_no": "order_no_example",
  "order_date": "2024-01-15"
}
GET /api/manufacturing/blanket-order

List all blanket orders

Returns a list of blanket orders. 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 blanket order objects.

GET /api/manufacturing/blanket-order 
curl https://api.overplane.dev/api/manufacturing/blanket-order \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "blanket-order_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "blanket_order_type": "blanket_order_type_example",
      "customer": "customer_example",
      "customer_name": "customer_name_example",
      "supplier": "supplier_example",
      "supplier_name": "supplier_name_example",
      "from_date": "2024-01-15",
      "to_date": "2024-01-15",
      "company": "Example Corp",
      "tc_name": "tc_name_example",
      "terms": "terms_example",
      "order_no": "order_no_example",
      "order_date": "2024-01-15"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/manufacturing/blanket-order

Create a blanket order

Creates a new blanket order object.

Body parameters

status string

Default: draft

blanket_order_type string required
customer string
customer_name string
supplier string
supplier_name string
from_date string required
to_date string required
company string required
tc_name string
terms string
order_no string
order_date string

Returns

Returns the newly created blanket order object if the call succeeded.

POST /api/manufacturing/blanket-order 
curl https://api.overplane.dev/api/manufacturing/blanket-order \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"blanket_order_type":"blanket_order_type_example","from_date":"2024-01-15","to_date":"2024-01-15","company":"Example Corp"}'
Response 
{
  "id": "blanket-order_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "blanket_order_type": "blanket_order_type_example",
  "customer": "customer_example",
  "customer_name": "customer_name_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "company": "Example Corp",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "order_no": "order_no_example",
  "order_date": "2024-01-15"
}
PATCH /api/manufacturing/blanket-order/{id}

Update a blanket order

Updates the specified blanket order 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 blanket order to update.

Body parameters

status string

Default: draft

blanket_order_type string
customer string
customer_name string
supplier string
supplier_name string
from_date string
to_date string
company string
tc_name string
terms string
order_no string
order_date string

Returns

Returns the updated blanket order object.

PATCH /api/manufacturing/blanket-order/{id} 
curl https://api.overplane.dev/api/manufacturing/blanket-order/blanket-order_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","blanket_order_type":"blanket_order_type_example"}'
Response 
{
  "id": "blanket-order_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "blanket_order_type": "blanket_order_type_example",
  "customer": "customer_example",
  "customer_name": "customer_name_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "company": "Example Corp",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "order_no": "order_no_example",
  "order_date": "2024-01-15"
}
DELETE /api/manufacturing/blanket-order/{id}

Delete a blanket order

Permanently deletes a blanket order. This cannot be undone.

Path parameters

id string required

The identifier of the blanket order to delete.

Returns

Returns a confirmation that the blanket order has been deleted.

DELETE /api/manufacturing/blanket-order/{id} 
curl https://api.overplane.dev/api/manufacturing/blanket-order/blanket-order_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "blanket-order_abc123",
  "deleted": true
}
POST /api/manufacturing/blanket-order/{id}/submit

Submit a blanket order

Submits a draft blanket order, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the blanket order to act on.

Returns

Returns the blanket order object with updated status.

POST /api/manufacturing/blanket-order/{id}/submit 
curl https://api.overplane.dev/api/manufacturing/blanket-order/blanket-order_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "blanket-order_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "blanket_order_type": "blanket_order_type_example",
  "customer": "customer_example",
  "customer_name": "customer_name_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "company": "Example Corp",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "order_no": "order_no_example",
  "order_date": "2024-01-15"
}
POST /api/manufacturing/blanket-order/{id}/cancel

Cancel a blanket order

Cancels a submitted blanket order, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the blanket order to act on.

Returns

Returns the blanket order object with updated status.

POST /api/manufacturing/blanket-order/{id}/cancel 
curl https://api.overplane.dev/api/manufacturing/blanket-order/blanket-order_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "blanket-order_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "blanket_order_type": "blanket_order_type_example",
  "customer": "customer_example",
  "customer_name": "customer_name_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "company": "Example Corp",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "order_no": "order_no_example",
  "order_date": "2024-01-15"
}

Line items

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

Blanket Order Item

Attributes

idx integer
blanket_order_id string required
item_code string required
item_name string
qty number
rate number required
ordered_qty number
terms_and_conditions string
party_item_code string

Endpoints

GET /api/manufacturing/blanket-order-item?parent_id={id}
POST /api/manufacturing/blanket-order-item
PATCH /api/manufacturing/blanket-order-item/{id}
DELETE /api/manufacturing/blanket-order-item/{id}
POST /api/manufacturing/blanket-order-item/reorder
Blanket Order Item object 
{
  "id": "blanket-order-item_abc123",
  "idx": 1,
  "blanket_order_id": "blanket_order_id_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "qty": 0,
  "rate": 0,
  "ordered_qty": 0,
  "terms_and_conditions": "terms_and_conditions_example",
  "party_item_code": "party_item_code_example"
}