Yango Delivery

accept_delivery_claim

• ⚠Authenticate with 'Authorization: Bearer <OAuth token>'. The token comes from your Yango Delivery account (log in with the credentials your Yango Delivery manager gives you, Integration tab, Get token). It remains valid indefinitely, but changing the account password invalidates it; an invalid token answers 401 unauthorized.
• ⚠Confirming starts the courier search: the status becomes accepted, then performer_lookup.
• ⚠The offer is valid 10 minutes after ready_for_approval. The FAQ says confirming an expired offer still answers 200 and the claim then turns failed, while this endpoint also documents a 409 offer_expired: handle both, and check the status afterwards with get_delivery_claim. Before confirming, an expired offer can be re-evaluated by editing the claim or by creating a new claim with a new request_id; once the claim is failed, create a new claim.
• ⚠Before confirming, read warnings[]: the FAQ says not_fit_in_car can come together with the ready_for_approval status when the items may not fit the vehicle, and check_delivery_price notes that a courier can refuse items exceeding the allowed dimensions on site, with the minimum fee withheld.
• ⚠Send the claim's current version (from get_delivery_claim); each edit increases it. The 409 codes include old_version, named without a description.
• ⚠Errors return { code, message }: branch on code. Documented on this endpoint: 404 not_found; 409 inappropriate_status, old_version, offer_expired, state_mismatch; 429 too_many_requests. The error guide adds 401 unauthorized (invalid token) and 500 (try again or change the request).
• ⚠Accept-Language is a required header on this endpoint (e.g. en); this example sends en.
• ⚠No test environment is documented: requests go to the production host, and confirming a claim starts the search for a courier. The error guide mentions test accounts (required_tariffs_disabled_for_user: 'Test account has expired or the specified rate is disabled') — ask your manager for one before testing.

cancel_delivery_claim

• ⚠Authenticate with 'Authorization: Bearer <OAuth token>'. The token comes from your Yango Delivery account (log in with the credentials your Yango Delivery manager gives you, Integration tab, Get token). It remains valid indefinitely, but changing the account password invalidates it; an invalid token answers 401 unauthorized.
• ⚠Call get_cancellation_terms first and send its cancel_state with the claim's current version. The 409 codes include state_mismatch and free_cancel_is_unavailable; the reference names them without describing when each one is returned.
• ⚠Free cancellation lasts until the courier arrives at the pickup point (all pages agree). The paid window is contradictory: the getting-started page and the FAQ make cancellation paid once the courier has arrived but hasn't picked up the items, while the cancel reference says paid cancellation is available before the courier starts moving to the pickup point. Rely on cancel_state from get_cancellation_terms, never on the status alone.
• ⚠This method only works before the items are handed over to the courier; after that, contact the support service.
• ⚠A free cancellation ends in status cancelled, a paid one in cancelled_with_payment (the FAQ spells the first one 'canceled'; the status enum says cancelled). The status model adds cancelled_with_items_on_hands: paid and without a return, for claims created with optional_return.
• ⚠Accept-Language is a required header on this endpoint (e.g. en); this example sends en.
• ⚠Errors return { code, message }: branch on code. Documented on this endpoint: 400 bad_request; 404 not_found; 409 inappropriate_status, free_cancel_is_unavailable, state_mismatch. The error guide adds 401 unauthorized (invalid token) and 500 (try again or change the request).

check_delivery_price

