The Master Production Schedule 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.

company string required
posting_date string required
parent_warehouse string
from_date string required
to_date string
sales_forecast string
The Master Production Schedule object 
{
  "id": "master-production-schedule_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "company": "Example Corp",
  "posting_date": "2024-01-15",
  "parent_warehouse": "parent_warehouse_example",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "sales_forecast": "sales_forecast_example"
}
GET /api/manufacturing/master-production-schedule/{id}

Retrieve a master production schedule

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

Path parameters

id string required

The identifier of the master production schedule to retrieve.

Returns

Returns the master production schedule object if a valid identifier was provided.

GET /api/manufacturing/master-production-schedule/{id} 
curl https://api.overplane.dev/api/manufacturing/master-production-schedule/master-production-schedule_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "master-production-schedule_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "company": "Example Corp",
  "posting_date": "2024-01-15",
  "parent_warehouse": "parent_warehouse_example",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "sales_forecast": "sales_forecast_example"
}
GET /api/manufacturing/master-production-schedule

List all master production schedules

Returns a list of master production schedules. 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 master production schedule objects.

GET /api/manufacturing/master-production-schedule 
curl https://api.overplane.dev/api/manufacturing/master-production-schedule \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "master-production-schedule_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "company": "Example Corp",
      "posting_date": "2024-01-15",
      "parent_warehouse": "parent_warehouse_example",
      "from_date": "2024-01-15",
      "to_date": "2024-01-15",
      "sales_forecast": "sales_forecast_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/manufacturing/master-production-schedule

Create a master production schedule

Creates a new master production schedule object.

Body parameters

company string required
posting_date string required
parent_warehouse string
from_date string required
to_date string
sales_forecast string

Returns

Returns the newly created master production schedule object if the call succeeded.

POST /api/manufacturing/master-production-schedule 
curl https://api.overplane.dev/api/manufacturing/master-production-schedule \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"company":"Example Corp","posting_date":"2024-01-15","from_date":"2024-01-15"}'
Response 
{
  "id": "master-production-schedule_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "company": "Example Corp",
  "posting_date": "2024-01-15",
  "parent_warehouse": "parent_warehouse_example",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "sales_forecast": "sales_forecast_example"
}
PATCH /api/manufacturing/master-production-schedule/{id}

Update a master production schedule

Updates the specified master production schedule 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 master production schedule to update.

Body parameters

company string
posting_date string
parent_warehouse string
from_date string
to_date string
sales_forecast string

Returns

Returns the updated master production schedule object.

PATCH /api/manufacturing/master-production-schedule/{id} 
curl https://api.overplane.dev/api/manufacturing/master-production-schedule/master-production-schedule_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"company":"Example Corp","posting_date":"2024-01-15"}'
Response 
{
  "id": "master-production-schedule_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "company": "Example Corp",
  "posting_date": "2024-01-15",
  "parent_warehouse": "parent_warehouse_example",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "sales_forecast": "sales_forecast_example"
}
DELETE /api/manufacturing/master-production-schedule/{id}

Delete a master production schedule

Permanently deletes a master production schedule. This cannot be undone.

Path parameters

id string required

The identifier of the master production schedule to delete.

Returns

Returns a confirmation that the master production schedule has been deleted.

DELETE /api/manufacturing/master-production-schedule/{id} 
curl https://api.overplane.dev/api/manufacturing/master-production-schedule/master-production-schedule_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "master-production-schedule_abc123",
  "deleted": true
}