The Quotation Lost Reason 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.

order_lost_reason string required
The Quotation Lost Reason object 
{
  "id": "quotation-lost-reason_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "order_lost_reason": "order_lost_reason_example"
}
GET /api/setup/quotation-lost-reason/{id}

Retrieve a quotation lost reason

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

Path parameters

id string required

The identifier of the quotation lost reason to retrieve.

Returns

Returns the quotation lost reason object if a valid identifier was provided.

GET /api/setup/quotation-lost-reason/{id} 
curl https://api.overplane.dev/api/setup/quotation-lost-reason/quotation-lost-reason_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "quotation-lost-reason_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "order_lost_reason": "order_lost_reason_example"
}
GET /api/setup/quotation-lost-reason

List all quotation lost reasons

Returns a list of quotation lost reasons. 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 quotation lost reason objects.

GET /api/setup/quotation-lost-reason 
curl https://api.overplane.dev/api/setup/quotation-lost-reason \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "quotation-lost-reason_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "order_lost_reason": "order_lost_reason_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/setup/quotation-lost-reason

Create a quotation lost reason

Creates a new quotation lost reason object.

Body parameters

order_lost_reason string required

Returns

Returns the newly created quotation lost reason object if the call succeeded.

POST /api/setup/quotation-lost-reason 
curl https://api.overplane.dev/api/setup/quotation-lost-reason \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"order_lost_reason":"order_lost_reason_example"}'
Response 
{
  "id": "quotation-lost-reason_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "order_lost_reason": "order_lost_reason_example"
}
PATCH /api/setup/quotation-lost-reason/{id}

Update a quotation lost reason

Updates the specified quotation lost reason 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 quotation lost reason to update.

Body parameters

order_lost_reason string

Returns

Returns the updated quotation lost reason object.

PATCH /api/setup/quotation-lost-reason/{id} 
curl https://api.overplane.dev/api/setup/quotation-lost-reason/quotation-lost-reason_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"order_lost_reason":"order_lost_reason_example"}'
Response 
{
  "id": "quotation-lost-reason_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "order_lost_reason": "order_lost_reason_example"
}
DELETE /api/setup/quotation-lost-reason/{id}

Delete a quotation lost reason

Permanently deletes a quotation lost reason. This cannot be undone.

Path parameters

id string required

The identifier of the quotation lost reason to delete.

Returns

Returns a confirmation that the quotation lost reason has been deleted.

DELETE /api/setup/quotation-lost-reason/{id} 
curl https://api.overplane.dev/api/setup/quotation-lost-reason/quotation-lost-reason_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "quotation-lost-reason_abc123",
  "deleted": true
}