• ⚠Authenticate with 'Authorization: Bearer <OAuth token>'. The token comes from your Yango Delivery account (log in with the credentials your Yango Delivery manager gives you, Integration tab, Get token). It remains valid indefinitely, but changing the account password invalidates it; an invalid token answers 401 unauthorized.
• ⚠This is a first estimate, without creating a claim. The price you confirm is the offer computed after create_delivery_claim (pricing.offer in get_delivery_claim).
• ⚠Coordinates are [longitude, latitude] — in that order. The error guide links unknown_zone to coordinates sent in the wrong order.
• ⚠requirements.taxi_class is courier, express or cargo. The reference lists cargo_type van, lcv_m, lcv_l and lcv_xl; the FAQ gives weight caps only for courier (10 kg), express (20 kg) and van / lcv_m / lcv_l (300 / 700 / 1400 kg). Loaders: the reference says 0, 1 or 2, the FAQ 1 or 2.
• ⚠Send real item dimensions: without them the rate's maximum dimensions are assumed, and a courier can refuse an item that exceeds them on site — the minimum fee is still withheld.
• ⚠Accept-Language is a required header on this endpoint (e.g. en); this example sends en.
• ⚠delivery.yango.com lists Côte d'Ivoire, Ghana, Senegal and Zambia under Africa. The Côte d'Ivoire and Senegal pages mention API integrations; the Ghana and Zambia pages say 'integrations' without naming the API. Every example in this reference uses UAE data (AED prices, +971 phone numbers): confirm with your Yango Delivery manager that API access is open in your country.
• ⚠No test environment is documented: requests go to the production host, and confirming a claim starts the search for a courier. The error guide mentions test accounts (required_tariffs_disabled_for_user: 'Test account has expired or the specified rate is disabled') — ask your manager for one before testing.
• ⚠Errors return { code, message }: branch on code. Documented on this endpoint: 400 bad_request, address_not_found; 409 errors.suitable_offer_not_found, estimating.cant_construct_route, estimating.cargocorp_payment_failure, estimating.claim.no_zone_id, estimating.limited_by_claims_creation_overflow, estimating.no_pickup_point, estimating.payment_method_cant_order, estimating.payment_method_zone_unavailable, estimating.permitted_tariffs_not_enough, estimating.requirement_unavailable, estimating.route_too_long, estimating.tariff.no_categories, estimating.tariff.no_categories_in_zone, estimating.tariff.no_sdd_tariff, estimating.tariff.no_tariff_plan, estimating.too_large_linear_size, estimating.too_many_loaders, estimating.warning.too_heavy_item, estimating.warning.too_large_item; 429 too_many_requests. The error guide adds 401 unauthorized (invalid token) and 500 (try again or change the request).

create_delivery_claim

