API documentation

GET /number_order_prefixes/new

Authorization Required

https://[your-subdomain].trackdrive.net/api/v1/number_order_prefixes/new

Build Number Order Prefix with defaults.

Returns a blank Number Order Prefix populated with default attribute values, without saving it.

Params

Param name	Description
number_order_id Optional Blank value allowed	Number Order Must be a valid foreign key reference to an Number Order. Refer to: /api/docs/1.0/number_orders
prefix Optional Blank value allowed	Prefix Must be a String
order_count Optional Blank value allowed	Order Count Must be a decimal number.
sortable_order Optional Blank value allowed	Sortable Order Must be a decimal number.

Example Request

curl 'https://[your-subdomain].trackdrive.net/api/v1/number_order_prefixes/new' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "number_order_prefix": {
    "id": null,
    "type": "NumberOrderPrefix",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/number_order_prefixes/new",
    "routes_edit_path": "/number_order_prefixes/new",
    "external_record_id": null,
    "number_order_id": null,
    "prefix": "1855",
    "order_count": 1,
    "numbers_statuses": [
      {
        "status": "pending",
        "name": "Pending",
        "count": 1,
        "error_reason": null,
        "numbers": []
      }
    ],
    "number_ids": [],
    "sortable_order": null
  },
  "metadata": {
    "root": "number_order_prefix"
  }
}