Pircel provides you with APIs that you can use for processes involving your store and your partner carriers. For a procedure such as "Create Voucher", we provide you with an API call for all delivery companies.

How to send a request?

const response = await fetch("https://test-api.pircel.com", {
  method: "POST",
  mode: "cors",
  headers: new Headers({
    "Content-Type": "application/json",
    // replace '1234' with your API key
    apikey: "1234"
  }),
  body: JSON.stringify({
    query: `mutation createVoucher(: String, : String!, : Int!, : Date){
      createVoucher(notes: , orderId: , packagesQuantity: , pickupDate: ){
        voucherPrintDocuments
        vouchers
      }
    }`,
    variables: {
      notes: "Fragile packages",
      orderId: "14317",
      packagesQuantity: 2,
      pickupDate: "2023-10-03",
    }
  })
});

With JavaScript, it is possible to just use a template literal and simplify the API call body.

const response = await fetch('https://test-api.pircel.com', {
  method: 'POST',
  mode: 'cors',
  headers: new Headers({
    'Content-Type': 'application/json',
    // replace '1234' with your API key
    apikey: '1234',
  }),
  body: JSON.stringify({
    query: `mutation {
      createVoucher(
        notes: "Fragile",
        orderId: "A1",
        packagesQuantity: 1,
        pickupDate: "2023-03-06",
      ) {
        vouchers
        voucherPrintDocuments
      }
    }`
  }),
});

You can find a working example on codesandbox.

We are using GraphQL API.

GraphQL is a query language and server-side runtime for application programming interfaces (APIs) that prioritizes giving clients exactly the data they request and no more. GraphQL is designed to make APIs fast, flexible, and developer-friendly.

API are separate in two categories query & mutation:

query: When we want to read an information that is already stored.

structure:

{
   field(arg: "value") {
     subField
   }
}

mutation: When we want to change information (create, update, delete).

structure:

mutation {
  field (arg: "value") {
    subField
  }
}

More info about GraphQL

You can go to https://test-api.pircel.com and have access to try all the queries/mutations (API) we provide to you.

To try any of the API first you should add a shipment.

Follow the link and run the default mutation that we provide to you.

The following error messages were suggested:

                'addShipment.invalidPostcode' ⇒ Μη έγκυρος ταχυδρομικός κώδικας
                'addShipment.orderIdAlreadyExists' ⇒ Η παραγγελία υπάρχει ήδη
                
                'authenticate.invalidToken' ⇒ Μη έγκυρο authentication token, παρακαλώ συνδεθείτε ξανά
                
                'cancelVoucher.eshopNotFound' ⇒ Δεν βρέθηκε ηλεκτρονικό κατάστημα
                'cancelVoucher.orderNotFound' ⇒  Δεν βρέθηκε η παραγγελία
                
                'createPickupList.invalidDeliveryCompany' ⇒  Μη έγκυρη μεταφορική εταιρεία
                'createPickupList.noShipmentsForSelectedDeliveryCompanies' ⇒ Δεν βρέθηκαν οι αποστολές για τις επιλεγμένες μεταφορικές εταιρείες
                'createPickupList.noShipmentsFound' ⇒  Δεν βρέθηκαν οι αποστολές
                'createPickupList.unprintedVouchers' ⇒ Βρέθηκαν μη εκτυπωμένα παραστατικά
                
                'createVoucher.invalidDeliveryCompany' ⇒ Μη έγκυρη μεταφορική εταιρεία
                'createVoucher.invalidPickupDate' ⇒ Μη έγκυρη ημερομηνία παραλαβής
                'createVoucher.newArgsCancelFirstExistingVouchers' ⇒ Αδυναμία δημιουργίας ή λήψης νέου παραστατικού. Το παραστατικό έχει ήδη δημιουργηθεί για αυτή την παραγγελία. Παρακαλούμε για να προβείτε σε νέα δημιουργία ακυρώστε πρώτα το προηγούμενο παραστατικό.
                'createVoucher.orderNotFound' ⇒ Δεν βρέθηκε παραγγελία
                
                'forbidden'⇒ Απαγορεύεται η πρόσβαση
                'invalidpickuDateType', ⇒ Μη έγκυρη μορφή ημερομηνίας παραλαβής
                'login.userNotFound' ⇒ Δεν βρέθηκε ο χρήστης
                
                'pintVoucher.canceledVouchersFound' ⇒ Βρέθηκαν ακυρωμένα παραστατικά
                'printVoucher.orderNotFound' ⇒ Δεν βρέθηκε η παραγγελία
                'printVoucher.vouchersNotFound' ⇒ Δεν βρέθηκαν παραστατικά
                
                'updateShipment.invalidPostcode' ⇒ Μη έγκυρος ταχυδρομικός κώδικας
                'updateShipment.orderIdCannotChange' ⇒ Ο κωδικός της παραγγελίας δεν μπορεί να αλλάξει
                'updateShipment.shipmentCannotChange' ⇒ Η παραγγελία δεν μπορεί να αλλάξει γιατι έχουν ήδη δημιουργηθεί παραστατικά
                
                'speedex.apiInaccessible' ⇒ Το API της Speedex δεν είναι διαθέσιμο
                'speedex.cannotCreateSession' ⇒ Το API της Speedex δεν είναι διαθέσιμο
                'createVoucher.speedex.invalidPostcode' ⇒ Μη έγκυρος ταχυδρομικός κώδικας
                'speedex.noResponse' ⇒ Το API της Speedex δεν είναι διαθέσιμο
                'printPickupList.speedex.noPickupListNumber' ⇒ Δεν υπάρχει αριθμός λίστας παραλαβής
                'printVoucher.speedex.noVoucher' ⇒ Δεν βρέθηκε παραστατικό
                

# Test (Currently offline):
https://test-api.pircel.com
# Production:
https://api.pircel.com

# Your API token from the dashboard. Must be included in all API calls.
apikey: <YOUR_TOKEN_HERE>