Endpoints
Vraag bestelgegevens aan
POST | https://api.iglobalstores.com/2.0/order-completed - Maak een nieuwe aanvraag voor informatie met betrekking tot een voltooide bestelling.
HTTPS-aanroep
| Veld | Opmerkingen |
|---|---|
| HTTP-methode | POST |
| Endpoint-URL | https://api.iglobalstores.com/2.0/order-completed |
| Protocol | HTTPS |
| Berichtformaat | JSON |
| Accept HTTP-header | Accept: application/json |
| Beveiligingstoken HTTP-header | serviceToken: your-test-token-valueVoeg een header toe aan uw HTTPS-aanroep met de naam serviceToken met een waarde van uw testbeveiligings-API-token. (Neem contact op met uw Accountmanager voor dit token.) |
| Content-Type HTTP-header | Content-Type: application/jsonOmdat u JSON-gegevens naar de service zult posten, voegt u een header toe aan uw HTTPS-aanroep met de naam Content-Type met een waarde van application/json |
JSON sleutel/waarde paren in de aanvraagbody
Berichtformaat: JSON
Voorbeeld aanvraag
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
{
"billingAddress": {
"address1": "123 S West Elm St",
"address2": null,
"address3": null,
"city": "Calgary",
"countryCode": "CA",
"postalCode": "T2P 5G8",
"state": "Alberta",
"stateCode": null
},
"billingCompany": null,
"billingEmail": "jdoe@jdoe.com",
"billingName": "John E. Doe",
"billingPhone": "+1 555-555-5555",
"orderGrandTotal": 1225.89,
"orderNumber": "854725421",
"paymentTypeCode": "PAYPAL",
"prepaidDutyTax": true,
"shippingQuoteId": "bcdbdbcd-0145-4d3b-a54e-0de3cdce5a0a",
"shipToCompany": null,
"shipToEmail": "jdoe@jdoe.com",
"shipToName": "John Doe",
"shipToPhone": "+1 555-555-5555"
}
Verzoek JSON-definities
| Veld | Opmerkingen |
|---|---|
billingAddress VERPLICHT | Dit is het factuuradres van de bestelling. Dit is een kaart die de volgende adresvelden bevat: address1, address2, address3, city, state, stateCode, postalCode, en countryCode. Deze velden zijn afhankelijk van het land verplicht of niet verplicht. Het lokalisatie-eindpunt geeft aan welke specifieke adresvelden verplicht of niet verplicht zijn voor elk land. Opmerking: stateCode is altijd niet verplicht en niet verklaard in het lokalisatie-eindpunt. U kunt stateCode doorgeven, indien beschikbaar. |
billingCompany OPTIONEEL | Dit is de naam van het factureringsbedrijf van de bestelling. |
billingEmail VERPLICHT | Dit is het factuur-e-mailadres van de bestelling. |
billingName VERPLICHT | Dit is de volledige factureringsnaam van de bestelling. |
billingPhone VERPLICHT | Dit is het factuurtelefoonnummer van de bestelling. |
items[index].orderGrandTotal VERPLICHT | Dit is het totaalbedrag dat door de koper voor hun bestelling is betaald in USD (Amerikaanse dollars). Gelieve dit zonder komma's, zonder een dollarteken “$”, en met twee decimalen te verstrekken. Voorbeeldwaarde: 2102.99 |
items[index].orderNumber VERPLICHT | Dit is uw bestelnummer voor de nieuw voltooide bestelling. Voorbeeldwaarde: 854725421 |
paymentTypeCode VERPLICHT | De betaalmethode die door de koper is gebruikt om voor hun bestelling te betalen. Voorbeeldwaarden: PayPal of Visa of MC of AMEX of DISC |
prepaidDutyTax VERPLICHT | Heeft de koper ervoor gekozen om prepay hun invoerrechten en belastingen vooraf te betalen of werden ze gedwongen om prepay deze te betalen? Als dat zo is, stel dan in op true; zo niet, stel dan in op false. Voorbeeldwaarden: true of false |
shippingQuoteId VERPLICHT | Dit is de ID van de verzendofferte die de koper heeft gekozen. De winkelwagentijdetails moeten hetzelfde zijn als toen de verzendoffertes werden opgehaald. Als de winkelwagentijdetails zijn gewijzigd, moet u nieuwe verzendoffertes hebben aangevraagd voordat u de bestelling van de koper voltooit. |
shipToCompany OPTIONEEL | Dit is de bedrijfsnaam van de persoon die de verzonden bestelling zal ontvangen. |
shipToEmail VERPLICHT | Dit is het e-mailadres van de persoon die de verzonden bestelling zal ontvangen. |
shipToName VERPLICHT | Dit is de volledige naam van de persoon die de verzonden bestelling zal ontvangen. |
shipToPhone VERPLICHT | Dit is het telefoonnummer van de persoon die de verzonden bestelling zal ontvangen. |
HTTPS-respons
Berichtformaat: JSON
Voorbeeldrespons voor alleen Canada en Australië
Opmerking: Werkelijke reacties bevatten alle ondersteunde landen.
Voorbeeldrespons
1
2
3
4
5
6
7
{
"igOrderId": "e55a4efc-e615-49af-b3a4-afcda87e9e5e",
"deniedParty": {
"flagged": true,
"source": "source reference for review"
}
}
Response JSON-definities
| Veld | Opmerkingen |
|---|---|
deniedParty | Dit is een kaart van de resultaten van de screening van geweigerde partijen. Als dit op null is ingesteld, is de screening van geweigerde partijen niet uitgevoerd. Neem contact op met uw Zonos vertegenwoordiger als u dit tegenkomt. |
deniedParty.flagged | Of deze bestelling al dan niet overeenkomt met een record in de Zonos geconsolideerde lijsten van geweigerde partijen. Als dit waar is, controleer deze bestelling voordat u deze verwerkt. Bij twijfel, verwerk geen bestelling die als waar is gemarkeerd. Voorbeeldwaarden: waar of onwaar |
deniedParty.source | Als het gemarkeerde veld op waar is ingesteld, bevat dit veld bronverwijzingen die nuttig zijn bij het beoordelen waarom de bestelling als overeenkomend met een geweigerde partij is gemarkeerd. |
igOrderId | Zonos identificatie voor de nieuw voltooide bestelling. Voorbeeldwaarde: e55a4efc-e615-49af-b3a4-afcda87e9e5e |
Order Completed API Legacy
Leer hoe de legacy Order Complete API werkt.De Order Completed endpoint accepteert de laatste details van de bestelling van de koper, controleert de bestelgegevens op geweigerde partijen en retourneert de resultaten samen met een Zonos-specifieke bestel-ID.