Fermo!Point API - Guida

Api pubbliche

PublicPoints

API pubbliche: Negozi (Point)

APIDescription
GET api/v{version}/public/points

Ottieni la lista di tutti i Point con le informazioni base.

GET api/v{version}/public/points/point/{id}

Ottieni il dettaglio di un Point, compreso l'url alla pagina di dettaglio su Fermo!Point.

GET api/v{version}/public/points/search?lat={lat}&lng={lng}&radius={radius}&day={day}&from={from}&to={to}

Filtra i Point per posizione (entro un certo raggio) e per giorno/ora di apertura. Raggio massimo 50km.

POST api/v{version}/public/points/search

Filtra i Point per posizione (entro un certo raggio) e per giorno/ora di apertura. Raggio massimo 50km.

GET api/v{version}/public/points/search-by-postalcode/{postalCode}?radius={radius}

Filtra i Point Codice di Avviamento Postale. Raggio massimo 50km.

POST api/v{version}/public/points/search-by-postalcode

Filtra i Point Codice di Avviamento Postale. Raggio massimo 50km.

PublicUsers

API private: Utenti

APIDescription
GET api/v{version}/public/users/nickname?nickname={nickname}

Controlla la disponibilità di un nickname per un nuovo utente

POST api/v{version}/public/users/nickname

Controlla la disponibilità di un nickname per un nuovo utente

GET api/v{version}/public/users/email?email={email}

Controlla la disponibilità di un indirizzo email per un nuovo utente

POST api/v{version}/public/users/email

Controlla la disponibilità di un indirizzo email per un nuovo utente

GET api/v{version}/public/users/check?nickname={nickname}&born_date={born_date}

Controlla la corrispondenza tra nickname e data di nascita di un utente

POST api/v{version}/public/users/check

Controlla la corrispondenza tra nickname e data di nascita di un utente

Api private

Booking

API private: Prenotazioni

APIDescription
POST api/v{version}/booking/book

Prenota un ritiro con Fermo!Point.

POST api/v{version}/booking/approve/{ticketId}

Conferma una prenotazione tramite numero di Fermo!Ticket.

POST api/v{version}/booking/approve-by-merchant-id/{merchantId}

Conferma una prenotazione tramite MerchantId.

POST api/v{version}/booking/cancel/{ticketId}

Annullamento una prenotazione tramite numero di Fermo!Ticket.

POST api/v{version}/booking/cancel-by-merchant-id/{merchantId}

Annullamento una prenotazione tramite MerchantId.

Compressed

API mixed: Negozi (Point)

APIDescription
GET api/v{version}/compressed/points/public

Ottieni la lista di tutti i Point con le informazioni base.

POST api/v{version}/compressed/points/private

Ottieni la lista di tutti i Point con le informazioni complete dei dettagli sugli orari d’apertura. ATTENZIONE! Il quantitativo di dati è corposo, si consiglia di salvare la risposta in una cache locale.

Deliveries

API private: Prenotazioni

APIDescription
POST api/v{version}/deliveries

Restiuisce le spedizioni dell'ecommerce, filtrate e ordinate.

POST api/v{version}/deliveries/delivery/{deliveryId}

Restiuisce i dettagli della spedizione corrispondente al codice Fermo!Ticket.

POST api/v{version}/deliveries/delivery-by-merchant-id/{merchantId}

Restiuisce i dettagli della spedizione corrispondente al merchantId.

POST api/v{version}/deliveries/delivery-by-ticket-id/{ticketId}

Restiuisce i dettagli della spedizione collegata al ticket (del pickup).

POST api/v{version}/deliveries/delivery

Prenota una spedizione con Fermo!Point (da Merchant a Point o indirizzo fisico).

POST api/v{version}/deliveries/delivery-nearby

Prenota una spedizione con Fermo!Point (da Merchant a Point o indirizzo fisico). In caso il point selezionato fosse chiuso verrà automaticamente utilizzato il point più vicino.

POST api/v{version}/deliveries/return

Prenota una reso con Fermo!Point (da Point o indirizzo fisico al Merchant).

POST api/v{version}/deliveries/delivery-by-merchant-id

Prenota una spedizione con Fermo!Point collegandola a un pickup tramite MerchantId.

POST api/v{version}/deliveries/cancel/{deliveryId}

