Skip to main content
API docs by Redocly

Hipli API (1.0.0)

Download OpenAPI specification:Download

API Support mail: tech@hipli.fr

Hipli API for customers and partners.

Register a new order

Register a new order

Request Body schema: application/json
required
object
firstName
string

First name of the client

lastName
string

Last name of the client

mail
string <email>

Email of the client

destinationCountry
string

Country code of the destination in ISO 3166 format 2 or 3 characters

  • FR
  • FRA
hipliSku
string

Hipli SKU of the product

numberOfProduct
integer

Number of products in the order

orderDate
string <date-time>

Date of the order in ISO8601 format

sourceId
string

Order number in your system

sourceShop
string

the name of your shop in our system (contact tech@hipli.fr if you don't have it)

Responses

Request samples

Content type
application/json
{
  • "sourceId": "123456",
  • "sourceShop": "HipliShop",
  • "orderDate": "2020-01-01T00:00:00Z",
  • "destinationCountry": "FR",
  • "numberOfProduct": 3,
  • "client": {
    },
  • "hipliSku": "HIP123456789012"
}

Scan one or more parcels

Endpoint to declare events on parcels

Authorizations:
bearerAuth
Request Body schema: application/json
required
action
string
Enum: "PRODUCT_RETURN" "SEND_CLIENT"

Action to perform on parcels:

  • PRODUCT_RETURN - Parcel is returned from your customer
  • SEND_CLIENT - Parcel is sent to your customer
date
string <date-time>

Date of the event

parcelIds
array of string

List of parcel ids to scan (format can be different)

Responses

Request samples

Content type
application/json
{
  • "parcelIds": [
    ],
  • "action": "PRODUCT_RETURN",
  • "date": "2020-01-01T00:00:00Z"
}