Get all orders for a customer

GET 
/v1/orders

Get all orders for a customer.

Request

Query Parameters

status string

Possible values: [pending, paid, creating_policy, policy_created, completed, cancelled]

The status of the order.

product_type integer

The ID of the type of product the order is for.

customer_ref string

The ref of the customer who owns this order, this would have been supplied when creating the customer

search string

Search for orders by customer name, product title, or asset_ref

child_partner_id string

The child partner key to get all orders belonging to the child partner

Responses

200

OK

application/json

Schema

Schema

orders object[]
Array [
id integer
The unique ID of the order.
status string
the current status of the order.
amount_due float
the amount due for payment by partner, excluding the partner's commission
policy_start_date date
The date when the policy coverage is due to start
asset_ref string
An optional identifier for the asset the insurance covers. You may set this to a value that uniquley identifies the asset on your database.
currency string
The currency of all monetary parameters.
channel string
The channel through which the order was made.
created_at date
product object
An individual insurance product or plan
title string
The name of the product
code string
The unique identifier for technical purposes
id integer
Unique Id of the product.
insurer object
An insurance provider
code string
The unique code of the insurer
name string
The name of the insurer
logo_url string
A link to the Insurer's logo
terms_conditions string
Insurer's terms and conditions
product type object
A major category of insurance e.g Health, Automobile, Life, Gadget, Goods in transit, etc
name string
The generally accepted human friendly name
slug string
The unique identifier for technical purposes
cover-benefits object
list of the nefits covered.
created-at string
Date of product creation
price integer
Price of product
premium-type string
Define the product premium tier.
premium-rate-unit integer
premium-rate number
premium number
partner-commision-rate number
min-premium string
premium-rules string
premium_frequency string
Possible values: [monthly, quarterly, annually]
Default value: annually
customer object
The the customer's information
ref stringrequired
Unique identifier for the customer on your system
email stringrequired
The customer's email address
phone string
first_name stringrequired
last_name stringrequired
policy object
The policy for which the order was made.
]

Example (from schema)

{
  "orders": [
    {
      "id": 2,
      "status": "paid",
      "amount_due": 1470,
      "policy_start_date": "2022-04-06T00:00:00.000000Z",
      "asset_ref": "T2354354",
      "currency": "GHS",
      "channel": "API",
      "created_at": "2022-04-06T10:34:20.000000Z",
      "product": {
        "title": "Comprehensive Car Plan XYZ",
        "code": "auto-com-xyz",
        "id": 1,
        "insurer": {
          "code": "AXA",
          "name": "Axa Mansard",
          "logo_url": null,
          "terms_conditions": null
        },
        "product type": {
          "name": "Goods in Transit",
          "slug": "GIT"
        },
        "cover-benefits": {},
        "created-at": "string",
        "price": 0,
        "premium-type": "string",
        "premium-rate-unit": 0,
        "premium-rate": 0,
        "premium": 0,
        "partner-commision-rate": 0,
        "min-premium": "string",
        "premium-rules": "string",
        "premium_frequency": "annually"
      },
      "customer": {
        "ref": "string",
        "email": "string",
        "phone": "408-867-5309",
        "first_name": "Jane",
        "last_name": "Doe"
      },
      "policy": null
    }
  ]
}

400

Bad request.

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "400 Bad Request (Client Error)"
}

Loading...