HjemAPI reference Order Completed API Legacy

Order Completed API Legacy

Lær hvordan Legacy Order Complete API'en fungerer.

Order Completed-endepunktet accepterer de endelige detaljer om shopperens ordre, screener ordredetaljerne for nægtede parter og returnerer resultaterne sammen med en Zonos-specifik ordre-ID.

Endepunkter

Anmod om ordreafslutningsdetaljer

POST | https://api.iglobalstores.com/2.0/order-completed - Opret en ny anmodning om oplysninger relateret til en afsluttet ordre.

HTTPS-anmodning

Felt	Bemærkninger
HTTP-metode	POST
Endepunkt-URL	`https://api.iglobalstores.com/2.0/order-completed`
Protokol	HTTPS
Meddelelsesformat	JSON
Accept HTTP-header	Accept: application/json
Sikkerhedstoken HTTP-header	serviceToken: your-test-token-valueTilføj en header til din HTTPS-anmodning med navnet serviceToken med en værdi af din test sikkerheds-API-token. (Kontakt din Account Manager for denne token.)
Content-Type HTTP-header	Content-Type: application/jsonFordi du vil sende JSON-data til tjenesten, skal du tilføje en header til din HTTPS-anmodning med navnet Content-Type med en værdi af application/json

JSON nøgle/værdi-par i anmodningskroppen

Meddelelsesformat: JSON

Eksempelanmodning

{
  "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"
}

Anmodning JSON definitioner

Felt	Bemærkninger
`billingAddress` PÅKRÆVET	Dette er faktureringsadressen for ordren. Dette er et kort, der indeholder følgende adressefelter: `address1`, `address2`, `address3`, `city`, `state`, `stateCode`, `postalCode` og `countryCode`. Disse indeholdte felter er enten påkrævet eller ikke påkrævet afhængigt af landet. Lokaliseringse endpointet returnerer, hvilke specifikke adressefelter der er påkrævet eller ikke for hvert land. Bemærk: `stateCode` er altid ikke påkrævet og ikke erklæret i lokaliseringse endpointet. Du kan angive `stateCode`, hvis det er tilgængeligt.
`billingCompany` VALGFRIT	Dette er navnet på faktureringsfirmaet for ordren.
`billingEmail` PÅKRÆVET	Dette er fakturerings-e-mailadressen for ordren.
`billingName` PÅKRÆVET	Dette er det fulde faktureringsnavn for ordren.
`billingPhone` PÅKRÆVET	Dette er faktureringstelefonnummeret for ordren.
`items[index].orderGrandTotal` PÅKRÆVET	Dette er det samlede beløb, der er betalt af køberen for deres ordre i USD (amerikanske dollars). Angiv venligst uden kommaer, uden dollartegn “$” og med to decimaler. Eksempelværdi: 2102.99
`items[index].orderNumber` PÅKRÆVET	Dette er dit ordrenummer for den nyfærdiggjorte ordre. Eksempelværdi: 854725421
`paymentTypeCode` PÅKRÆVET	Den betalingsmetode, der blev brugt af køberen til at betale for deres ordre. Eksempelværdier: `PayPal` eller `Visa` eller `MC` eller `AMEX` eller `DISC`
`prepaidDutyTax` PÅKRÆVET	Valgte køberen at prepay deres importafgifter og skatter, eller blev de tvunget til at prepay dem? Hvis ja, sæt til true; hvis ikke, sæt til false. Eksempelværdier: true eller false
`shippingQuoteId` PÅKRÆVET	Dette er ID'et for det forsendelsestilbud, som køberen valgte. Indkøbskurvens detaljer skal være de samme som de var, da forsendelsestilbuddene blev hentet. Hvis indkøbskurvens detaljer er ændret, skal du have anmodet om nye forsendelsestilbud, før du afslutter køberens ordre.
`shipToCompany` VALGFRIT	Dette er firmanavnet på den person, der vil modtage den sendte ordre.
`shipToEmail` PÅKRÆVET	Dette er e-mailadressen på den person, der vil modtage den sendte ordre.
`shipToName` PÅKRÆVET	Dette er det fulde navn på den person, der vil modtage den sendte ordre.
`shipToPhone` PÅKRÆVET	Dette er telefonnummeret på den person, der vil modtage den sendte ordre.

HTTPS svar

Beskedformat: JSON

Eksempel på svar for kun Canada & Australien

Bemærk: Faktiske svar vil indeholde alle understøttede lande.

Eksempel på svar

{
  "igOrderId": "e55a4efc-e615-49af-b3a4-afcda87e9e5e",
  "deniedParty": {
    "flagged": true,
    "source": "source reference for review"
  }
}

Response JSON definitioner

Felt	Noter
`deniedParty`	Dette er et kort over resultaterne fra screening af nægtede parter. Hvis det er sat til null, så blev screening af nægtede parter ikke udført. Kontakt din Zonos repræsentant, hvis du støder på dette.
`deniedParty.flagged`	Om denne ordre har matchet en post i de Zonos konsoliderede lister over nægtede parter. Hvis sandt, skal du gennemgå denne ordre, før du behandler den. Når du er i tvivl, skal du ikke behandle en ordre, der er markeret som sand. Eksempelværdier: true eller false
`deniedParty.source`	Hvis det markerede felt blev sat til sandt, vil dette felt indeholde kildehenvisninger, der er nyttige til at gennemgå, hvorfor ordren blev markeret som matchende en nægtet part.
`igOrderId`	Zonos identifikator for den nyfærdiggjorte ordre. Eksempelværdi: `e55a4efc-e615-49af-b3a4-afcda87e9e5e`

Var denne side nyttig?

Spørgsmål?

Kontakt os.

Se Zonos

politikker og aftaler