organic-alliance

Extranet for Organic Alliance website

Opérations concernant les commandes.

Récupérer une commande

GET /command/{id}

Créer une commande

POST /command

Ajouter un produit à une commande

POST /order/{orderId}/products/{productId}

Commandes

GET /command/{id}

Authentication

oauth2

Retourne une commande

Path variables

id

string required

Identifiant de la commande

Responses

200 OK

La commande a été récupérée avec succès.

Body

Commande

Examples

Commande possédant l’id passé en paramètre

{
    "id": "651651"
}

401 Unauthorized

Body

Statut

Examples

{
    "success": "false",
    "code": 401,
    "message": "Non autorisé"
}

Commandes

POST /command

Crée une nouvelle commande à l’utilisateur connecté

Request body

Commande

Responses

201 Created

Body

Statut

Examples

{
    "success": "true"
}

Commandes

POST /order/{orderId}/products/{productId}

Ajoute un le produit ayant l’identifiant productId à la commande ayant l’idenfiant orderId.

Path variables

orderId

string required

ID de la commande

productId

string required

ID du produit

Request parameters

quantity

string required

Quantité du produit à ajouter à la commande

Responses

200 OK

Body

Commande

Examples

Commande auquelle le produit a été ajoutée.

{
    "id": "651651",
    "isPreorder": "true"
}

401 Unauthorized

Erreur renvoyée si l’utilisateur n’est pas connecté, si la commande ayant l’identifiant orderId ne lui appartient pas, si le produit productId ne peut pas être ajouté à cette commande, si la commande ne peut plus être modifiée. Le message d’erreur doit préciser la raison.

Body

Statut

Examples

{
    "success": "false",
    "code": 401,
    "message": "Non autorisé"
}

Opérations concernant les contacts.

Récupérer un contact

GET /contact/{contactId}

Contacts

GET /contact/{contactId}

Retourne un contact

Path variables

contactId

string required

ID du contact

Représente un contact (correspond à un utilisateur), appartenant à une entreprise cliente.

Object

id

string

Identifiant de l’utilisateur

Example:

1235

username

string

Nom de l’utilisateur

Example:

Robert Dupont

Représente une entreprise cliente.

Object

id

string

ID du client

Example:

252

name

string

Nom du client

Example:

Super U

Représente une société vendeuse de produit/

Object

id

string

Identifiant de la société

Example:

1

name

string

Nom de la société

Example:

ProNatura

Représente une commande

Object

id

string

Identifiant de la commande

Example:

651651

isPreorder

boolean

Vaut true si il s’agit d’une précommande, false s’il s’agit d’une commande

Example:

true

Représente un produit vendu par une société qui peut être acheté par un client.

Object

id

string

ID du produit

Example:

121540

name

string

Nom du produit

Example:

Avocat

Représente un avoir

Object

id

string

Identifiant de l’avoir

Example:

8541

Représente un statut de retour pour les opérations pouvant renvoyer des erreurs ou simplement la validation du succès de l’opération.

Object

Examples:

{
    "success": false,
    "code": 404,
    "message": "Produit non trouvé"
}

{
    "success": false,
    "code": 403,
    "message": "Action non autorisée"
}

{
    "success": "true"
}

success

string required

Booléen indiquant l’erreur

Enumeration:

true

Succès de l’opération

false

L’opération a échoué

code

integer

Si “success” vaut true, code d’erreur

Example:

404

message

string required

Message d’erreur ou de confirmation de réussite de l’opération

Example:

Produit non trouvé