The Alfred24 API allows merchants or factory to integrate their ecommerce or services with Alfred24's internal system.
\nThe Alfred24 API allows you to take advantage of the potential of our software that offers more shipping options and helps merchants and factory to increase their business.
\nThe Alfred24 itegration, implement several services, including:
\nFor a certain Flow to work, you must be able to:
\nThe Alfred24 API is a general solution for multiple type of users to integrate with and was designed in a way that allows to develop its own middleware application between its core business logic and Alfred24.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"17598390","collectionId":"5d2656c4-33ca-47d4-b725-21f6b6eec0e9","publishedId":"2s93CNLsC7","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00D5CA"},"publishDate":"2023-02-23T10:50:07.000Z"},"item":[{"name":"GetToken","id":"02f38694-3c31-4151-b802-b09b82f2f979","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user\": \"userame_alfred24\",\n \"password\": \"password_alfred24\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.alfred24.it/wd/GetToken","description":"Before making a request to Alfred24, retrieve the apitoken token from our server.
\n\nThis value allow us to identify what kind of operation you can do and to retreive all the information about the user.
\n
To obtain this data a call to GetToken must be provided.
Use your username and password to access at Alfred24 platform.
This enpoint returns an access_token in JTW format which identifies the user via the api functionality.
The JWT is valid for 60 minutes; once it has expired, a new one must be recreated.
In HEADER you MUST set a Authorization field whit Basic + base64 encoding of username and password separated by a \":\" used to access to Alfred24*.
\n\nexample: Basic base64(test@alfred24.com:mypassword123)
\n
*You can get this data making a call to GetToken enpoint. The value is in base64Data of the response
This endpoint provide a list of Alfred Points.
\nInto the request you must specified your apitoken,
The following parameters must be specified in the request
\ncountry: country code (es: IT, FR)
address: the addressvalue can be:
piazza Verdi, Milano)0123)service: list of services offered by POINT ALFRED:
shipment: it is possible to create shipments from the Alfred24 Pointdelivery: the Alfred24 Point offers a delivery servicep2p: the Alfred24 point operates PUDO to PUDO shipmentsdistance: distance in km from the indicated address (es: 5)
pointOpeningTime: detailed information on opening hours of pudos, days of the week(1=Monday - 7=Sunday) and closing day.
This endpoint return a list of shipments for user autenticated via access_token.
The parameter limit must be specified in the request
The parameters for the request are:
\nlimit : (mandatory) this parameter set the number of shipments showed by the request.
tracking_status: (optional) This parameter apply a filter on shipment status. The valid values are:
CONSEGNATAIN CONSEGNACANCELLATACONSEGNATA ALL'HUBIN ATTESAIN GIACENZAIN TRANSITOINVALIDATAPARTITARIFIUTATARITIRATARITIRATA DAL POINTRITIRO ASSEGNATOSCADUTEThis endpoint returns information and tracking status of a shipment.
A GET call with barcode parameter is required for obtaining all informations.
This endpoint return a list of rates for a shipment.
\nIs mandatory to be autenticated via api_token.
The parameters for the request are:
\norigin/destination info: (mandatory)
shipment_value: (mandatory only for shipments outside Italy****__)
shipment_cashondelivery: (optional)
shipment_insurance: (optional)
package: (all data are mandatory).
weight: in Kgheight / width / depth: in cmYou can specify a multi-package shipment adding more data. Example:
\n\"package\": [{\n \"weight\": \"1.5\",\n \"height\": \"40\",\n \"width\": \"40\",\n \"depth\": \"60\"\n },\n {\n \"weight\": \"2\",\n \"height\": \"48\",\n \"width\": \"50\",\n \"depth\": \"35\"\n }\n ]\n\nThis enpoint enables the creation of shipments, in Italy and European countries, via API
\nIs mandatory to be autenticated via access_token.
The parameters for the request are:
\nlabel_format: (mandatory) label format. Valid values:
id_quotation: (mandatory) value id_preventivo obtained in GetRates. From this value, the postcode and departure and arrival location values of the shipment being created will be automatically obtained
sender: (mandatory) address information and sender's personal data
receiver: (mandatory) address information and receiver's personal data
pickup: (optional) shipment pickup information. If empty, the shipment will be picked up at the sender's address
shipment: (optional) shipment optional information (custom pickup date, notes, etc)
The system checks the availability of credit on the Alfred24 wallet via the access_token. If the shipment amount is greater than the remaining credit, the creation of the shipment will not be successful.
\n","urlObject":{"protocol":"https","path":["wd","CreateShipment"],"host":["api","alfred24","it"],"query":[],"variable":[]}},"response":[],"_postman_id":"2fba6212-bf97-4351-96e7-9eac602510f3"},{"name":"CheckShipment","id":"d4892119-db5f-46ea-9e87-a57092cf9527","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\t\t\t\"apitoken\": \"ABcdEfk123QcTtNQQv0HqjJJeAUqmyvKoXS123ZRC6o!@&\",\r\n\t\t\t\t\"barcode\": \"18012000001668\" \r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.alfred24.it/wd/CheckShipment","description":"This endpoint check if a shipment exist on Alfred24.
\nA GET call with a valid apitoken and barcode parameters is required for obtaining the informations.
This endpoint allows you to import orders from your CSM/Software into the Alfred24 platform.
it is possible to create shipments from a pickup address different from that of the user identified with the token (e.g. drop-shipping).
The information of the sender of the shipment is automatically obtained from the system through the validation of the apitoken.
The parameters of the Request are:
\napitoken: (mandatory)
id_connector:(mandatory) APi integration id. This value is provided by us.
orderNumber: (mandatory) internal order number from your system.
orderReference : (optional) internal order reference from your system.
payment_status: (optional) short description about payment
payment_method: (optional) order payment status. The allowed values are:
cod : cash on deliverytransfer : bank transfercreditcardstripepaypalamazon : for amazon payklarnasatispayclearpaydelivery_Point : (optional) idPoint obtained from the GetPoints call. If set, the shipment will have the receiver values as recipient, but the delivery point will be the selected Alfred24 Point.
receiver: (mandatory) shipment delivery data
pickup: (optional) pickup parcel data (es: drop-shipping)
product: (optional) information about products
order_id: (optional) order number for the item, useful only for research purposes on the Alfred24 platform.
\n","urlObject":{"protocol":"https","path":["wd","ImportOrder"],"host":["api","alfred24","it"],"query":[],"variable":[]}},"response":[{"id":"742bd051-10bc-4877-8da8-130ffa6a7ecd","name":"ImportOrder","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"apitoken\": \"ABcdEfk123QcTtNQQv0HqjJJeAUqmyvKoXS123ZRC6o!@&8\",\r\n \"id_connector\": 1,\r\n \"delivery_Point\": \"9999\", \r\n \"orderNumber\": \"123456\",\r\n \"orderReference\": \"ABCDEF\",\r\n \"payment_status\": \"pagato\",\r\n \"payment_method\": \"paypal\",\r\n \"receiver\": [\r\n {\r\n \"lastname\": \"LUIGI\",\r\n \"firstname\": \"VERDI\",\r\n \"address\": \"Via Vittorio Veneto, 31\",\r\n \"postcode\": \"20127\",\r\n \"city\": \"Milano\",\r\n \"phone\": \"3351616156\",\r\n \"email\": \"luigiverdi@gmail.com\"\r\n }\r\n ],\r\n \"pickup\": [\r\n {\r\n \"company\": \"My Warehoyse\",\r\n \"address\": \"Via Roma, Milano\",\r\n \"postcode\": \"20123\",\r\n \"city\": \"Milano\",\r\n \"province\": \"Mi\",\r\n \"phone\": \"333145687\",\r\n \"email\": \"warehouse@test.it\"\r\n }\r\n ],\r\n \"products\": [\r\n \t{\r\n\t\t\t\"order_id\": \"cc33\",\r\n \"description\": \"Penna Rossa\",\r\n \"qty\": 1,\r\n \"weight\":6.4,\r\n \"price\" : 10\r\n },\r\n\t\t{\r\n \"order_id\": \"bb22\",\r\n\t\t\t\"description\": \"Matita\",\r\n \"qty\": 2,\r\n \"weight\":8.5,\r\n \"price\" : 20\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.alfred24.it/wd/ImportOrder"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 03 Mar 2023 11:19:31 GMT"},{"key":"Server","value":"Apache"},{"key":"Access-Control-Allow-Methods","value":"PUT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"3600"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Access-Control-Allow-Headers, Authorization, X-Requested-With"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"response_code\": \"200\",\n \"status\": \"Success\",\n \"message\": \"Order #abc123 imported on Alfred24\"\n}"}],"_postman_id":"bb03aaf8-5c4d-46fc-b1e7-2309f5a2715f"},{"name":"DeleteOrder","id":"9008a96d-8963-4b50-94ec-0bbd2c6cd718","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"apitoken\": \"ABcdEfk123QcTtNQQv0HqjJJeAUqmyvKoXS123ZRC6o!@&\",\r\n \"orderNumber\": \"abc123\"\r\n}"},"url":"https://api.alfred24.it/wd/DeleteOrder","description":"This endpoint allows you to delete orders previously imported to Alfred24.
Only orders that have not already been shipped can be eliminated.
The parameters of the Request are:
\napitoken (mandatory)
orderNumber (mandatory): internal order number from your system.