Qodex.ai

Vouchers API - Sandbox

Number of APIs: 16

Instruction guidelines to simulate a trip of the Voucher usage - see the Run folder in this collection for endpoints.

1. To simulate a trip, call POST terminal-state-trip-run. This will start an async flow to simulate a trip. This will return a runID and a tripID.
2. Pass the RunID to GET run-state endpoint to check the status of the run. Typically run can take 1-2 mins to reach `COMPLETED` state. This indicates that trip was completed successfully.
3. If devapp is configured, you should receive a voucherprogramcode_redeemed webhook
4. Call GetVoucherProgram api to check updated usage of the voucher
5. You can also verify whether voucher was applied by checking the reciept.

  1. Authorization - Generate Access Token (client_credentials) POST https://login.uber.com/oauth/v2/token

  2. Voucher program creation: Without Template - Create Voucher Program POST {{sandbox_base_url}}/organizations/:organization_id/voucher-programs

  3. Voucher program creation: With Template - Create Voucher Template POST {{sandbox_base_url}}/organizations/:organization_id/voucher-program-templates

  4. Voucher program creation: With Template - Create Voucher Program From Template POST {{sandbox_base_url}}/organizations/:organization_id/voucher-programs/create-from-template

  5. Voucher Program Managment - Get Voucher Program GET {{sandbox_base_url}}/organizations/:organization_id/voucher-programs/:voucher_program_id/?include_guests=true

  6. Voucher Program Managment - Search Voucher Programs POST {{sandbox_base_url}}/organizations/:organization_id/voucher-programs/search

  7. Voucher Program Managment - Update Voucher Program PATCH {{sandbox_base_url}}/organizations/:organization_id/voucher-programs/:voucher_program_id

  8. Voucher Program Managment - Cancel Voucher Program POST {{sandbox_base_url}}/organizations/:organization_id/voucher-programs/:voucher_program_id/cancel

  9. Voucher Code Managment - Get Voucher Codes GET {{sandbox_base_url}}/organizations/:organization_id/voucher-programs/:voucher_program_id/codes?include_usage=true

  10. Voucher Code Managment - Generate Voucher Codes POST {{sandbox_base_url}}/organizations/:organization_id/voucher-programs/:voucher_program_id/codes/generate