Hiweb Developers

# Order API Reference

Endpoint:

https://[client].hiweb.io/api/orders

Order resource object:

{
  "type": "orders",
  "id": "(string)",
  "attributes": {
    "number": {Integer},
    "item_count": {Integer},
    "email": "string",
    "phone": "string",
    "ip": "string",
    "reference": "string",
    "note": "string",
    "payment_status": "string|in:pending,authorized,partially-paid,paid,partially-refunded,refunded,voided",
    "fulfillment_status": "string|in:pending,processing,partial-processing,success,partial-success,failure,partial-failure,cancelled,error",
    "subtotal_price": {Float},
    "total_discount": {Float},
    "shipping_fee": {Float},
    "total_price": {Float},
    "currency": "string",
    "discount_id": "string|uuid",
    "discount_rule": "array",
    "total_grams": (float),
    "browser": {
      "user_agent": "..."
    },
    "created_at": "string|datetime",
    "updated_at": "string|datetime"
  },
  "relationships": {
    "fulfillments": {
      "data": Array [Fulfillment Resources]
    },
    "order_items": {
      "data": Array [Order Item Resources]
    },
    "transactions": {
      "data": Array [Transaction Resources]
    },
    "shipping_address": {
      "data": Object (Address Resource)
    },
    "billing_address": {
      "data": Object (Address Resource)
    },
    "shipping": {
      "data": Object (Shipping Resource)
    },
    "cart": {
      "data": Object (Cart Resource)
    }
  }
}

Related resources: Order Item, Address, Transaction, Fulfillment, Cart, Discount, Shipping

  • Note: shipping and cart relationships are only avaiable for getting a single order request.

# Writable fields

Field name Creating Updating
email string|email|max:255 string|email|max:255
phone string|max:30 string|max:30
reference string|max:255 string|max:255
note string|max:20000 string|max:20000
shipping_fee float|min:0 float|min:0
send_notification boolean boolean

# Writable relationships

Relationship name Relationship resource type Type Creating Updating
cart carts To-one Yes Yes
shipping_address addresses To-one Yes Yes
billing_address addresses To-one Yes Yes
shipping shippings To-one Yes Yes

# Sortable

Field name
number
reference
payment_status
fulfillment_status
created_at
updated_at

# Filters

Filter name Detail
number string
cart_id string|uuid
reference string
payment_status string
fulfillment_status string
created_at string
updated_at string
search Full text search
ids Filter by order ids

← Order Items →