DocumentationMuvx Order Management Postman

Muvx Order Management Postman

The Muvx Postman Collection provides everything you need to start testing and integrating with the Muvx API.

It includes ready-made requests for order management (create, cancel, trigger pickup, get status) and a preconfigured environment for variables like base URL and API key.


Downloads

Use these files to quickly set up Postman and start testing the Muvx API:

Online Postman Documentation

You can also explore the live Postman docs here:


Setup Instructions

You have two options to configure the environment:

  • Open PostmanEnvironmentsImport
  • Upload the file Muvx Env.postman_environment.json
  • Activate the environment named Muvx Env from the dropdown in the top-right

Environment variables included:

  • muvx_base_url → API base URL (https://core.muvx.ai)
  • sample_api_keyReplace this with your own API key
  • sample_order_idFirst create an order using the API, then use its ID here
  • Always replace the sample_api_key value with your actual API key.
  • To set sample_order_id, first use the Create Order API, then copy the returned id into this variable.

Option B — Create the Environment Manually

If you don’t want to use the file, you can manually create the environment:

  1. Open PostmanEnvironmentsAdd New
  2. Add the following variables and values:
KeyValueType
muvx_base_urlhttps://core.muvx.aiDefault
sample_api_keyYour real API key hereSecret
sample_order_idExample order IDDefault
  1. Save the environment.
  2. Select it from the environment dropdown in the top-right.

Only one environment can be active at a time. All {{variables}} in the collection will be resolved from the selected environment.


2. Import the Collection

  • Open PostmanCollectionsImport.
  • Upload the file Muvx.postman_collection.json.
  • You’ll see the Muvx collection with all requests ready.

Authentication

This collection uses Bearer Token authentication:

  • The token is set at the collection level.
  • All requests automatically use {{sample_api_key}} from your active environment.
  • You don’t need to edit headers manually.

Using the Collection

With the environment and collection active, you can immediately start testing:

  • Create Order → Register a new order in Muvx
  • Trigger Pickup → Dispatch an order to delivery
  • Get Order Status → Track status updates
  • Cancel Order → Cancel an existing order

For full API details, see the Order Management documentation.

Updated 3 months ago