Découvrez le fonctionnement du point de terminaison Order numbers.
Le point de terminaison orderNumbers est utilisé pour récupérer en toute sécurité une liste de numéros de commande terminés via le Zonos Checkout. Il est généralement utilisé pour le rapprochement des commandes afin de s'assurer que toutes les commandes ont été importées à partir d'une date ou d'un orderID, ainsi que les commandes dans une plage de dates.
POST | https://api.iglobalstores.com/v1/orderNumbers
Requête HTTPS
Field↕
Notes↕
HTTP method
POST
Endpoint
https://api.iglobalstores.com/v1/orderNumbers
Protocol
HTTPS
Message format
JSON
Accept HTTP header
Accept: application/json
Content-Type HTTP header
Content-Type: application/json
Paires clé/valeur JSON dans le corps de la requête
Message format: JSON
1{
2"store":"999",
3"secret":"f5bde245-f55e-414d-b722-80b25161c12c",
4"sinceOrderId":"999-99999"
5}
Définitions JSON de la requête
field↕
notes↕
missingMerchantOrderId OPTIONAL, if passing another parameter option
Ce paramètre est utilisé pour interroger un ensemble de commandes des deux dernières semaines auxquelles il manque le 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 REQUIRED
GUID secret API fourni par Zonos. string
sinceDate OPTIONAL, if passing sinceOrderId parameter.
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 tous les deux. string - date UTC/GMT ; format : yyyymmdd
sinceOrderId OPTIONAL, if passing sinceDate / throughDate parameter
L'identifiant de commande Zonos peut être transmis avec ou sans l'identifiant de votre magasin et le tiret (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 tous les deux. integer / string
statuses OPTIONAL
Ce paramètre est utilisé pour inclure le statut de commande actuel et le merchantOrderId dans la réponse. S'il est présent dans la requête, quelle que soit la valeur, il inclura les statuts. boolean: true
store REQUIRED
Identifiant de magasin fourni par Zonos. integer
throughDate OPTIONAL
Ce paramètre est utilisé pour interroger un ensemble de commandes dans une plage de dates particulière. Doit être transmis avec le paramètre sinceDate. string - date UTC/GMT ; format : yyyymmdd
Réponse HTTPS
Message format: JSON
1{
2"totalCount":6,
3"orderCount":5,
4"testOrderCount":1,
5"orders":[
6{
7"testOrder":false,
8"id":"999-99991",
9"timestamp":"2015-01-01 00:33:14.0"
10},
11{
12"testOrder":true,
13"id":"999-99992",
14"timestamp":"2015-01-01 05:12:46.0"
15},
16{
17"testOrder":false,
18"id":"999-99993",
19"timestamp":"2015-01-01 14:50:54.0"
20},
21{
22"testOrder":false,
23"id":"999-99994",
24"timestamp":"2015-01-02 20:14:01.0"
25},
26{
27"testOrder":false,
28"id":"999-99995",
29"timestamp":"2015-01-02 20:57:47.0"
30},
31{
32"testOrder":false,
33"id":"999-99996",
34"timestamp":"2015-01-02 22:11:40.0"
35}
36]
37}
Réponses HTTP d'erreur
Error↕
Meaning↕
406 - Not Acceptable
Entité HTML. L'en-tête HTTP « Accept » est invalide.
415 - Unsupported media type
Entité HTML. L'en-tête HTTP « Content-Type » est invalide.
200
« error »:« could not parse input »
200
« error »:« orderId: 999-99999 is not a valid orderId »
200
« error »:« Parameter orderId or referenceId is required. »
200
« error »:« Cannot specify both Parameters orderId and referenceId. »
200
« error »:« Could not process order details. »
200
« error »:« Invalid security credentials »
Définitions JSON de la réponse
field↕
notes↕
error
Ce paramètre ne sera présent dans la réponse qu'en cas d'erreur et contiendra une description de la cause. string
orderCount
Le nombre total de commandes réelles récupérées. integer
order.testOrderCount
Le nombre total de commandes de test récupérées. integer
orders
Une liste de maps de commandes. string
orders[index].id
L'identifiant de commande Zonos complet incluant l'identifiant de magasin et le tiret. string
orders[index].merchantOrderId
MerchantOrderId associé à la commande via le point de terminaison API updateMerchantOrderId. string
orders[index].orderStatus
Le statut de commande actuel pour les valeurs possibles. string
orders[index].orderStatusDate
L'époque représentant la dernière mise à jour du statut. integer
orders[index].orderStatusDateString
L'horodatage représentant la dernière mise à jour du statut en UTC/GMT. timestamp
orders[index].testOrder
Indique si la commande était une « test order » ou une « live order ». boolean
orders[index].timestamp
L'horodatage représentant le moment où la commande a été passée en UTC/GMT. timestamp
totalCount
Le nombre total de commandes réelles et de test récupérées. integer
Numéros de commande
Numéros de commande
Découvrez le fonctionnement du point de terminaison Order numbers.
Le point de terminaison
orderNumbersest utilisé pour récupérer en toute sécurité une liste de numéros de commande terminés via le Zonos Checkout. Il est généralement utilisé pour le rapprochement des commandes afin de s'assurer que toutes les commandes ont été importées à partir d'une date ou d'un orderID, ainsi que les commandes dans une plage de dates.Point de terminaison
POST |
https://api.iglobalstores.com/v1/orderNumbersRequête HTTPS
https://api.iglobalstores.com/v1/orderNumbersPaires clé/valeur JSON dans le corps de la requête
Message format: JSON
{"store": "999","secret": "f5bde245-f55e-414d-b722-80b25161c12c","sinceOrderId": "999-99999"}Définitions JSON de la requête
missingMerchantOrderIdOPTIONAL, if passing another parameter optionmerchantOrderId. Lorsque lemerchantOrderIdest soumis via le point de terminaison APIupdateMerchantOrderID, les commandes n'apparaîtront plus dans cette requête.boolean: true/falsesecretREQUIREDstringsinceDateOPTIONAL, if passingsinceOrderIdparameter.sinceDateetsinceOrderIdne peuvent pas être envoyés tous les deux.string- date UTC/GMT ; format :yyyymmddsinceOrderIdOPTIONAL, if passingsinceDate/throughDateparametersinceDateetsinceOrderIdne peuvent pas être envoyés tous les deux.integer / stringstatusesOPTIONALmerchantOrderIddans la réponse. S'il est présent dans la requête, quelle que soit la valeur, il inclura les statuts.boolean: truestoreREQUIREDintegerthroughDateOPTIONALsinceDate.string- date UTC/GMT ; format :yyyymmddRéponse HTTPS
Message format: JSON
{"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"}]}Réponses HTTP d'erreur
Définitions JSON de la réponse
errorstringorderCountintegerorder.testOrderCountintegerordersstringorders[index].idstringorders[index].merchantOrderIdMerchantOrderIdassocié à la commande via le point de terminaison APIupdateMerchantOrderId.stringorders[index].orderStatusstringorders[index].orderStatusDateintegerorders[index].orderStatusDateStringtimestamporders[index].testOrderbooleanorders[index].timestamptimestamptotalCountintegerCette page vous a-t-elle été utile?