• ⚠Authenticate with 'Authorization: Bearer <OAuth token>'. The token comes from your Yango Delivery account (log in with the credentials your Yango Delivery manager gives you, Integration tab, Get token). It remains valid indefinitely, but changing the account password invalidates it; an invalid token answers 401 unauthorized.
• ⚠request_id (query) is the idempotency key: send a new one (a UUID) per claim, and reuse the same value only to retry after a 5xx or a timeout — otherwise the claim can be duplicated and several couriers may come. An old request_id returns the old claim, whatever the body.
• ⚠A 200 means the claim exists, not that the order is accepted: it starts as new, then estimating. Poll get_delivery_claim until ready_for_approval (or estimating_failed, with reasons in error_messages), then confirm with accept_delivery_claim within 10 minutes.
• ⚠Each item's pickup_point and droppof_point (spelled this way here; check_delivery_price uses dropoff_point) must match a route_points[].point_id. Route points need point_id, visit_order (the pickup point is always 1) and type source or destination.
• ⚠Send route_points[].address.coordinates as [longitude, latitude] — in that order. The FAQ calls them mandatory (they're used to create route points) although the table marks the field optional; the error guide links unknown_zone to coordinates sent in the wrong order.
• ⚠Without client_requirements.taxi_class, item dimensions and weight are mandatory (the vehicle is chosen from them). due schedules the courier's arrival, at most 3 days ahead. external_order_id can only be sent on destination points.
• ⚠items[].cost_value and cost_currency (a three-letter code) are mandatory. The FAQ suggests cost_value "0" with cost_currency "AED" when the price is unknown, and no African currency appears in the reference: confirm the currency with your manager.
• ⚠Phone numbers start with + and the country code (format +97142774444 in the docs). contact.email is mandatory for source and return points, although the schema only marks name and phone as required.
• ⚠skip_confirmation defaults to false: a confirmation code is needed at each point. At pickup it goes to the sender by text message, in their account or by API; at delivery it goes to the recipient by text message, and they give it to the courier.
• ⚠callback_properties.callback_url is deprecated in favour of get_claims_journal. The callback only appends updated_ts and claim_id to your URL, the reference documents no signature, and delivery stops after failed attempts: always read the state with get_delivery_claim.
• ⚠auto_accept (confirm automatically after creation) needs your manager's approval.
• ⚠Accept-Language is a required header on this endpoint (e.g. en); this example sends en.
• ⚠delivery.yango.com lists Côte d'Ivoire, Ghana, Senegal and Zambia under Africa. The Côte d'Ivoire and Senegal pages mention API integrations; the Ghana and Zambia pages say 'integrations' without naming the API. Every example in this reference uses UAE data (AED prices, +971 phone numbers): confirm with your Yango Delivery manager that API access is open in your country.
• ⚠No test environment is documented: requests go to the production host, and confirming a claim starts the search for a courier. The error guide mentions test accounts (required_tariffs_disabled_for_user: 'Test account has expired or the specified rate is disabled') — ask your manager for one before testing.
• ⚠Errors return { code, message }: branch on code. Documented on this endpoint: 400 validation_error, sdd_items_without_parameters_forbidden, items_without_parameters_forbidden, sdd_multipoints_not_supported, address_too_far, address_not_found, bad_request, invalid_post_payment, sdd_client_requirements_forbidden, invalid_delivery_interval, wrong_pickup_code_format, wrong_pickup_code_usage, unknown_zone, invalid_time_intervals, unsupported_points_count, invalid_phone_incorrect_symbol, invalid_phone_must_start_plus_symbol, country_phone_code_not_supported, invalid_phone_size_incorrect, item_destination_point_not_found, invalid_destination_point, due_in_past, delay_too_long, external_order_id_not_allowed, address_outside_delivery_zone, invalid_buyout_point_type, payment_on_delivery_missed, payment_on_delivery_invalid_request, max_order_cost_exceeded, invalid_post_payment_payment_method, invalid_buyout_payment_method, invalid_source_point, invalid_point_phone, invalid_item_destination_point, invalid_item_source_point, different_cost_currencies; 403 buyout_disabled, payment_on_delivery_disabled, forbidden_by_antifake; 429 too_many_requests. The error guide adds 401 unauthorized (invalid token) and 500 (try again or change the request).

get_cancellation_terms

• ⚠Authenticate with 'Authorization: Bearer <OAuth token>'. The token comes from your Yango Delivery account (log in with the credentials your Yango Delivery manager gives you, Integration tab, Get token). It remains valid indefinitely, but changing the account password invalidates it; an invalid token answers 401 unauthorized.
• ⚠cancel_state is free, paid or unavailable. Pass free or paid unchanged to cancel_delivery_claim. The reference doesn't describe unavailable: don't call cancel_delivery_claim with it.
• ⚠Free cancellation lasts until the courier arrives at the pickup point (all pages agree). The paid window is contradictory: the getting-started page and the FAQ make cancellation paid once the courier has arrived but hasn't picked up the items, while the cancel reference says paid cancellation is available before the courier starts moving to the pickup point. Rely on cancel_state from get_cancellation_terms, never on the status alone.
• ⚠After the courier has picked up the items, only the support service can cancel the order.
• ⚠Accept-Language is a required header on this endpoint (e.g. en); this example sends en.
• ⚠Errors return { code, message }: branch on code. Documented on this endpoint: 400 bad_request; 404 not_found. The error guide adds 401 unauthorized (invalid token) and 500 (try again or change the request).

get_claims_journal

• ⚠Authenticate with 'Authorization: Bearer <OAuth token>'. The token comes from your Yango Delivery account (log in with the credentials your Yango Delivery manager gives you, Integration tab, Get token). It remains valid indefinitely, but changing the account password invalidates it; an invalid token answers 401 unauthorized.
• ⚠This is the documented replacement for the deprecated callback. Store the returned cursor and send it on the next call; without a cursor, the docs say all changes are returned 'with a certain limit'.
• ⚠The docs describe 'the change history of the claim', but the body takes no claim_id and each event carries its own claim_id: the reference doesn't say which claims the feed covers. Filter events by event.claim_id.
• ⚠change_type is status_changed or price_changed; terminal statuses carry resolution success or failed.
• ⚠The status model also lists pay_waiting (pending payment, with payment on delivery), which the status enum of this reference leaves out: don't reject an unknown status value.
• ⚠Errors return { code, message }: branch on code. Documented on this endpoint: 400 invalid_cursor; 429 too_many_requests. The error guide adds 401 unauthorized (invalid token) and 500 (try again or change the request).

get_delivery_claim

• ⚠Authenticate with 'Authorization: Bearer <OAuth token>'. The token comes from your Yango Delivery account (log in with the credentials your Yango Delivery manager gives you, Integration tab, Get token). It remains valid indefinitely, but changing the account password invalidates it; an invalid token answers 401 unauthorized.
• ⚠Key statuses: ready_for_approval (confirm within 10 minutes), estimating_failed (reasons in error_messages; edit the claim to retry), performer_not_found (no courier: create a new claim later), delivered_finish and returned_finish (completed), failed.
• ⚠The callback section of create_delivery_claim warns that this method may return an older claim state: compare updated_ts with what you already have and call again after 5 to 30 seconds.
• ⚠Before confirming, read warnings[]: the FAQ says not_fit_in_car can come together with the ready_for_approval status when the items may not fit the vehicle, and check_delivery_price notes that a courier can refuse items exceeding the allowed dimensions on site, with the minimum fee withheld.
• ⚠If the recipient doesn't answer within 10 minutes of the courier's arrival (delivery_arrived), the items are returned to the sender.
• ⚠The status model also lists pay_waiting (pending payment, with payment on delivery), which the status enum of this reference leaves out: don't reject an unknown status value.
• ⚠version is the claim's current version: accept_delivery_claim and cancel_delivery_claim need it.
• ⚠pricing.offer holds the offer to confirm: price is without VAT, price_with_vat includes it, and valid_until is the offer's expiry. From performer_found on, performer_info describes the courier and vehicle. Finding a courier takes no more than 30 minutes for an immediate claim.
• ⚠Accept-Language is a required header on this endpoint (e.g. en); this example sends en.
• ⚠delivery.yango.com lists Côte d'Ivoire, Ghana, Senegal and Zambia under Africa. The Côte d'Ivoire and Senegal pages mention API integrations; the Ghana and Zambia pages say 'integrations' without naming the API. Every example in this reference uses UAE data (AED prices, +971 phone numbers): confirm with your Yango Delivery manager that API access is open in your country.
• ⚠Errors return { code, message }: branch on code. Documented on this endpoint: 400 bad_request; 404 not_found; 429 too_many_requests. The error guide adds 401 unauthorized (invalid token) and 500 (try again or change the request).

get_tracking_links

• ⚠Authenticate with 'Authorization: Bearer <OAuth token>'. The token comes from your Yango Delivery account (log in with the credentials your Yango Delivery manager gives you, Integration tab, Get token). It remains valid indefinitely, but changing the account password invalidates it; an invalid token answers 401 unauthorized.
• ⚠sharing_link is only available on destination points: pick the route point of type destination.
• ⚠A 409 means 'Inactive claim or no courier tracking links' (codes unknown_tracking_links, inappropriate_status): this example throws on it, so handle the error.
• ⚠Errors return { code, message }: branch on code. Documented on this endpoint: 404 not_found; 409 unknown_tracking_links, inappropriate_status; 429 too_many_requests. The error guide adds 401 unauthorized (invalid token) and 500 (try again or change the request).