Sherpa - Visa and Travel Restrictions API

Sherpa Developer Hub

Welcome to the Sherpa developer hub. We offer a suite of solutions that guides travellers from planning to a safe return home. Take a look at the integration guides, specific use cases and an interactive API Reference. Ready? Let's go.

Guides    API Reference

Create an Order

Orders can be created by passing along a list of items (product ids and optionally application details). An unpaid order can be settled by invoking the pay endpoint for that specific order. At any given time, the status of an order can be viewed.

Create a new order for one traveller

curl -X POST \  'https://submission-api.joinsherpa.io/v1/orders?key=<<submissionApiKey>>' \  
  -H 'affiliateId: <<affiliateId>> \
  -d '{ 
    "contactName": "John Smith",    
    "contactEmail": "[email protected]",
    "items": [
    {   
    "productId": "TUR_EVISA__60_90DAYS",            
    "programId": "TUR_EVISA",
    "applicationData": {}
    }
    ]
}'

This results in an order with a status of CREATED and a paymentStatus UNPAID

Updated about a year ago


Create an Order


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.