Cancel Bulk Orders

This end point will allow you to cancel a bulk order on the Qolo platform.

Request
Security:
path Parameters
version
required
string
Request Body schema: application/json
order_guid
string <uuid>

Order guid

program_guid
string <uuid>

Program guid

Responses
200

Returns the bulk order details for the cancelled order

400

Bad request

401

Unauthorized

500

Server Error

put/api/{version}/bulkorders
Request samples
application/json
{
  • "order_guid": "dd878538-67b6-4e7d-8e8a-ddc3e971d02f",
  • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f"
}
Response samples
application/json
{
  • "order_guid": "dd878538-67b6-4e7d-8e8a-ddc3e971d02f",
  • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
  • "package_guid": "bbcfa7f4-7eee-4d1b-9f7d-736ad8949479",
  • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
  • "order_type": "string",
  • "shipmethod": "string",
  • "signature_required": true,
  • "tracking_number": "string",
  • "order_count": 0,
  • "order_status": "string",
  • "order_error_code": "string",
  • "sys_utcinserted": "2019-08-24T14:15:22Z",
  • "sys_utcupdated": "2019-08-24T14:15:22Z",
  • "carrier": "string",
  • "package_name": "string",
  • "count": 0,
  • "personInfo": {
    • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
    • "last_name": "string",
    • "first_name": "string",
    • "middle_name": "string",
    • "email_address": "string",
    • "mobile_number": "string",
    • "home_number": "string",
    • "office_number": "string",
    • "nationality": "str",
    • "profile_dd_mode": "string",
    • "birth_date": "2019-08-24T14:15:22Z",
    • "govt_id_type": "string",
    • "hashed_govt_id_number": "string",
    • "govt_id_number": "string",
    • "base_address_line1": "string",
    • "base_address_line2": "string",
    • "base_city": "string",
    • "base_state": "string",
    • "base_postal_code": "string",
    • "base_country": "str",
    • "billing_address_line1": "string",
    • "billing_address_line2": "string",
    • "billing_city": "string",
    • "billing_state": "string",
    • "billing_postal_code": "string",
    • "billing_country": "str",
    • "mailing_address_line1": "string",
    • "mailing_address_line2": "string",
    • "mailing_city": "string",
    • "mailing_state": "string",
    • "mailing_postal_code": "string",
    • "mailing_country": "str",
    • "person_status": "string",
    • "verfication_mode": "string",
    • "verfication_level": "string",
    • "person_forget_mode": "str",
    • "person_forget_mode_date": "2019-08-24T14:15:22Z",
    • "market_notification_optin": "str",
    • "market_notification_optin_date": "2019-08-24T14:15:22Z",
    • "address_lat": 0,
    • "address_lon": 0,
    • "contact_type": "string",
    • "private_data_key_token": "string",
    • "key_ref": "string",
    • "sys_utcinserted": "2019-08-24T14:15:22Z",
    • "sys_utcupdated": "2019-08-24T14:15:22Z",
    • "client_reference_id": "string",
    • "mask_govt_id_number": "string",
    • "title": "string",
    • "additional_data": "string",
    • "jurisdiction_country": "str",
    • "jurisdiction_state": "string",
    • "beneficial_ownership": 0
    },
  • "person": {
    • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
    • "first_name": "string",
    • "middle_name": "string",
    • "last_name": "string",
    • "mailing_city": "string",
    • "mailing_country": "str",
    • "mailing_address_line1": "string",
    • "address_line2": "string",
    • "postal_code": "string",
    • "state": "string",
    • "location_name": "string",
    • "email_address": "string",
    • "mobile_number": "string",
    • "office_number": "string"
    }
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.