The Sales Forecast 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

company string required
posting_date string
parent_warehouse string required
from_date string required
demand_number integer

Default: 6

frequency string

Default: Monthly

The Sales Forecast object 
{
  "id": "sales-forecast_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "posting_date": "2024-01-15",
  "parent_warehouse": "parent_warehouse_example",
  "from_date": "2024-01-15",
  "demand_number": 6,
  "frequency": "Monthly"
}
GET /api/manufacturing/sales-forecast/{id}

Retrieve a sales forecast

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

Path parameters

id string required

The identifier of the sales forecast to retrieve.

Returns

Returns the sales forecast object if a valid identifier was provided.

GET /api/manufacturing/sales-forecast/{id} 
curl https://api.overplane.dev/api/manufacturing/sales-forecast/sales-forecast_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "sales-forecast_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "posting_date": "2024-01-15",
  "parent_warehouse": "parent_warehouse_example",
  "from_date": "2024-01-15",
  "demand_number": 6,
  "frequency": "Monthly"
}
GET /api/manufacturing/sales-forecast

List all sales forecasts

Returns a list of sales forecasts. 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 sales forecast objects.

GET /api/manufacturing/sales-forecast 
curl https://api.overplane.dev/api/manufacturing/sales-forecast \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "sales-forecast_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "company": "Example Corp",
      "posting_date": "2024-01-15",
      "parent_warehouse": "parent_warehouse_example",
      "from_date": "2024-01-15",
      "demand_number": 6,
      "frequency": "Monthly"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/manufacturing/sales-forecast

Create a sales forecast

Creates a new sales forecast object.

Body parameters

status string

Default: draft

company string required
posting_date string
parent_warehouse string required
from_date string required
demand_number integer

Default: 6

frequency string

Default: Monthly

Returns

Returns the newly created sales forecast object if the call succeeded.

POST /api/manufacturing/sales-forecast 
curl https://api.overplane.dev/api/manufacturing/sales-forecast \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"company":"Example Corp","parent_warehouse":"parent_warehouse_example","from_date":"2024-01-15"}'
Response 
{
  "id": "sales-forecast_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "posting_date": "2024-01-15",
  "parent_warehouse": "parent_warehouse_example",
  "from_date": "2024-01-15",
  "demand_number": 6,
  "frequency": "Monthly"
}
PATCH /api/manufacturing/sales-forecast/{id}

Update a sales forecast

Updates the specified sales forecast 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 sales forecast to update.

Body parameters

status string

Default: draft

company string
posting_date string
parent_warehouse string
from_date string
demand_number integer

Default: 6

frequency string

Default: Monthly

Returns

Returns the updated sales forecast object.

PATCH /api/manufacturing/sales-forecast/{id} 
curl https://api.overplane.dev/api/manufacturing/sales-forecast/sales-forecast_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","company":"Example Corp"}'
Response 
{
  "id": "sales-forecast_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "posting_date": "2024-01-15",
  "parent_warehouse": "parent_warehouse_example",
  "from_date": "2024-01-15",
  "demand_number": 6,
  "frequency": "Monthly"
}
DELETE /api/manufacturing/sales-forecast/{id}

Delete a sales forecast

Permanently deletes a sales forecast. This cannot be undone.

Path parameters

id string required

The identifier of the sales forecast to delete.

Returns

Returns a confirmation that the sales forecast has been deleted.

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

Submit a sales forecast

Submits a draft sales forecast, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the sales forecast to act on.

Returns

Returns the sales forecast object with updated status.

POST /api/manufacturing/sales-forecast/{id}/submit 
curl https://api.overplane.dev/api/manufacturing/sales-forecast/sales-forecast_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "sales-forecast_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "posting_date": "2024-01-15",
  "parent_warehouse": "parent_warehouse_example",
  "from_date": "2024-01-15",
  "demand_number": 6,
  "frequency": "Monthly"
}
POST /api/manufacturing/sales-forecast/{id}/cancel

Cancel a sales forecast

Cancels a submitted sales forecast, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the sales forecast to act on.

Returns

Returns the sales forecast object with updated status.

POST /api/manufacturing/sales-forecast/{id}/cancel 
curl https://api.overplane.dev/api/manufacturing/sales-forecast/sales-forecast_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "sales-forecast_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "posting_date": "2024-01-15",
  "parent_warehouse": "parent_warehouse_example",
  "from_date": "2024-01-15",
  "demand_number": 6,
  "frequency": "Monthly"
}