Endpoints
Begär beställningsdetaljer som är slutförda
POST | https://api.iglobalstores.com/2.0/order-completed - Skapa en ny begäran om information relaterad till en slutförd beställning.
HTTPS-begäran
| Fält | Anteckningar |
|---|---|
| HTTP-metod | POST |
| Endpoint-URL | https://api.iglobalstores.com/2.0/order-completed |
| Protokoll | HTTPS |
| Meddelandeformat | JSON |
| Accept HTTP-header | Accept: application/json |
| Säkerhetstoken HTTP-header | serviceToken: your-test-token-valueLägg till en header till din HTTPS-begäran med namnet serviceToken med ett värde av din test säkerhets-API-token. (Kontakta din kontoansvarig för denna token.) |
| Content-Type HTTP-header | Content-Type: application/jsonEftersom du kommer att posta JSON-data till tjänsten, lägg till en header till din HTTPS-begäran med namnet Content-Type med ett värde av application/json |
JSON nyckel/värde-par i begärningskroppen
Meddelandeformat: JSON
Exempel på begäran
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"
}
Begäran JSON-definitioner
| Fält | Anteckningar |
|---|---|
billingAddress KRÄVD | Detta är faktureringsadressen för beställningen. Detta är en karta som innehåller följande adressfält: address1, address2, address3, city, state, stateCode, postalCode och countryCode. Dessa innehållna fält är antingen obligatoriska eller inte obligatoriska beroende på landet. Lokaliseringens slutpunkt returnerar vilka specifika adressfält som är obligatoriska eller inte för varje land. Observera: stateCode är alltid inte obligatoriskt och inte deklarerat i lokaliseringens slutpunkt. Du kan skicka stateCode, om det är tillgängligt. |
billingCompany VALFRI | Detta är namnet på faktureringsföretaget för beställningen. |
billingEmail KRÄVD | Detta är fakturerings-e-postadressen för beställningen. |
billingName KRÄVD | Detta är det fullständiga faktureringsnamnet för beställningen. |
billingPhone KRÄVD | Detta är faktureringstelefonnumret för beställningen. |
items[index].orderGrandTotal KRÄVD | Detta är det totala beloppet som betalats av köparen för deras beställning i USD (amerikanska dollar). Vänligen ange utan kommatecken, utan dollartecken “$”, och med två decimaler. Exempelvärde: 2102.99 |
items[index].orderNumber KRÄVD | Detta är ditt beställningsnummer för den nyligen slutförda beställningen. Exempelvärde: 854725421 |
paymentTypeCode KRÄVD | Betalningsmetoden som köparen använde för att betala för sin beställning. Exempelvärden: PayPal eller Visa eller MC eller AMEX eller DISC |
prepaidDutyTax KRÄVD | Valde köparen att prepay sina importavgifter och skatter eller tvingades de att prepay dem? Om så är fallet, sätt till true; om inte, sätt till false. Exempelvärden: true eller false |
shippingQuoteId KRÄVD | Detta är ID:t för fraktofferten som köparen valde. Varukorgens detaljer måste vara desamma som de var när fraktoffertarna hämtades. Om varukorgens detaljer har ändrats, bör du ha begärt nya fraktoffertar innan du slutförde köparens beställning. |
shipToCompany VALFRI | Detta är företagsnamnet på den person som kommer att ta emot den skickade beställningen. |
shipToEmail KRÄVD | Detta är e-postadressen till den person som kommer att ta emot den skickade beställningen. |
shipToName KRÄVD | Detta är det fullständiga namnet på den person som kommer att ta emot den skickade beställningen. |
shipToPhone KRÄVD | Detta är telefonnumret till den person som kommer att ta emot den skickade beställningen. |
HTTPS-svar
Meddelandets format: JSON
Exempel på svar för endast Kanada och Australien
Observera: Faktiska svar kommer att innehålla alla stödda länder.
Exempel på svar
1
2
3
4
5
6
7
{
"igOrderId": "e55a4efc-e615-49af-b3a4-afcda87e9e5e",
"deniedParty": {
"flagged": true,
"source": "source reference for review"
}
}
Svar JSON-definitioner
| Fält | Anteckningar |
|---|---|
deniedParty | Detta är en karta över resultaten från screening av nekade parter. Om det är inställt på null, har screening av nekade parter inte utförts. Kontakta din Zonos representant om du stöter på detta. |
deniedParty.flagged | Om denna beställning har matchat en post i Zonoss konsoliderade listor över nekade parter. Om sant, granska denna beställning innan du behandlar den. Vid osäkerhet, behandla inte en beställning som är markerad som sann. Exempelvärden: sant eller falskt |
deniedParty.source | Om det markerade fältet var inställt på sant, kommer detta fält att innehålla källreferenser som är användbara för att granska varför beställningen markerades som matchande en nekad part. |
igOrderId | Zonos identifierare för den nyligen slutförda beställningen. Exempelvärde: e55a4efc-e615-49af-b3a4-afcda87e9e5e |
Order Completed API Legacy
Lär dig hur den legacy Order Complete API fungerar.Order Completed-endpointen accepterar de slutliga detaljerna av shopperns beställning, granskar beställningsdetaljerna för nekade parter och returnerar resultaten tillsammans med ett Zonos-specifikt beställnings-ID.