Annullamento una prenotazione tramite MerchantId.

POST api/v{version}/deliveries/update/{deliveryId}

Aggiorna pesi e misure dei pacchi di una spedizione.

POST api/v{version}/deliveries/update-by-partner/{deliveryId}

Aggiorna una spedizione, impostando lo stato corrente e/o pesi e misure dei pacchi [Attivo solo per le logistiche partner Fermo!Point].

ECommerce

API private: ECommerce

APIDescription
POST api/v{version}/ecommerce/statuschanges/bytimeframe

Request Statuschanges for your e-commerce based on a DateStart/DateEnd Timeframe

POST api/v{version}/ecommerce/statuschanges/details

Request a list of all possible

POST api/v{version}/ecommerce/statuschanges/file/{FileFormat}

Request a file with Statuschanges for your e-commerce based on a DateStart/DateEnd Timeframe and a predefined file format.

POST api/v{version}/ecommerce/statuschanges/clientreference/{ClientReference}

Request Statuschanges for a particular shipment using the ClientReference

POST api/v{version}/ecommerce/statuschanges/orderid/{OrderID}

Request Statuschanges for a particular shipment using the OrderID.

POST api/v{version}/ecommerce/statuschanges/ticketid/{TicketID}

Request Statuschanges for a particular shipment using the TicketID

POST api/v{version}/ecommerce/authentication

Get a list of secondary authentication ClientID/Secret values created by the ECommerce

POST api/v{version}/ecommerce/authentication/create/{Name}

Get a list of secondary authentication ClientID/Secret values created by the ECommerce

POST api/v{version}/ecommerce/authentication/toggle/{LoginID}

Get a list of secondary authentication ClientID/Secret values created by the ECommerce

POST api/v{version}/ecommerce/authentication/change/{LoginID}

Get a list of secondary authentication ClientID/Secret values created by the ECommerce

Merchant

API private: Merchant

APIDescription
POST api/v{version}/merchant

Ottieni la lista di tutti i Point completa di tutti i dettagli. ATTENZIONE! Il quantitativo di dati è corposo, si consiglia di salvare la risposta in cache.

Orders

API private: Consegne

APIDescription
POST api/v{version}/orders

Restiuisce gli ordini dell'ecommerce, filtrati e ordinati.

POST api/v{version}/orders/light

Restiuisce la lista degli ordini semplificati dell'ecommerce da una data di partenza.

POST api/v{version}/orders/last?take={take}

Restiuisce gli ultimi ordini dell'ecommerce.

POST api/v{version}/orders/order/{ticketId}

Restiuisce i dettagli dell'ordine corrispondente al codice Fermo!Ticket.

POST api/v{version}/orders/order-by-merchant-id/{merchantId}

Restiuisce i dettagli dell'ordine corrispondente al merchantId.

Points

API private: Negozi (Point)

APIDescription
POST api/v{version}/points

Ottieni la lista di tutti i Point con le informazioni complete dei dettagli sugli orari d’apertura. ATTENZIONE! Il quantitativo di dati è corposo, si consiglia di salvare la risposta in una cache locale.

POST api/v{version}/points/search

Filtra i Point per posizione (entro un certo raggio) e per giorno/ora di apertura. ATTENZIONE! Il quantitativo di dati può essere corposo in caso di raggio troppo elevato (maggiore di 100km), si consiglia eventualmente di salvare la risposta in una cache locale.

POST api/v{version}/points/search-by-postalcode

Filtra i Point Codice di Avviamento Postale. ATTENZIONE! Il quantitativo di dati può essere corposo in caso di raggio troppo elevato (maggiore di 100km), si consiglia eventualmente di salvare la risposta in una cache locale.

Users

API private: Utenti

APIDescription
POST api/v{version}/users/nickname

Controlla la disponibilità di un nickname per un nuovo utente

POST api/v{version}/users/email

Controlla la disponibilità di un indirizzo email per un nuovo utente

POST api/v{version}/users/check

Controlla la corrispondenza tra nickname e data di nascita di un utente

POST api/v{version}/users/guest-check

Controlla la corrispondenza tra nickname e data di nascita con quelle dell'utente per il workflow OSPITE

Warehouse

API private: Merchant

APIDescription
POST api/v{version}/warehouse/shipment/{ShipmentBarCode}

No documentation available.