Endepunkter
Be om fullførte ordredetaljer
POST | https://api.iglobalstores.com/2.0/order-completed - Opprett en ny forespørsel om informasjon relatert til en fullført ordre.
HTTPS-forespørsel
| Felt | Notater |
|---|---|
| HTTP-metode | POST |
| Endepunkt-URL | https://api.iglobalstores.com/2.0/order-completed |
| Protokoll | HTTPS |
| Meldingsformat | JSON |
| Accept HTTP-header | Accept: application/json |
| Sikkerhetstoken HTTP-header | serviceToken: your-test-token-valueLegg til en header til din HTTPS-forespørsel med navnet serviceToken med en verdi av din test sikkerhets-API-token. (Kontakt din kontoansvarlig for denne token.) |
| Content-Type HTTP-header | Content-Type: application/jsonFordi du vil poste JSON-data til tjenesten, legg til en header til din HTTPS-forespørsel med navnet Content-Type med en verdi av application/json |
JSON nøkkel/verdi-par i forespørselens kropp
Meldingsformat: JSON
Eksempel på forespørsel
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"
}
Forespørsel JSON-definisjoner
| Felt | Notater |
|---|---|
billingAddress PÅKREVD | Dette er fakturaadressen for bestillingen. Dette er et kart som inneholder følgende adressefelt: address1, address2, address3, city, state, stateCode, postalCode, og countryCode. Disse inneholdte feltene er enten påkrevde eller ikke påkrevde avhengig av landet. Lokaliseringseendepunktet returnerer hvilke spesifikke adressefelt som er påkrevde eller ikke for hvert land. Merk: stateCode er alltid ikke påkrevd og ikke erklært i lokaliseringseendepunktet. Du kan sende stateCode, hvis tilgjengelig. |
billingCompany VALGFRI | Dette er navnet på faktureringsfirmaet for bestillingen. |
billingEmail PÅKREVD | Dette er faktura-e-postadressen for bestillingen. |
billingName PÅKREVD | Dette er det komplette fakturanavnet for bestillingen. |
billingPhone PÅKREVD | Dette er fakturatelefonnummeret for bestillingen. |
items[index].orderGrandTotal PÅKREVD | Dette er den totale summen betalt av kunden for bestillingen i USD (amerikanske dollar). Vennligst oppgi uten komma, uten dollartegn “$”, og med to desimaler. Eksempelverdi: 2102.99 |
items[index].orderNumber PÅKREVD | Dette er ditt bestillingsnummer for den nylig fullførte bestillingen. Eksempelverdi: 854725421 |
paymentTypeCode PÅKREVD | Betalingsmetoden som ble brukt av kunden for å betale for bestillingen. Eksempelverdier: PayPal eller Visa eller MC eller AMEX eller DISC |
prepaidDutyTax PÅKREVD | Valgte kunden å prepay importavgiftene og skattene, eller ble de tvunget til å prepay dem? Hvis ja, sett til true; hvis ikke, sett til false. Eksempelverdier: true eller false |
shippingQuoteId PÅKREVD | Dette er ID-en til fraktprisen kunden valgte. Handlekurvdetaljene må være de samme som de var da fraktprisene ble hentet. Hvis handlekurvdetaljene har endret seg, må du ha bedt om nye fraktpriser før du fullførte kundens bestilling. |
shipToCompany VALGFRI | Dette er firmanavnet til personen som vil motta den sendte bestillingen. |
shipToEmail PÅKREVD | Dette er e-postadressen til personen som vil motta den sendte bestillingen. |
shipToName PÅKREVD | Dette er det komplette navnet til personen som vil motta den sendte bestillingen. |
shipToPhone PÅKREVD | Dette er telefonnummeret til personen som vil motta den sendte bestillingen. |
HTTPS-respons
Meldingsformat: JSON
Eksempelrespons for kun Canada og Australia
Merk: Faktiske svar vil inneholde alle støttede land.
Eksempelrespons
1
2
3
4
5
6
7
{
"igOrderId": "e55a4efc-e615-49af-b3a4-afcda87e9e5e",
"deniedParty": {
"flagged": true,
"source": "source reference for review"
}
}
Respons JSON-definisjoner
| Felt | Notater |
|---|---|
deniedParty | Dette er et kart over resultatene fra screening av nektede parter. Hvis det er satt til null, ble screening av nektede parter ikke utført. Kontakt din Zonos representant hvis du støter på dette. |
deniedParty.flagged | Om denne bestillingen har matchet en post i de konsoliderte listene over nektede parter fra Zonos. Hvis sant, gjennomgå denne bestillingen før behandling. Når du er i tvil, ikke behandle en bestilling som er flagget som sann. Eksempelverdier: sant eller usant |
deniedParty.source | Hvis det flaggede feltet ble satt til sant, vil dette feltet inneholde kildehenvisninger som er nyttige for å gjennomgå hvorfor bestillingen ble flagget som en match med en nektet part. |
igOrderId | Zonos identifikator for den nylig fullførte bestillingen. Eksempelverdi: e55a4efc-e615-49af-b3a4-afcda87e9e5e |
Order Completed API Legacy
Lær hvordan Legacy Order Complete API fungerer.Order Completed-endepunktet aksepterer de endelige detaljene om shopperens ordre, screener ordredetaljene for nektede parter, og returnerer resultatene sammen med en Zonos-spesifikk ordre-ID.