Developers / API v3.0 / Orders (order)

Orders (order)

Auth

  • All Orders endpoints require authorization:
    • Authorization: Bearer {{oauth_access_token}} (OAuth client_credentials token), or
    • mobstep-customer-token: {{customer_token}} (customer token)

Base URL

  • {{base_path}}{{api_v3_path}}/order

GET Query Parameters (supported by API v3)

  • fields (required)
    • Comma-separated list of fields to include in the response.
    • If missing/empty: 400 invalid_request Parameter fields is required.
  • sort (optional)
    • Format: sort=<field>,<ASC|DESC>
    • Example: sort=created,DESC
  • range (optional; pagination)
    • Format: range=<offset>,<limit>
    • Example: range=0,50
  • search (optional; contains search)
    • Format: search=<field>,<value>
    • Multiple OR groups: separate by |
  • group (optional)
    • Format: group=<field>
  • Filter by field value (optional)
    • You can pass any field name as a query parameter to filter results.
    • Values are comma-separated and applied as an IN condition.

Fields (order)

Below are common order fields defined in the entity. Entity references are typically sent as arrays of objects with target_id (example: "branch_id": [{"target_id": 1}]).

  • id, uuid, iid
  • service, service_type, service_fee
  • branch_id
  • tax, subtotal, discount, wallet_amount, total
  • coupon, coupon_id
  • note, status
  • payment, payment_reference, payment_config, pending, paid
  • name, country, province, city, area, address, phone, lat, lng
  • customer_id, admin_id, driver_id
  • platform, attachments
  • application_id, langcode, created, changed
  • Returns: is_return, original_order_id, return_reason
GET

GET Orders (Auth required)

URL
https://mobstep.com/api/v3.0/order?fields=id,uuid,application_id,branch_id,customer_id,subtotal,discount,tax,total,status,payment,paid,pending,created,changed
Fields
Name Description
id -
uuid -
application_id -
branch_id -
customer_id -
subtotal -
discount -
tax -
total -
status -
payment -
paid -
pending -
created -
changed -
Headers
Name Value Description
Authorization Bearer {{oauth_access_token}} -
mobstep-customer-token {{customer_token}} -
POST

POST Orders: Create (Auth required)

URL
https://mobstep.com/api/v3.0/order
Headers
Name Value Description
Content-Type application/json -
Authorization Bearer {{oauth_access_token}} -
mobstep-customer-token {{customer_token}} -
Body
{
  "application_id": [{"target_id": {{application_id}}}],
  "subtotal": 100.0,
  "total": 100.0,
  "status": "new"
}

Description

Create order. Required fields (entity definition): application_id, subtotal, total, status. Other fields are optional.

POST

POST Orders: Update (with id in body)

URL
https://mobstep.com/api/v3.0/order
Headers
Name Value Description
Content-Type application/json -
Authorization Bearer {{oauth_access_token}} -
mobstep-customer-token {{customer_token}} -
Body
{
  "id": "{{api_entity_id}}",
  "status": "processing"
}

Description

Update order by providing id in body.

DELETE

DELETE Orders (Auth required)

URL
https://mobstep.com/api/v3.0/order/{{api_entity_id}}
Headers
Name Value Description
Authorization Bearer {{oauth_access_token}} -
mobstep-customer-token {{customer_token}} -

Description

Delete order by id. Requires authorization.