Endpoint
POST | https://api.iglobalstores.com/v1/orderNumbers
Requête HTTPS
| Champ | Remarques |
|---|---|
| Méthode HTTP | POST |
| Endpoint | https://api.iglobalstores.com/v1/orderNumbers |
| Protocole | HTTPS |
| Format du message | JSON |
| En-tête HTTP Accept | Accepter : application/json |
| En-tête HTTP Content-Type | Content-Type : application/json |
Clé/valeur JSON dans le corps de la requête
Format du message : JSON
EXEMPLE DE REQUÊTE : sinceOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceOrderId": "999-99999"
}
EXEMPLE DE DEMANDE : sinceDate
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101"
}
EXEMPLE DE DEMANDE : sinceDate, throughDate
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"throughDate": "20150601"
}
EXEMPLE DE DEMANDE : missingMerchantOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"missingMerchantOrderId": true
}
EXEMPLE DE DEMANDE : statuts
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"statuses": true
}
Définitions JSON de la requête
| champ | notes |
|---|---|
missingMerchantOrderId FACULTATIF, si un autre paramètre est passé | Ce paramètre est utilisé pour interroger un ensemble de commandes des deux dernières semaines qui manquent de merchantOrderId. Lorsque le merchantOrderId est soumis via le point de terminaison API updateMerchantOrderID, les commandes n'apparaîtront plus dans cette requête. boolean: true/false |
secret REQUIS | GUID secret de l'API fourni par Zonos. string |
sinceDate FACULTATIF, si le paramètre sinceOrderId est passé. | Ce paramètre est utilisé pour interroger un ensemble de commandes après une date particulière. sinceDate et sinceOrderId ne peuvent pas être envoyés ensemble. string - date UTC/GMT; format: yyyymmdd |
sinceOrderId FACULTATIF, si le paramètre sinceDate / throughDate est passé | L'ID de commande Zonos, peut être envoyé avec ou sans l'ID de votre magasin et le trait d'union (Exemple: 123-45678 ou 45678). Remarque : Ce paramètre sera utilisé pour interroger un ensemble de commandes après une commande Zonos particulière. sinceDate et sinceOrderId ne peuvent pas être envoyés ensemble. integer / string |
statuses FACULTATIF | Ce paramètre est utilisé pour inclure le statut de commande actuel et merchantOrderId dans la réponse. S'il est présent dans la requête, quel que soit sa valeur, il inclura les statuts. boolean: true |
store REQUIS | ID de magasin fourni par Zonos. integer |
throughDate FACULTATIF | Ce paramètre est utilisé pour interroger un ensemble de commandes entre une plage de dates particulière. Doit être envoyé avec le paramètre sinceDate. string - date UTC/GMT; format: yyyymmdd |
Réponse HTTPS
Format du message: JSON
EXEMPLE DE RÉPONSE RÉUSSIE
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
{
"totalCount": 6,
"orderCount": 5,
"testOrderCount": 1,
"orders": [
{
"testOrder": false,
"id": "999-99991",
"timestamp": "2015-01-01 00:33:14.0"
},
{
"testOrder": true,
"id": "999-99992",
"timestamp": "2015-01-01 05:12:46.0"
},
{
"testOrder": false,
"id": "999-99993",
"timestamp": "2015-01-01 14:50:54.0"
},
{
"testOrder": false,
"id": "999-99994",
"timestamp": "2015-01-02 20:14:01.0"
},
{
"testOrder": false,
"id": "999-99995",
"timestamp": "2015-01-02 20:57:47.0"
},
{
"testOrder": false,
"id": "999-99996",
"timestamp": "2015-01-02 22:11:40.0"
}
]
}
Exemple de réponse réussie avec le paramètre 'statuses'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
"totalCount": 2,
"orderCount": 1,
"testOrderCount": 1,
"orders": [
{
"testOrder": false,
"id": "999-99991",
"timestamp": "2015-01-01 00:33:14.0",
"merchantOrderId": null,
"orderStatus": "IGLOBAL_FRAUD_REVIEW",
"orderStatusDate": 1420097594000,
"orderStatusDateString": "2015-01-01 14:16:17.0"
},
{
"testOrder": true,
"id": "999-99992",
"timestamp": "2015-01-01 05:12:46.0",
"merchantOrderId": "abc123",
"orderStatus": "IGLOBAL_ORDER_IN_PROCESS",
"orderStatusDate": 1420097594000,
"orderStatusDateString": "2015-01-01 14:16:17.0"
}
]
}
Exemple de réponse d'erreur
1
2
3
{
"error": "Couldn't find order for sinceOrderId: 999999"
}
Réponses d'erreur HTTP
| Erreur | Signification |
|---|---|
| 406 - Non acceptable | Entité HTML. L'en-tête HTTP "Accept" est invalide. |
| 415 - Type de média non supporté | Entité HTML. L'en-tête HTTP "Content-Type" est invalide. |
| 200 | "erreur": "impossible d'analyser l'entrée" |
| 200 | "erreur": "orderId : 999-99999 n'est pas un orderId valide" |
| 200 | "erreur": "Le paramètre orderId ou referenceId est requis." |
| 200 | "erreur": "Impossible de spécifier à la fois les paramètres orderId et referenceId." |
| 200 | "erreur": "Impossible de traiter les détails de la commande." |
| 200 | "erreur": "Informations d'identification de sécurité invalides" |
Définitions JSON de la réponse
| champ | notes |
|---|---|
erreur | Ce paramètre ne sera présent dans la réponse que lorsqu'une erreur s'est produite et contiendra une description de la cause. chaîne de caractères |
orderCount | Le nombre total de commandes en direct récupérées. entier |
order.testOrderCount | Le nombre total de commandes de test récupérées. entier |
commandes | Une liste de cartes de commande. chaîne de caractères |
commandes[index].id | L'identifiant complet de la commande Zonos incluant l'identifiant du magasin et le tiret. chaîne de caractères |
commandes[index].merchantOrderId | MerchantOrderId associé à la commande via le point de terminaison du service API updateMerchantOrderId. chaîne de caractères |
commandes[index].orderStatus | Le statut actuel de la commande pour les valeurs possibles. chaîne de caractères |
commandes[index].orderStatusDate | L'époque représentant la dernière mise à jour du statut. entier |
commandes[index].orderStatusDateString | Le timestamp représentant la dernière mise à jour du statut en UTC/GMT. horodatage |
commandes[index].testOrder | Indique si la commande était une "commande de test" ou une "commande en direct". booléen |
commandes[index].timestamp | Le timestamp représentant quand la commande a été passée en UTC/GMT. horodatage |
totalCount | Le nombre total de commandes en direct et de test récupérées. entier |
Numéros de commande
Découvrez comment fonctionne l'endpoint des numéros de commande.
L'endpoint
orderNumbersest utilisé pour récupérer en toute sécurité une liste de numéros de commande complétés via le Zonos Checkout. Il est généralement utilisé pour la réconciliation des commandes afin de s'assurer que toutes les commandes ont été importées à une date ou un orderID donné, ainsi que les commandes entre une plage de dates.