Open Ship API

Inleiding

Met deze API kunt u een Open Zending aanmaken. Zo kunt u pakketten gedurende een bepaalde periode aan de zending toevoegen in plaats van alle zendings- en pakketinformatie in één keer in te voeren. De zending blijft openstaan gedurende een periode van vijf dagen waarin u pakketten kunt toevoegen en aanpassen. Zodra de zending is bevestigd, kunnen de verzendpapieren zoals etiketten, luchtvrachtbrief of rapporten worden gegenereerd. Aan het eind van de vijfde dag moet u de zending bevestigen, anders wordt deze verwijderd.

Opmerking: De Open Zendingen worden verwijderd als ze niet binnen het einde van de vijfde dag na het aanmaken van de zending worden bevestigd.

Details over de Open Ship-API

De Open Ship-API wordt gebruikt wanneer u gedurende een bepaalde periode meerdere pakketten aan een zending wilt toevoegen en u niet zeker weet hoeveel pakketten u wilt toevoegen of wanneer de zending zal worden voltooid. Dit biedt u een flexibele manier om uw zending gedurende de dag voor te bereiden totdat u klaar bent om te verzenden.

Zendingen van het type Open Zending zijn vaak zendingen uit meerdere stukken, maar het kunnen ook zendingen met één pakket zijn, ook wel zendingen uit één stuk genoemd.

Voor het verzenden van een zending uit meerdere stukken (MPS) naar een enkele geadresseerde gebruikt u de Open Ship-API en voegt u individuele pakketten toe aan de zending of voegt u meerdere pakketten toe als ze naar dezelfde ontvanger gaan.

De volgende diensten zijn gekoppeld aan Open Zending:

FedEx Express^® intra-U.S. en intra-Canada
FedEx Ground^® intra-U.S. en intra-Canada
FedEx Home Delivery^®
FedEx International Priority^®
FedEx International Priority^® Express (IPE)
FedEx International Economy^®
FedEx Priority Overnight^TM
FedEx® Regional Economy
FedEx® Regional Economy Freight
FedEx International Connect Plus®
FedEx® First
FedEx Priority Express
FedEx Priority
FedEx Priority Express Freight
FedEx Priority Freight
FedEx Economy (Alleen VK)

De Open Ship-API biedt de volgende mogelijkheden:

Open Zendingen beheren

Met deze functie kunnen verzenders Open Zendingen aanmaken, wijzigen, verwijderen en de reeds aangemaakte Open Zending ophalen voor controle- of verificatiedoeleinden. Hiermee kan de voltooide verzending worden bevestigd om de verzendgegevens naar FedEx over te dragen en om de juiste verzendingspapieren te genereren. De API identificeert en rapporteert eveneens eventuele fouten in de transactie en geeft de juiste status weer.

De belangrijkste informatie in deze functie zijn accountNumber, Verzendgegevens, groupPackageCount, index om het hoofdpakket in de zending aan te duiden. Met deze functie worden de juiste gegevens van de zending naar de FedEx-systemen geüpload en worden de juiste trackingnummers, etiketten en verzendrapporten gegenereerd.

Pakketten in Open Zendingen beheren

Met deze functie kunt u pakketten toevoegen, wijzigen en verwijderen in de reeds aangemaakte Open Zending. Men kan ook het bestaande pakket ophalen voor een bestaande Open Zending.

Resultaten Open Zending verkrijgen (asynchroon)

Met deze functie kunnen bevestigde verzendresultaten asynchroon worden opgehaald. Wanneer een Open Zending met 40 of meer pakketten wordt bevestigd, verwerkt de API de zending asynchroon.

Als de verzending asynchroon wordt verwerkt, bevestigt het antwoord op deze aanvraag alleen dat de aanvraag met succes in de wachtrij is geplaatst maar de verzending zelf mogelijk nog niet is verwerkt. Als antwoord wordt het jobId weergegeven om het resultaat later op te halen. De functie maakt gebruik van jobId om de resultaten van de Open verzending (CREATE, MODIFY & CONFIRM) op te halen, zoals etiketten en verzendrapporten. De API identificeert en rapporteert eveneens eventuele fouten in de verzending en geeft de juiste status weer.

Opmerking: als er fouten zijn in de asynchrone respons voor de zending, corrigeer dan de fouten en dien een nieuw verzendverzoek in.

Workflow van de Open Ship-API

Deze paragraaf biedt een uitgebreide beschrijving van de workflow van de Open Ship-API: De workflow van de Open Ship-API wordt op twee manieren beheerd of met twee verwerkingsopties:

Workflow voor 40 pakketten of minder

Gebruik het eindpunt Open Zending aanmaken om een Open Zending aan te maken met alle vereiste verzend- en pakketinformatie, accountNumber en index.
Gebruik het eindpunt Pakketten toevoegen aan Open Zending om één of meer (niet meer dan 40) pakketten toe te voegen aan de reeds aangemaakte Open Zending. De belangrijkste gegevens zijn index en accountNumber van de Open Zending waaraan de pakketten worden toegevoegd.
Gebruik het eindpunt Open Zending bevestigen om de uiteindelijke bevestiging te geven dat alle pakketten zijn toegevoegd en dat de verzending is voltooid. De belangrijkste gegevens zijn index en accountNumber van de zending die bevestigd moet worden.

Het eindpunt Open Zending bevestigen is het laatste eindpunt in deze workflow die de zending en pakketinformatie valideert en met succes etiketten en alle andere rapporten voor de zending genereert. Het laat ook de foutdetails zien die tijdens de validatie worden weergegeven. Deze fouten kunnen worden opgelost met behulp van de eindpunten Open Zending aanpassen of Pakketten Open Zending aanpassen en de zending opnieuw te bevestigen voor een succesvol verzoek.

Workflow voor meer dan 40 pakketten

Gebruik het eindpunt Open Zending aanmaken om een Open Zending aan te maken met alle vereiste verzend- en pakketinformatie, accountNumber en index.
Gebruik het eindpunt Pakketten toevoegen aan Open Zending om één of meer (niet meer dan 40) pakketten toe te voegen aan de reeds aangemaakte Open Zending. De belangrijkste gegevens zijn index en accountNumber van de Open Zending waaraan de pakketten moeten worden toegevoegd.
Gebruik het eindpunt Open Zending bevestigen om te bevestigen dat alle pakketten zijn toegevoegd en dat de verzending is voltooid. De belangrijkste gegevens zijn index en accountNumber van de zending die bevestigd moet worden. In dit geval, aangezien er meer dan 40 pakketten zijn, verwerkt de API de zending asynchroon en geeft deze de jobId weer die later wordt gebruikt om de verzendresultaten op te halen. Indien de respons fouten bevat, moeten deze fouten worden opgelost met behulp van de eindpunten Open Zending aanpassen of Pakketten Open Zending aanpassen en dient de zending bevestigd te worden met gebruik van het eindpunt Open Zending bevestigen.
Gebruik het eindpunt Resultaten Open verzending verkrijgen
om de resultaten van Create, Modify and Confirm Open verzending, zoals etiketten en verzenddocumenten op te halen. De belangrijkste gegevens zijn jobId en accountNumber voor de bevestigde zending.

Het eindpunt Resultaten Open Zending verkrijgen is het laatste eindpunt in deze workflow die de bevestigde Open Zending-resultaten ophaalt, zoals etiketten en alle andere rapporten voor de bevestigde Open Zending. Indien de respons fouten bevat, moeten deze fouten worden opgelost met behulp van de eindpunten Open Zending aanpassen of Pakketten Open Zending aanpassen. Vervolgens dient de zending bevestigd te worden met gebruik van het eindpunt Open Zending bevestigen en als laatste dient eindpunt Resultaten Open Zending opvragen om de bevestigde resultaten van de Open Zending voor de succesvolle aanvraag op te halen.

Zo werkt de Open Ship-API

De Open Ship-API biedt de volgende functies:

Open Zending aanmaken

Gebruik dit eindpunt om een Open Zending met de vereiste verzendinformatie aan te maken en ten minste één pakket in de zending te definiëren.

Hieronder volgen de vereiste invoergegevens voor het aanmaken van de Open Zending:

openShipmentAction – Dit is de handeling Open Zending. Gebruik in dit geval waarde als PAKKET_AANMAKEN.
accountNumber – Dit is het FedEx-klantnummer.
requestedShipment – De verzendgegevens van den Open Zending.
index –unieke waarde voor de Open Zending, deze waarde is handig bij het wijzigen van de zending of het pakket. Dit is optioneel. Indien niet verstrekt, kan het hoofdtrackingnummer worden gebruikt om de unieke zending te identificeren.

De succesvolle respons op dit verzoek zal de zending verwerken en een trackingnummer genereren dat een hoofdtrackingnummer is voor het eerste pakket. Houd er rekening mee dat er geen etiketten worden gegenereerd in de respons.

Pakketten aan Open Zending toevoegen

Gebruik dit eindpunt om een of meer pakketten toe te voegen aan het bestaande Open Shipment-verzoek voordat de verzending wordt bevestigd. U kunt voor elk van uw pakketten een afzonderlijk verzoek Pakket toevoegen verzenden terwijl u uw zending gedurende de dag voorbereidt. U kunt ook binnen het verzoek Pakket toevoegen meerdere stukken insturen.

Opmerking: Het totale aantal pakketten voor de zending mag de limiet voor pakketten van de Open Zending niet overschrijden.

Hieronder volgen de vereiste invoergegevens voor het toevoegen van pakketten aan de Open Zending:

index – Dit is een unieke waarde die wordt toegekend aan de reeds aangemaakte Open Zending. Indien deze niet beschikbaar is, geeft u het hoofdtrackingnummer op.
requestedPackageLineItem – Gedetailleerde pakket(ten) informatie die nog toegevoegd moet worden.
accountNumber – Dit is het FedEx-klantnummer.

De succesvolle respons op dit verzoek genereert een trackingnummer voor het nieuw toegevoegde pakket.

Pakketten in Open Zending aanpassen

Gebruik dit eindpunt om een of meer pakketten aan te passen in de bestaande Open Zending-verzending voordat de verzending wordt bevestigd. Dit omvat ook het hoofdpakket, het eerste pakket dat aan de Open Zending wordt toegevoegd.

Hieronder volgen de vereiste invoergegevens die bij dit verzoek horen:

index – Dit is een unieke waarde die wordt toegekend aan de reeds aangemaakte Open Zending. Indien deze niet beschikbaar is, geeft u het hoofdtrackingnummer op.
accountNumber – Dit is het FedEx-klantnummer.
trackingId – Een of meer van de Tracking Ids van (een) Open Zending-pakket(ten) van de te wijzigen pakketten.
requestedPackageLineItem – Gedetailleerde pakket(ten) informatie die nog aangepast moet worden.

Het succesvolle verzoek zal de beoogde pakketten bijwerken en de bijgewerkte verzendgegevens weergeven.

Pakketten in Open Zendingen verwijderen

Gebruik dit eindpunt om een of meer pakketten van de bestaande Open Zending te verwijderen voordat de verzending wordt bevestigd.

Hieronder volgen de vereiste invoergegevens die bij dit verzoek horen:

index – Dit is een unieke waarde die wordt toegekend aan de reeds aangemaakte Open Zending. Indien deze niet beschikbaar is, geeft u het hoofdtrackingnummer op.
accountNumber – Dit is het FedEx-klantnummer.
trackingId – Een of meer van de Tracking Ids van (een) Open Zending-pakket(ten) waarvoor een verwijderingsverzoek is ontvangen.

Het succesvolle verzoek zal de beoogde pakketten verwijderen en de status voor het element deletedPackagesFromOpenshipment als waar weergeven.

Opmerking: als het hoofdpakket in de zending wordt verwijderd, wordt het volgende pakket in volgorde het hoofdpakket, wordt het hoofdtrackingnummer eraan toegewezen en wordt de reeks nummers verminderd met het aantal verwijderde pakketten.

Pakketten in Open Zendingen ophalen

Gebruik dit eindpunt om een of meer pakketten van de bestaande Open Zending ter controle of verificatie op te halen.

Hieronder volgen de vereiste invoergegevens die bij dit verzoek horen:

index – Dit is een unieke waarde die wordt toegekend aan de reeds aangemaakte Open Zending. Indien deze niet beschikbaar is, geeft u het hoofdtrackingnummer op.
accountNumber – Dit is het FedEx-klantnummer.
trackingId – Een of meer van de Tracking Ids van (een) Open Zending-pakket(ten) waarvoor de gegevens moeten worden opgehaald.

Het succesvolle verzoek zal de beoogde pakketten ophalen.

Open Zending aanpassen

Gebruik dit eindpunt om een Open Zending-verzoek aan te passen met gebruik van de benodigde verzendgegevens voordat de verzending wordt bevestigd.

Hieronder volgen de vereiste invoergegevens die bij dit verzoek horen:

index – Dit is een unieke waarde die wordt toegekend aan de reeds aangemaakte Open Zending. Indien deze niet beschikbaar is, geeft u het hoofdtrackingnummer op.
accountNumber – Dit is het FedEx-klantnummer.
requestedShipment – De verzendgegevens waarvoor de Open Zending wordt aangepast.

Het succesvolle verzoek werkt de verzendgegevens bij naar de reeds aangemaakte Open Zending en geeft het trackingnummer voor de/het gewijzigde pakket(ten) en bijgewerkte transactieverzendgegevens weer.

Open Zending ophalen

Gebruik dit eindpunt om een bestaande Open Zending ter controle of verificatie op te halen.

Hieronder volgen de vereiste invoergegevens die bij dit verzoek horen:

index – Dit is een unieke waarde die wordt toegekend aan de reeds aangemaakte Open Zending. Indien deze niet beschikbaar is, geeft u het hoofdtrackingnummer op.
accountNumber – Dit is het FedEx-klantnummer.

Het succesvolle verzoek zal de beoogde gegevens van de Open Zending ophalen.

Open Zending verwijderen

Gebruik dit eindpunt om het bestaande Open Shipment-verzoek te verwijderen voordat de verzending wordt bevestigd.

Hieronder volgen de vereiste invoergegevens die bij dit verzoek horen:

index – Dit is een unieke waarde die wordt toegekend aan de reeds aangemaakte Open Zending. Indien deze niet beschikbaar is, geeft u het hoofdtrackingnummer op.
accountNumber – Dit is het FedEx-klantnummer.

Het succesvolle verzoek zal de Open Zending en alle daaraan verbonden pakketten verwijderen en de status voor het element deletedOpenshipment als waar weergeven.

Open Zending bevestigen

Gebruik dit eindpunt om de verzendgegevens van de Open Zending te valideren en te uploaden naar FedEx-systemen zodra alle pakketten zijn toegevoegd aan het verzendverzoek.

Hieronder volgen de vereiste invoergegevens die bij dit verzoek horen:

index – Dit is een unieke waarde die wordt toegekend aan de reeds aangemaakte Open Zending. Indien deze niet beschikbaar is, geeft u het hoofdtrackingnummer op.
accountNumber – Dit is het FedEx-klantnummer.
labelResponseOptions – Geef aan of de gecodeerde bytecode of de etiket-URL moet worden weergegeven in de respons.
Opmerking: Het element labelResponseOptions is alleen beschikbaar in de aanvraag 'Open Zending bevestigen' en na bevestiging van de zending worden de etiketten gegenereerd.

De succesvolle bevestigingsrespons voor 40 pakketten of minder zal verzendgegevens uploaden naar FedEx-systemen en pakketetiketten en alle andere verzendrapporten genereren.

De succesvolle bevestigingsrespons voor meer dan 40 pakketten bevestigt dat het verzoek succesvol in de wachtrij is geplaatst en geeft het jobId weer om het resultaat later op te halen.

Opmerking: Er dient minimaal één pakket te worden opgenomen in 'Open zending' voordat u de verzending kunt bevestigen.

Resultaten van Open Zending verkrijgen

Gebruik dit eindpunt om bevestigde verzendingsgegevens van de Open Zending te verkrijgen. Dit eindpunt mag alleen worden gebruikt als de zending meer dan 40 pakketten bevat en jobId is weergegeven in de bevestiging van de Open Zending.

Hieronder volgen de vereiste invoergegevens die bij dit verzoek horen:

resultMethodType – Geef waarde op als AANMAKEN.
accountNumber – Dit is het FedEx-klantnummer.
jobId – Dit is de jobId die werd weergegeven tijdens de bevestiging van de Open Zending.

Een succesvolle respons op dit verzoek zal de bevestigde resultaten van de Open Zending weergeven, zoals pakketetiketten en alle andere verzendrapporten voor de bevestigde Open Zending. Indien de respons fouten bevat, moeten deze fouten worden opgelost met behulp van de eindpunten Open Zending aanpassen of Pakketten Open Zending aanpassen. Vervolgens dient de zending bevestigd te worden met gebruik van het eindpunt Open Zending bevestigen en als laatste dient eindpunt Resultaten Open Zending verkrijgen om de bevestigde resultaten van de Open Zending voor de succesvolle aanvraag op te halen.

Open Zendingen die uit meerdere pakketten bestaan (MPS)

Een zending die uit meerdere pakketten bestaat (MPS), omvat twee of meer pakketten die naar dezelfde ontvangersadressen worden verzonden. Het eerste pakket van de zendingsaanvraag wordt gezien als het hoofdpakket.

Het aanmaken van een zending die uit meerdere pakketten bestaat:

Verstrek de gegevens op zendingsniveau, zoals serviceType, packagingType, totalWeight, totalPackageCount en de requestedPackageLineItems voor het hoofdpakket.
Opmerking: het sequenceNumber van het hoofdpakket moet gelijk zijn aan 1.
Voeg alle pakketten toe aan de verzending.
Bevestig de verzending.

Na het bevestigen van de verzending wordt een van de onderstaande verwerkingsopties gebruikt:

Synchrone pakketverwerking

Synchrone verwerking is een interne verwerkingsmethode die ideaal is voor zendingen die uit maximaal 40 pakketten bestaan (total package count/grouppackagecount<=40), met een beperkt aantal artikelen in de verzending.

Een verzendaanvraag met 40 of minder pakketten wordt synchroon verwerkt en de etiketten en andere verzenddocumenten/rapporten worden onmiddellijk gegenereerd. Dit proces is optimaal voor verzenders als zij een tijdsbeperking hebben en etiketten onmiddellijk na het bevestigen van de zending moeten worden afgedrukt.

Opmerking: het genoemde maximale aantal van 40 pakketten is indicatief en geen vaststaand maximum. Het maximale aantal is ook afhankelijk van de combinatie van het aantal pakketten en artikelen in de verzending. Neem voor meer informatie contact op met de FedEx-klantenservice.

Voorbeeld: uw Open Zending bestaat uit 10 pakketten. Wanneer u de verzending bevestigt nadat u alle 10 pakketten hebt toegevoegd, wordt de verzending synchroon verwerkt. In de respons worden 10 etiketten gemaakt en de etiket-URL's of gecodeerde etiketten, zoals gevraagd, verstrekt.

De volgende workflow op hoog niveau beschrijft de synchrone verwerking van Open Zendingen:

Gebruik het eindpunt Open Zending aanmaken.
Voeg 1- 40 pakketten toe met gebruik van het eindpunt Pakketten aan Open Zending toevoegen
Gebruik het eindpunt Open Zending bevestigen om de Open Zending te bevestigen.
Met een succesvolle aanvraag worden etiketten gegenereerd; het antwoord bevat etiket-URL's of gecodeerde etiketten, zoals gevraagd.
Als de zending fouten bevat, worden de details van deze fouten vermeld in het antwoord.
Na het corrigeren van de fouten gebruikt u Open Zending bevestigen voor een succesvolle respons.

Opmerking:

In deze methode kunt u maximaal 40 pakketten toevoegen als u meer pakketten wilt toevoegen aan een bestaande verzending.

Asynchrone pakketverwerking

Intern verwerkt de API verzendingen asynchroon wanneer de zending meer dan 40 pakketten bevat (d.w.z. totalPackageCount>40). Dit is een gemakkelijke methode als u grote pakketvolumes verstuurt en u deze periodiek in bulk wilt aanbieden. Deze bulkverzendmethode gebruikt diverse kostbare FedEx-bronnen en -handelingen indien u deze in één keer aanbiedt. Met deze verwerkingsoptie zorgt FedEx er intern voor dat deze bulkzendingen eenvoudig worden verwerkt en dat u ook periodiek de etiketgegevens krijgt.

Als de verzending asynchroon wordt verwerkt, bevestigt het antwoord op deze aanvraag alleen dat de aanvraag met succes in de wachtrij is geplaatst maar de verzending mogelijk wel of nog niet met succes is verwerkt, en wordt ook het jobId weergegeven om het resultaat later op te halen.

Opmerking: dit proces vereist enige tijd voor de succesvolle verwerking van de verzending voordat u het resultaat kunt ophalen.

Voor het ophalen van de resultaten van een asynchrone zending gebruikt u het eindpunt Resultaten van Open Zending verkrijgen en specificeert u de gegevens jobId en accountNumber in het verzoek. Met de respons op dit verzoek worden de resulterende verzendgegevens met etiketgegevens of de foutgegevens van de verzending weergegeven.

Voorbeeld: uw zending bestaat uit 45 pakketten die na aanbieding asynchroon worden verwerkt. In de respons wordt een jobId weergegeven. U moet dan het eindpunt Resultaten van Open Zending verkrijgen gebruiken om de verzendresultaten op te halen en de etiketgegevens te verkrijgen.

De volgende workflow op hoog niveau beschrijft de asynchrone verwerking van zendingen:

Gebruik het eindpunt Open Zending aanmaken.
Voeg 40 of meer pakketten toe met gebruik van het eindpunt Pakketten aan Open Zending toevoegen
Gebruik het eindpunt Open Zending bevestigen om de verzending te bevestigen.
Na een succesvolle aanvraag wordt een jobId gegenereerd.
Gebruik het jobId en accountNumber om de uitvoerresultaten op te halen via het eindpunt Resultaten van Open Zending verkrijgen.
De succesvolle uitvoer zal de resultaatgevens van de verzending met etiketgegevens voorzien.
Als het resultaat fouten bevat, worden de details van deze fouten vermeld in het antwoord.

Opmerking:

In deze methode is het maximale toegestane aantal pakketten 300, of maximaal 999 artikelen voor een verzoek.
In deze method kunt u geen nieuwe pakketten toevoegen aan, aanpassen in of verwijderen uit het oorspronkelijke verzoek, wanneer het verzoek is verzonden. Indien de respons fouten bevat, moeten deze fouten worden opgelost met behulp van het eindpunt Pakketten Open Zending aanpassen. Vervolgens dient de zending bevestigd te worden met gebruik van het eindpunt Open Zending bevestigen en wordt met het eindpunt Resultaten Open Zending verkrijgen de succesvolle uitvoer verkregen.

FedEx-verzendetiketten

De FedEx-API ondersteunt een groot aantal etiketten. De FedEx-API ondersteunt drie types etiketopties, waaronder thermisch, gewoon papier en aanpasbare etiketten. U kunt de Open Ship API-eindpunten gebruiken om een groot aantal etiketten te produceren.

FedEx biedt twee etiketvormen aan voor het ondersteunen van verzendservices:

Thermische etiketten
Laseretiketten

Thermische etiketten

Met de FedEx-API kunt u verzendetiketten afdrukken voor alle verzendtypes, zoals FedEx Express^®, FedEx Ground^® en FedEx International Ground^® met gebruik van diverse thermische etiketprinters.

De volgende thermische etiketgroottes worden ondersteund door de FedEx-API:

4" x 6" - zonder een configureerbaar documentetiket (Doc-Tab)
4" x 6,75" - met of zonder een Doc-Tab
4" x 8" - biedt ruimte voor het afdrukken van een afbeelding of tekstbestand naar keuze
4'' x 8,5'' – met een configureerbaar documenttabblad (speciaal voor het bandenidentificatie-etiket)
4" x 9" - biedt ruimte voor afbeeldingen of tekst en een Doc-Tab
4'' x 10,5'' – met een configureerbaar documenttabblad (speciaal voor het bandenidentificatie-etiket)

De etiketpapiertypes 4"X8,5” en 4"X10,5” omvatten een toegevoegd doc-tabblad met identieke streepjescodes. Eén streepjescode wordt weergegeven op het hoofdetiket en de andere op het doc-tabblad. De waarde van het etiketpapiertype is handig voor bandenpakketen, omdat u één etiket op het profiel van de band kunt plaatsen en vervolgens het aanvullende etiket met doc-tabblad, met een identieke kopie van de streepjescode en gebruiksinstructies, op de zijkant van de band kunt plaatsen. Door deze etiketpapiertypes te gebruiken, vermindert u het aantal keer dat een band opnieuw geëtiketteerd moet worden en het toegenomen aantal volumescans optimaliseert hergebruiksmogelijkheden. Zie Etiketpapiertypes voor meer informatie over etiketpapier.

Opmerking: Doc-Tab is een verwijderbaar zelfklevend etiket met aanvullende verzendinformatie en kan worden geselecteerd voor etiketpapier bij het afdrukken van verzendetiketten met een thermische printer.

Elementen thermische etiketten

Thermische verzendetiketten bevatten drie basiselementen:

Door mensen leesbare inhoud: dit deel van het etiket bevat de verzendinformatie.
De streepjescode wordt voor Ground-verzendingen standaard versleuteld.
Tweedimensionale (2D) streepjescode: de dimensionale alfanumerieke streepjescode bevat gegevens voor zowel FedEx Express- als FedEx Ground-verzendingen en maakt gebruik van de standaard American National Standards Institute (ANSI) MH10.8.3. De 2D-streepjescode wordt gecreëerd middels de Portable Data File 417-symbologie (PDF).
FedEx-specifieke streepjescode:
- ASTRA (Advanced Sorting Tracking Routing Assistance) voor FedEx Express-verzendingen tot de FDX 1D-streepjescode volledig is uitgerold; streepjescode '96' voor FedEx Ground en FedEx Home Deliver. FedEx Ground staat ook het gebruik van de SSCC-18 '00'-streepjescode toe.
- De FedEx 1D-streepjescode (FDX1D) voor FedEx Express-verzendingen wordt gecreëerd middels ANSI/AIM BC4-1995 (Uniform Symbology Specification CODE-128C).

Belangrijke informatie voor het genereren van een thermisch etiket

Hieronder volgt de belangrijkste informatie die nodig is voor het genereren van een thermisch etiket:

LabelFormatType: vereist om de juiste etiketafbeelding te ontvangen in de Open Ship Reply API:
- COMMON2D: het etiketformaattype voor het ontvangen van een etiket.
- LABEL_DATA_ONLY: de waarde die wordt gebruikt voor het ontvangen van de streepjescodegegevens als u een aangepast etiket maakt.

Geldige waarden:

ImageType: vereist voor het formatteren van het thermisch etiket voor de printer die u gebruikt. Specificeert het type gegevensstroom die of het type bitmap dat moet worden teruggestuurd.
- EPL2 - Eltron (etiketpapiertypes)
- ZPLII - Zebra (etiketpapiertypes)

Geldige waarden:

Opmerking: alle etiketten die voor een zending zijn vereist, worden in dezelfde buffer gegenereerd en weergegeven.

Ondersteunde thermische printers

De volgende thermische printers worden aangeraden voor de FedEx-API:

Unimark
Eltron
- Orion (EPL2)
- Eclipse (EPL2)
Zebra
- LP2443 (EPL2)
- LP2844 (EPL2)
- Gk420 (ZPL)
- LP2348 Plus (EPL2/ZPL)
- Z4M Plus (ZPL or EPL)
- ZP500/ZP505 (EPL2/ZPL)
- Z4M/Z4M+ (EPL2/ZPL)
- ZM400 (EPL2/ZPL)
- ZT410 (EPL2/ZPL)
- Andere printers uit de ZT4xx-serie (EPL2/ZPL)

Opmerking: deze printers zijn allemaal compatibel met de ASCII Eltron Programming Language (EPL2) paginamodus. Thermische printers worden zowel ondersteund voor direct schrijven naar op seriële poorten van het systeem aangesloten printers als native- Windows geïnstalleerde printers met LPT-, seriële of USB-aansluitingen. De door FedEx verstrekte firmwareversies voor de printers kunnen per regio verschillen.

Aantal afgedrukte thermische etiketten per service

De volgende tabel geeft het aantal van elk etikettype weer dat nodig is voor een specifieke speciale service. Alle noodzakelijke etiketten worden gegenereerd door een oproep naar de FedEx Common Label Server (CLS), en CLS retourneert een enkele buffer met uitzondering van de COD retouretiketten.

Aantal afgedrukte thermische etiketten per U.S.-service

Servicetype	Thermische etiketten (FedEx CLS retourneert het juiste aantal etiketten in het antwoord)
FedEx Express US	1 verzendetiket
FedEx Ground US / FedEx Home Delivery	1 verzendetiket

Aantal afgedrukte thermische etiketten per U.S. Export International-service

Servicetype	Thermische etiketten (FedEx CLS retourneert het juiste aantal etiketten in het antwoord)
FedEx Express US Export International	1 verzendetiket 2 ontvangstetiketten
FedEx Express US Export International Selectieoptie voor inklaringsagent (BSO)	1 verzendetiket 2 ontvangstetiketten
FedEx Ground US Export International	1 verzendetiket
FedEx Ground US Export International COD	1 verzendetiket 2 COD retouretiketten

Aantal afgedrukte thermische etiketten per Intra-Canada-service

Servicetype	Thermische etiketten (FedEx CLS retourneert het juiste aantal etiketten in het antwoord)
FedEx Express intra-Canada	Verzendingen zonder gevaarlijke goederen/droogijs: 1 verzendetiket
FedEx Ground intra-Canada	1 verzendetiket
FedEx Ground intra-Canada COD	1 verzendetiket 2 COD retouretiketten

Aantal afgedrukte thermische etiketten per Canada Export International-service

Servicetype	Thermische etiketten (FedEx CLS retourneert het juiste aantal etiketten in het antwoord)
FedEx Express Canada Export International	Verzending zonder gevaarlijke goederen/droogijs: 1 verzendetiket 2 ontvangstetiketten
FedEx Express Canada Export International Selectieoptie voor inklaringsagent	Verzending zonder gevaarlijke goederen/droogijs: 1 verzendetiket 2 ontvangstetiketten
FedEx Ground Canada (CA) Export International	1 verzendetiket

Aantal afgedrukte thermische etiketten per Filipijnse en Thaise importzendingen

Servicetype	Thermische etiketten (FedEx CLS retourneert het juiste aantal etiketten in het antwoord)
Importzendingen Filipijnen	2 verzendetiketten met accountnummer afgedrukt 1 ontvangstetiket zonder accountnummer afgedrukt 3 kopieën van handelsfactuur
Importzendingen artikelen Thailand	3 verzendetiketten met accountnummer afgedrukt 1 ontvangstetiket zonder accountnummer afgedrukt
Importzendingen documenten Thailand	2 verzendetiketten met accountnummer afgedrukt 1 ontvangstetiket zonder accountnummer afgedrukt

Doc-Tab

Als u verzendetiketten afdrukt met een thermische printer kunt u een etiketpapier met Doc-Tab selecteren, een verwijderbaar zelfklevend etiket met aanvullende verzendinformatie. U kunt deze verzendinformatie direct vanuit uw verzendgegevens configureren of configureerbare gegevens afdrukken die bij uw specifieke verzendbehoeften horen.

Laseretiketten

De FedEx-API ondersteunt het afdrukken van etiketten met een laserprinter. Deze etiketten worden vaak gedrukt op US Letter of A4-papier en doormidden gevouwen zodat ze in de standaard FedEx-etiketzak passen. Etiketten die met een laserprinter worden afgedrukt, worden gegenereerd in PDF-indeling en hoeven niet te worden geschaald of aangepast. Zie Papiersoorten etiketten voor meer informatie.

Vereisten

De volgende vereisten zijn van toepassing op PDF-etiketten:

Adobe Reader 6.0 of hoger is vereist voor het verwerken van het etiket.
De driverconfiguratie van de printer moet zo zijn ingesteld dat het etiket niet wordt geschaald.
Het gebruiken van een HTML-wrapper is niet noodzakelijk voor het weergeven van een gewoon PDF-etiket in een browser.
Acrobat raadt de volgende browsers aan voor het bekijken van PDF-documenten:
- Microsoft Internet Explorer 10 of hoger
- Firefox 1.0 of hoger
- Mozilla 1.7 of hoger

De PDF-etiketoptie elimineert de noodzaak voor het specificeren van de afbeeldingsoriëntatieparameter (breedte en hoogte) of de schermresolutie om het etiket correct weer te geven in de browser.

Elementen laseretiketten

Laser-verzendetiketten bevatten drie basiselementen:

Door mensen leesbare inhoud: dit deel van het etiket bevat de verzendinformatie.
De streepjescode wordt voor Ground-verzendingen standaard versleuteld.
Tweedimensionale (2D) streepjescode: de dimensionale alfanumerieke streepjescode bevat gegevens voor zowel FedEx Express- als FedEx Ground-verzendingen en maakt gebruik van de standaard American National Standards Institute (ANSI) MH10.8.3. De 2D-streepjescode wordt gecreëerd middels de Portable Data File (PDF) 417-symbologie.
FedEx-specifieke streepjescode:
- ASTRA (Advanced Sorting Tracking Routing Assistance) voor FedEx Express-verzendingen tot de FDX 1D-streepjescode volledig is uitgerold; streepjescode '96' for FedEx Ground- en FedEx Home Delivery-verzendingen. FedEx Ground staat waar van toepassing ook het gebruik van de SSCC-18 '00'-streepjescode toe.
- De FedEx 1D-streepjescode (FDX1D) voor FedEx Express-verzendingen wordt gecreëerd middels ANSI/AIM BC4-1995 (Uniform Symbology Specification CODE-128C).

Belangrijke informatie voor het genereren van een laseretiket

De volgende FedEx-API-elementen zijn vereist voor het genereren van een laseretiket:

LabelSpecification/LabelFormatType: vereist om de juiste etiketafbeelding te ontvangen in de Open Ship Reply API: Geldige waarden zijn:
- COMMON2D: het etiketformaattype voor het ontvangen van een etiket.
- LABEL_DATA_ONLY: de waarde die wordt gebruikt voor het ontvangen van de streepjescodegegevens als u een aangepast etiket maakt.

LabelSpecification/ImageType: vereist voor het aangeven van de etiketformattering. Het te retourneren type gegevensstroom of bitmap:
Geldige waarden zijn:
- PDF: gewoon papier
- PNG: gewoon papier

LabelSpecification/LabelStockType: vereist voor alle etikettypen. Specificeer of het etiketpapier aan de voor- of achterrand een Doc-Tab heeft of niet. Bij gebruik van een ImageType van PDF of PNG tonen deze waarden een etiket in laserformaat:
- PAPER_4X6
- PAPER_4X8
- PAPER_4X9
- PAPER_4X675
  Deze waarden tonen een verzendetiket in normaal papierformaat:
- PAPER_7X47
- PAPER_85X11_BOTTOM_HALF_LABEL
- PAPER_85X11_TOP_HALF_LABEL
- PAPER_LETTER

Opmerking: als u een etiket voor gewoon papier aanvraagt, wordt er een Base64-gecodeerde etiketafbeelding geretourneerd. Dit moet Base64-gedecodeerd worden voordat het etiketbestand kan worden weergegeven.

Ondersteunde laserprinters

De meeste laserprinters worden ondersteund voor dit etikettype. Etiketten worden echter niet geaccepteerd als deze met een inkjetprinter zijn afgedrukt.Opmerking: als u een kleurenlaserprinter gebruikt, moet de kleurdefinitie worden ingesteld op zwart, zelfs als de printer alleen een zwarte cartridge bevat.

Aantal laseretiketten vereist per service

Aantal afgedrukte laseretiketten per U.S.-service

Servicetype	Laseretiket - PDF-indeling
FedEx Ground / FedEx Home Delivery US	1 verzendetiket

Aantal afgedrukte laseretiketten per U.S. Export International-service

Servicetype	Laseretiket - PDF-indeling
FedEx Express US Export International	1 verzendetiket in het antwoord. Minstens 3 etiketten moeten worden afgedrukt: 1 voor op het pakket en 2 voor in de documentenzak.
FedEx Express US Export International Broker Select	1 verzendetiket in het antwoord. Minstens 3 etiketten moeten worden afgedrukt: 1 voor op het pakket en 2 voor in de documentenzak.
FedEx Ground US Export International	1 verzendetiket
FedEx Ground US Export International COD	1 verzendetiket 2 COD retouretiketten

Aantal afgedrukte laseretiketten per Intra-Mexico-service

Servicetype

Laseretiket - PDF-indeling

FedEx Express intra-Mexico

Verzendingen zonder gevaarlijke goederen/droogijs:

1 verzendetiket

Aantal afgedrukte laseretiketten per Intra-Canada-service

Servicetype	Laseretiket - PDF-indeling
FedEx Express intra-Canada	FedEx Express intra-Canada Verzendingen zonder gevaarlijke goederen/droogijs: 1 verzendetiket
FedEx Ground intra-Canada	1 verzendetiket
FedEx Ground intra-Canada COD	1 verzendetiket 2 COD retouretiketten

Aantal afgedrukte laseretiketten per Canada Export International-service

Servicetype	Laseretiket - PDF-indeling
FedEx Express Canada Export International	FedEx Express Canada Export International Verzending zonder gevaarlijke goederen/droogijs: 1 verzendetiket 2 ontvangstetiketten
FedEx Express Canada Export International Selectieoptie voor inklaringsagent	FedEx Express Canada Export International Selectieoptie voor inklaringsagent Verzending zonder gevaarlijke goederen/droogijs: 1 verzendetiket 2 ontvangstetiketten
FedEx Ground Canada (CA) Export International	1 verzendetiket

Aantal afgedrukte laseretiketten per Canada Export International-service

Servicetype	Laseretiket - PDF-indeling
FedEx Express Canada Export International	FedEx Express Canada Export International Verzending zonder gevaarlijke goederen/droogijs: 1 verzendetiket 2 ontvangstetiketten
FedEx Express Canada Export International Selectieoptie voor inklaringsagent	FedEx Express Canada Export International Selectieoptie voor inklaringsagent Verzending zonder gevaarlijke goederen/droogijs: 1 verzendetiket 2 ontvangstetiketten
FedEx Ground Canada (CA) Export International	1 verzendetiket

Aantal afgedrukte laseretiketten per Filipijnse en Thaise importzendingen

Servicetype	Thermische etiketten (FedEx CLS retourneert het juiste aantal etiketten in het antwoord)
Importzendingen Filipijnen	2 verzendetiketten met accountnummer afgedrukt 1 ontvangstetiket zonder accountnummer afgedrukt 3 kopieën van handelsfactuur
Importzendingen artikelen Thailand	3 verzendetiketten met accountnummer afgedrukt 1 ontvangstetiket zonder accountnummer afgedrukt
Importzendingen documenten Thailand	2 verzendetiketten met accountnummer afgedrukt 1 ontvangstetiket zonder accountnummer afgedrukt

Aangepast etiket

FedEx staat het aanpassen van het door FedEx gegenereerde etiket toe. U kunt specifieke tekst voor uw bedrijf toevoegen en het type streepjescode (de symbologie) kiezen die wordt gebruikt op FedEx-documenten en -etiketten in het aanpasbare gedeelte van thermische etiketten.

Ter ondersteuning van uw verzendapplicatie biedt de FedEx Open Ship API twee opties voor het aanpassen van uw verzendetiket:

Plaats de 7" x 4,75" PNG PAPER-afbeelding op uw etiketpapier. U kunt bijvoorbeeld een pakketlijst maken op een 8-1/2" x 11" formulier. Als onderdeel van dit formulier kunt u ook de 7" x 4,75" PNG PAPER-afbeelding plaatsen in plaats van zelf een aangepast etiket te creëren.
Voeg een afbeelding- of tekstbestand toe aan het 4" x 8" of 4" x 9" thermisch etiket. Deze etiketgrootte biedt 5 cm (2 in) ruimte voor uw afbeelding of tekst.

Opmerking: de door mensen leesbare inhoud van het etiket en de streepjescode in het algemene gedeelte van het etiket kunnen niet worden aangepast.

Aangepast valideringsetiket

U kunt aangepaste etiketten die niet voor verzending zijn bedoeld maken op zowel pakket- als zendingsniveau door te specificeren welke aangepaste informatie gewenst is, hoe die informatie moet worden opgemaakt en waar die moet worden geplaatst op het aangepaste etiket. Aangepaste etiketten zijn beperkt tot het thermische etiketformaat.

Thermische etiketten aanpassen

De FedEx-API biedt twee thermische etiketformaten die u kunt aanpassen met een afbeeldings- of tekstbestand, zodat het niet nodig is om een aangepast etiket te maken. Deze etiketten ondersteunen alle FedEx-verzendservices. Deze formaten zijn:

4" x 8" thermisch etiket zonder Doc-Tab
4" x 9" thermisch etiket met Doc-Tab

Deze labeltypen bevatten een aanpasbaar gedeelte van 5 cm (2 in). Deze functie is van toepassing op thermische labels die zijn afgedrukt op een thermische printer ingesteld op 203 of 300 DPI.

Regels voor aangepaste etiketten

Regels voor het gebruik van de etiketformaten zijn:

Alleen het verzendetiket kan worden aangepast. Als u bijvoorbeeld een 4" x 8" Express-verzendetiket afdrukt met uw logo, zal dit logo op de secundaire etiketten voor de ontvanger niet worden weergegeven.
De aanpasbare afbeelding of tekst mag niet groter zijn dan 5 x 11 cm (2 x 4,5 in).
FedEx voert geen correcties uit. De afbeelding en/of text wordt afgedrukt zoals deze wordt aangeboden aan de verzendservice.
Als niet alle noodzakelijke gegevens voor het afdrukken van de afbeelding en/of tekst zijn verstrekt (bijvoorbeeld X- en Y-coördinaten), wordt een geldig verzendetiket geretourneerd zonder de aangepaste gegevens. U dient de zending die bij dit etiket hoort te annuleren als u een ander etiket wilt maken met de afbeelding en/of tekst.
Wat betreft de plaatsing op X- en Y-coördinaten voor een afdrukresolutie van 203 DPI (8 punten/mm), zijn de coördinaten van het invoerpunt de kruising van de bovenste en linker randen van het 4,00" x 6,75" thermische label met de onderste Doc-Tab. Verhoog voor 4,00" x 6,75" thermische etiketten met bovenste Doc-Tab de Y-coördinaten van het invoerpunt met 164 punten. Verhoog voor 4,00" x 6,75" thermische etiketten zonder Doc-Tab de Y-coördinaten van het invoerpunt met 8 punten. Kenmerken van thermische etiketten zijn gebaseerd op een afdrukresolutie van 203 DPI (8 punten/mm).
Wat betreft de plaatsing op X- en Y-coördinaten voor een afdrukresolutie van 300 DPI (12 punten/mm), zijn de coördinaten van het invoerpunt de kruising van de bovenste en linker randen van het 4,00" x 6,75" thermische label met de onderste Doc-Tab. Verhoog voor 4,00" x 6,75" thermische labels met bovenste Doc-Tab de Y-coördinaten van het invoerpunt met 246 punten. Verhoog voor 4,00" x 6,75" thermische labels zonder Doc-Tab de Y-coördinaten van het invoerpunt met 12 punten. Kenmerken van thermische labels zijn gebaseerd op een afdrukresolutie van 300 DPI (12 punten/mm).
Opmerking:
- Voor de FXD1D-barcode is de X-dimensie (wijdte van de smalste balk in het symbool) 15 mm (3 punten) voor 203 DPI-printers en 13.3 mm (4 punten) voor 300 DPI-printers.
- Voor de 2D PDF-417-barcode is de X-dimensie 10 mm (2 punten) voor 203 DPI-printers. Gebruik 9,99 mm (3 punten) voor 300 DPI printers om de dichtstbijzijnde equivalente X-dimensie te krijgen.
- Voor het afzender/diversen-blok bovenaan het label en het afzenderreferentie-blok onder de gegevens van de ontvanger waar zeer kleine lettertypes worden gebruikt, moeten labelontwikkelaars de ZPL-programmeerhandleiding raadplegen om de kenmerken van de lettertypeset met elkaar te vergelijken zodat ze een lettertypeset kunnen selecteren die gelijkwaardig presteert voor verschillende andere printkop-resoluties.
Het tekeninvoerpunt is de linkerbovenhoek van het eerste teken in de tekenreeks, op de beginregel.
Vanwege printerbeperkingen moet de herkomstpositie zich in het kwadrant linksboven op de voorzijde bevinden. Daardoor is het mogelijk dat gegevens beginnen in het aanpasbare gedeelte van het etiket en overlopen in het FedEx-gedeelte van het etiket (de daadwerkelijke thermische etiketgegevens). Als dit het geval is, zal uw logo of tekst worden overschreven met de FedEx-etiketinformatie. U dient deze positionering aan te passen om het verzendetiket te gebruiken.
De toevoeging van Doc-Tab-informatie aan het 4" x 9" label moet worden geconfigureerd middels hetzelfde proces dat u zou gebruiken voor een standaard 4" x 6" Doc-Tab thermisch etiket.

Opmerking: er kunnen alleen kleurafbeeldingen van één bit worden toegevoegd, omdat etiketten in zwart-wit zullen worden afgedrukt.

Elementen van aangepaste etiketafbeeldingen

De API biedt PNG-afbeeldingen (Portable Network Graphic) for FedEx Express- en FedEx Ground-etiketten. De PNG-etiketafbeelding is een replica van de etiketten voor thermisch of gewoon papier die door de API worden ondersteund. Met deze etiketafbeelding kunt u de PNG-etiketafbeelding op uw etiketpapier plaatsen zonder dat u een aangepast etiket hoeft te maken.

De volgende vereisten zijn van toepassing bij gebruik van de 4" x 6" PNG-afbeelding die is ingebed in uw verzenddocument:

Etiketpapier
Printer
Schaling

Etiketpapier

4" x 6" PNG-etiketten moeten alleen worden gebruikt met zelfklevend etiketpapier. De etiketcertificatieteams van FedEx Ground en FedEx Express weigeren 4" x 6" PNG-etiketten die niet zijn afgedrukt op zelfklevend etiketpapier, inclusief alle labels die zijn afgedrukt op gewoon papier.

Printer

Laserprinters worden aangeraden voor het afdrukken van etiketten. Inkjetprinters moeten niet worden gebruikt vanwege hun onbetrouwbaarheid bij het afdrukken van scanbare streepjescodes. Het 4' x 6' PNG-etiket kan niet worden afgedrukt op een kleurenprinter tenzij de kleurdefinitie is ingesteld op zwart, zelfs als de printer alleen een zwarte cartridge bevat. Deze instelling is noodzakelijk om de juiste streepjescodedefinitie te handhaven voor het scannen van etiketten in FedEx-hubs.

Schaling

De geretourneerde afbeelding in uw verzendtransactie is 200 dots per inch (DPI) en 10 (B) x 15 (H) cm (4 x 6 in) of 800 x 1200 pixels groot. Dit etiket heeft een verticale oriëntatie en is ontworpen om te worden afgedrukt in een etiketgebied van 10 x 15 cm (4 x 6 in). Na het afdrukken moet het etiket 10 x 15 cm (4 x 6 in) groot zijn.

Om het etiket en de streepjescode met de vereiste DPI te produceren, dient u de afbeelding voor het afdrukken te schalen (of de grootte aan te passen). Hoe u de afbeelding schaalt, hangt af van de applicatie die u gebruikt om het etiket te bekijken en af te drukken. De PNG-afbeelding schalen voor een etiket van 10 x 15 cm (4" x 6"): gebruik exact 4" breedte en 6" lengte.

Checklist etiketbeoordeling

Alle streepjescodes

Vereist voor validatie:

Schone zone: er moet altijd ten minste 0,25 cm (0,1 in) vrije ruimte boven en onder de streepjescode zijn.
Schone zone: er moet altijd ten minste 0,5 cm (0,2 in) vrije ruimte links en rechts van de streepjescode zijn.
Valideer dat alle streepjescodes aan de minimale hoogtevereisten voldoen.

Afdrukkwaliteit

Veelvoorkomende problemen die leiden tot het weigeren van etiketten:

Gebroken streepjes
Vervaagde afdruk/witte gebieden
Herhalende witte gebieden (probleem met roller)
Vegen (thermische transfer)
Afbladdering (laser) duidt op een probleem met de tonerfusie
Rimpelingen in de afdruk (thermische transfer)
Het afdrukcontrast voor directe thermische etiketten moet ten minste 90% zijn

Door mensen leesbare details voor Ground-etiketten

Voor de door mensen leesbare informatie op FedEx Ground-etiketten is het volgende vereist voor validatie:

Gegevens komen overeen met streepjescode
FedEx Ground-logo: logo's kunnen worden gedownload van de FedEx Identity-website op www.fedex.com.
FedEx Home Delivery-logo: etiketten moeten een grote H in een kader bevatten binnen 2,5 cm (1 in) van het adres van de ontvanger. De H moet ten minste 0,635 x 1,78 cm (0,25 x 0,7 in) groot zijn.
Beschrijving service
Gegevens afzender
Gegevens geadresseerde
Postcode en routering
Verzenddatum
Werkelijk gewicht
Informatie klantautomatiseringsapparaat (meter, applicatie/systeem, versie)
Afmetingen
Bijzondere referentie-informatie
Traceernummer en formulier-id (traceernummer moet 14 tekens lang zijn)
Laadstation-id luchthaven
Postcode

Door mensen leesbare details voor Express-etiketten

De volgende elementen moeten op het etiket zijn afgedrukt om te kunnen worden gecertificeerd:

FedEx Express-logo: logo's kunnen worden gedownload van de FedEx Identity-website op www.fedex.com.
Beschrijving service
Pakkettype, indien internationaal
Afleverdag (bijvoorbeeld: MON voor maandag)
Afleveren op datum
Nummer meter
Verzenddatum
Formaat van stukstal, masteretiketverwoording, CRN-etiketverwoording op alle MPS
Laadstation-id luchthaven
Postcode en routering
Voorvoegsel en achtervoegsel URSA-routering
Afhandelingscodes
Toegezegd servicegebied
Telefoonnummers ontvanger en verzender
Gewicht
Afmetingen, indien van toepassing
Referentieveld bij een verzending van alcohol
Traceernummer en formulier-id (traceernummer moet 14 tekens lang zijn)
In het ASTRA-etiket bevindt het twaalfcijferige traceernummer zich in posities 17 tot 28 van de streepjescode met 32 tekens. In de nieuwe FDX 1D-streepjescode, bevindt het traceernummer zich op posities 21 tot 34. Het FedEx Express-traceernummer bestaat nog steeds uit 12 tekens. De eerste twee posities zijn nul (0).

Bedrijfsregels

De volgende regels zijn van toepassing op Open Ship API:

Open Zending kan ook worden aangemaakt en bevestigd met één pakket.
De Open Zendingen worden verwijderd als ze niet binnen het einde van de vijfde dag na het aanmaken van de zending worden bevestigd.
Als de verzending is bevestigd, kunnen geen pakketten meer worden toegevoegd aan de Open Zending.

JSON API-verzameling

Open Ship API (1.0)

Create Open Shipment

This endpoint helps you to create an openn shipment request with the required shipping information.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-createOpenShipment
MinimumSamplePayload-CreateOpenshipment
MinimumSamplePayload-CreateOpenshipmentAsynchronous

requestedShipment required	object (OpenshipmentRequestedShipment) The detailed transaction data for the requested Open Shipment.
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number
openShipmentAction	string (OpenShipAction) Enum: "STRONG_VALIDATION" "WEAK_VALIDATION" "CREATE_PACKAGE" Indicates the optional actions that can be performed during the modification of packages in Open Shipment. Here are the values: CREATE_PACKAGE - Use CREATE_PACKAGE option to create Open Shipment. STRONG_VALIDATION – Full shipment edits: any edit that fails will cause the transaction to fail. If the transaction is successful, a tracking number may be returned and the transaction will be saved to the database (committed). WEAK_VALIDATION - Full shipment edits: any edit that fails will return errors but the transaction does not fail. The tracking number is returned and the transaction is saved in the database if the core edits are passed. Fix errors with the ModifyRequests transaction using the Index and returned tracking number.
index	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Note: If index is not provided while create open shipment then the master tracking id of create open ship will act as index for the shipment. Example: Test1234

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/create

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/create

Production Server

https://apis.fedex.com/ship/v1/openshipments/create

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"requestedShipment":
{
- "shipDatestamp": "2019-10-14",
- "pickupType": "USE_SCHEDULED_PICKUP",
- "serviceType": "PRIORITY_OVERNIGHT",
- "packagingType": "YOUR_PACKAGING",
- "totalWeight": 20.6,
- "shipper":
  {
  - "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "1234567890",
    "companyName": "Fedex"
    },
  - "tins":
    [
    {
    "number": "XXX567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
  },
- "recipients":
  [
  - {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "FedEx"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "deliveryInstructions": "Delivery Instructions"
    }
  ],
- "soldTo":
  {
  - "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "1234567890",
    "companyName": "Fedex"
    },
  - "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
  - "accountNumber":
    {
    "value": "Your account number"
    }
  },
- "origin":
  {
  - "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
  },
- "shippingChargesPayment":
  {
  - "paymentType": "SENDER",
  - "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "XXXX567890",
    "phoneExtension": "phone extension",
    "companyName": "Fedex",
    "faxNumber": "fax number"
    },
    "accountNumber":
    {
    "value": "Your account number"
    }
    }
    }
  },
- "shipmentSpecialServices":
  {
  - "specialServiceTypes":
    [
    "THIRD_PARTY_CONSIGNEE",
    "PROTECTION_FROM_FREEZING"
    ],
  - "etdDetail":
    {
    "attributes":
    [
    "POST_SHIPMENT_UPLOAD_REQUESTED"
    ],
    "attachedDocuments":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ],
    "requestedDocumentTypes":
    [
    "VICS_BILL_OF_LADING",
    "GENERAL_AGENCY_AGREEMENT"
    ]
    },
  - "deliveryOnInvoiceAcceptanceDetail":
    {
    "recipient":
    {
    "address":
    {
    "streetLines":
    [
    "23, RUE JOSEPH-DE MA",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "1234567890",
    "companyName": "Fedex"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "deliveryInstructions": "Delivery Instructions"
    }
    },
  - "internationalTrafficInArmsRegulationsDetail":
    {
    "licenseOrExemptionNumber": "9871234"
    },
  - "holdAtLocationDetail":
    {
    "locationId": "YBZA",
    "locationContactAndAddress":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
    "locationType": "FEDEX_ONSITE"
    },
  - "shipmentCODDetail":
    {
    "addTransportationChargesDetail":
    {
    "rateType": "ACCOUNT",
    "rateLevelType": "BUNDLED_RATE",
    "chargeLevelType": "CURRENT_PACKAGE",
    "chargeType": "COD_SURCHARGE"
    },
    "codRecipient":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
    "remitToName": "remitToName",
    "codCollectionType": "ANY",
    "financialInstitutionContactAndAddress":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "returnReferenceIndicatorType": "INVOICE",
    "shipmentCodAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
  - "shipmentDryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "packageCount": 12
    },
  - "internationalControlledExportDetail":
    {
    "licenseOrPermitExpirationDate": "2019-12-03",
    "licenseOrPermitNumber": "11",
    "entryNumber": "125",
    "foreignTradeZoneCode": "US",
    "type": "WAREHOUSE_WITHDRAWAL"
    },
  - "homeDeliveryPremiumDetail":
    {
    "phoneNumber":
    {
    "areaCode": "901",
    "localNumber": "3575012",
    "extension": "200",
    "personalIdentificationNumber": "98712345"
    },
    "deliveryDate": "2019-06-26",
    "homedeliveryPremiumType": "APPOINTMENT"
    }
  },
- "emailNotificationDetail":
  {
  - "aggregationType": "PER_PACKAGE",
  - "emailNotificationRecipients":
    [
    {
    "name": "Joe Smith",
    "emailNotificationRecipientType": "SHIPPER",
    "emailAddress": "jsmith3@aol.com",
    "notificationFormatType": "TEXT",
    "notificationType": "EMAIL",
    "locale": "en_US",
    "notificationEventType":
    [
    "ON_PICKUP_DRIVER_ARRIVED",
    "ON_SHIPMENT"
    ]
    }
    ],
  - "personalMessage": "your personal message here"
  },
- "expressFreightDetail":
  {
  - "bookingConfirmationNumber": "123456789812",
  - "shippersLoadAndCount": 123,
  - "packingListEnclosed": true
  },
- "variableHandlingChargeDetail":
  {
  - "rateType": "PREFERRED_CURRENCY",
  - "percentValue": 12.45,
  - "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
  - "fixedValue":
    {
    "amount": 24.45,
    "currency": "USD"
    },
  - "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
  },
- "customsClearanceDetail":
  {
  - "regulatoryControls": "NOT_IN_FREE_CIRCULATION",
  - "brokers":
    [
    {
    "broker":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 91,
    "companyName": "Fedex",
    "faxNumber": 1234567
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "deliveryInstructions": "deliveryInstructions"
    },
    "type": "IMPORT"
    }
    ],
  - "commercialInvoice":
    {
    "originatorName": "originator Name",
    "comments":
    [
    "optional comments for the commercial invoice"
    ],
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
    "taxesOrMiscellaneousCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousChargeType": "COMMISSIONS",
    "freightCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "packingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "handlingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "declarationStatement": "declarationStatement",
    "termsOfSale": "FCA",
    "specialInstructions": "specialInstructions\"",
    "shipmentPurpose": "REPAIR_AND_RETURN",
    "emailNotificationDetail":
    {
    "emailAddress": "neena@fedex.com",
    "type": "EMAILED",
    "recipientType": "SHIPPER"
    }
    },
  - "freightOnValue": "OWN_RISK",
  - "dutiesPayment":
    {
    "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "phone extension",
    "companyName": "Fedex",
    "faxNumber": "fax number"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    },
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    }
    },
    "billingDetails":
    {
    "billingCode": "billingCode",
    "billingType": "billingType",
    "aliasId": "aliasId",
    "accountNickname": "accountNickname",
    "accountNumber": "Your account number",
    "accountNumberCountryCode": "US"
    },
    "paymentType": "SENDER"
    },
  - "commodities":
    [
    {
    "unitPrice":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "additionalMeasures":
    [
    {
    "quantity": 12.45,
    "units": "KG"
    }
    ],
    "numberOfPieces": 12,
    "quantity": 125,
    "quantityUnits": "Ea",
    "customsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "countryOfManufacture": "US",
    "cIMarksAndNumbers": "87123",
    "harmonizedCode": "0613",
    "description": "description",
    "name": "non-threaded rivets",
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "exportLicenseNumber": "26456",
    "exportLicenseExpirationDate": "2025-04-06T03:14:39Z",
    "partNumber": "167",
    "purpose": "BUSINESS",
    "usmcaDetail":
    {
    "originCriterion": "A"
    }
    }
    ],
  - "isDocumentOnly": true,
  - "recipientCustomsId":
    {
    "type": "PASSPORT",
    "value": "123"
    },
  - "customsOption":
    {
    "description": "Description",
    "type": "COURTESY_RETURN_LABEL"
    },
  - "importerOfRecord":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
  - "generatedDocumentLocale": "en_US",
  - "exportDetail":
    {
    "destinationControlDetail":
    {
    "endUser": "dest country user",
    "statementTypes": "DEPARTMENT_OF_COMMERCE",
    "destinationCountries":
    [
    "USA",
    "India"
    ]
    },
    "b13AFilingOption": "NOT_REQUIRED",
    "exportComplianceStatement": "12345678901234567",
    "permitNumber": "12345"
    },
  - "totalCustomsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "partiesToTransactionAreRelated": true,
  - "declarationStatementDetail":
    {
    "usmcaLowValueStatementDetail":
    {
    "countryOfOriginLowValueDocumentRequested": true,
    "customsRole": "EXPORTER"
    }
    },
  - "insuranceCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    }
  },
- "smartPostInfoDetail":
  {
  - "ancillaryEndorsement": "RETURN_SERVICE",
  - "hubId": "5015",
  - "indicia": "PRESORTED_STANDARD",
  - "specialServices": "USPS_DELIVERY_CONFIRMATION"
  },
- "blockInsightVisibility": true,
- "rateRequestType":
  [
  - "LIST",
  - "PREFERRED"
  ],
- "preferredCurrency": "USD",
- "requestedPackageLineItems":
  [
  - {
    "sequenceNumber": "1",
    "subPackagingType": "BUCKET",
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
    "declaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
    "groupPackageCount": 2,
    "itemDescriptionForClearance": "description",
    "contentRecord":
    [
    {
    "itemNumber": "2876",
    "receivedQuantity": 256,
    "description": "Description",
    "partNumber": "456"
    }
    ],
    "itemDescription": "item description for the package",
    "variableHandlingChargeDetail":
    {
    "rateType": "PREFERRED_CURRENCY",
    "percentValue": 12.45,
    "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
    "fixedValue":
    {
    "amount": 24.45,
    "currency": "USD"
    },
    "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
    },
    "packageSpecialServices":
    {
    "specialServiceTypes":
    [
    "ALCOHOL",
    "NON_STANDARD_CONTAINER"
    ],
    "signatureOptionType": "SERVICE_DEFAULT",
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
    "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
    }
  ]
},
"accountNumber":
{
- "value": "Your account number"
},
"openShipmentAction": "CREATE_PACKAGE",
"index": "Test1234"

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624dxxx6-b709-470c-8c39-4b55xxxxx492",
"customerTransactionId": "order123xxxx89",
"output":
{
- "asynchronousProcessingResultsDetail": "SYNCHRONOUSLY_PROCESSED",
- "jobId": "abc123456",
- "transactionShipments":
  [
  - {
    "serviceType": "FEDEX_2_DAY_FREIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "serviceName": "FedEx 2 Day Freight",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "completedShipmentDetail":
    {
    "completedPackageDetails":
    [
    {
    "sequenceNumber": 256,
    "operationalDetail":
    {
    "astraHandlingText": "astraHandlingText",
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value": "string"
    }
    ],
    "stringBarcodes":
    [
    {
    "type": "ADDRESS",
    "value": "1010062512241535917900794953544894"
    }
    ]
    },
    "operationalInstructions":
    [
    {
    "number": 17,
    "content": "content"
    }
    ]
    },
    "signatureOption": "DIRECT",
    "trackingIds":
    [
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    }
    ],
    "groupNumber": 567,
    "oversizeClass": "OVERSIZE_1, OVERSIZE_2, OVERSIZE_3",
    "packageRating":
    {
    "effectiveNetDiscount": 0,
    "actualRateType": "PAYOR_ACCOUNT_PACKAGE",
    "packageRateDetails":
    [
    {
    "ratedWeightMethod": "DIM",
    "totalFreightDiscounts": 44.55,
    "totalTaxes": 3.45,
    "minimumChargeType": "minimumChargeType",
    "baseCharge": 45.67,
    "totalRebates": 4.56,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "billingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "netFreight": 4.89,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 22.56,
    "netFedExCharge": 12.56,
    "netCharge": 121.56,
    "currency": "USD"
    }
    ]
    },
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68
    },
    "hazardousPackageDetail":
    {
    "regulation": "IATA",
    "accessibility": "ACCESSIBLE",
    "labelType": "II_YELLOW",
    "containers":
    [
    {
    "qvalue": 2,
    "hazardousCommodities":
    [
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "options":
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "innerReceptacles":
    [
    {
    "quantity":
    {
    "quantityType": "NET",
    "amount": 34.56,
    "units": "Kg"
    }
    }
    ],
    "options":
    {
    "labelTextOption": "APPEND",
    "customerSuppliedLabelText": "Customer Supplied Label Text."
    },
    "description":
    {
    "sequenceNumber": 9812,
    "processingOptions":
    [
    "INCLUDE_SPECIAL_PROVISIONS"
    ],
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "technicalName": "technicalName",
    "packingDetails":
    {
    "packingInstructions": "packing Instructions",
    "cargoAircraftOnly": true
    },
    "authorization": "authorization",
    "reportableQuantity": true,
    "percentage": 12.45,
    "id": "123",
    "packingGroup": "I",
    "properShippingName": "properShippingName",
    "hazardClass": "hazard Class"
    }
    },
    "description":
    {
    "sequenceNumber": 876,
    "packingInstructions": "packingInstructions",
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "tunnelRestrictionCode": "UN2919",
    "specialProvisions": "specialProvisions",
    "properShippingNameAndDescription": "properShippingNameAndDescription",
    "technicalName": "technicalName",
    "symbols": "symbols",
    "authorization": "authorization",
    "attributes":
    [
    "attributes"
    ],
    "id": "1234",
    "packingGroup": "packingGroup",
    "properShippingName": "properShippingName",
    "hazardClass": "hazardClass"
    },
    "netExplosiveDetail":
    {
    "amount": 10,
    "units": "units",
    "type": "NET_EXPLOSIVE_WEIGHT"
    },
    "massPoints": 2
    }
    ]
    }
    ],
    "cargoAircraftOnly": true,
    "referenceId": "123456",
    "radioactiveTransportIndex": 2.45
    }
    }
    ],
    "operationalDetail":
    {
    "originServiceArea": "A1",
    "serviceCode": "010",
    "airportId": "DFW",
    "postalCode": "38010",
    "scac": "scac",
    "deliveryDay": "TUE",
    "originLocationId": "678",
    "countryCode": "US",
    "astraDescription": "SMART POST",
    "originLocationNumber": 243,
    "deliveryDate": "2001-04-05",
    "deliveryEligibilities":
    [
    "deliveryEligibilities"
    ],
    "ineligibleForMoneyBackGuarantee": true,
    "maximumTransitTime": "SEVEN_DAYS",
    "destinationLocationStateOrProvinceCode": "GA",
    "astraPlannedServiceLevel": "TUE - 15 OCT 10:30A",
    "destinationLocationId": "DALA",
    "transitTime": "TWO_DAYS",
    "stateOrProvinceCode": "GA",
    "destinationLocationNumber": 876,
    "packagingCode": "03",
    "commitDate": "2019-10-15",
    "publishedDeliveryTime": "10:30A",
    "ursaSuffixCode": "Ga",
    "ursaPrefixCode": "XH",
    "destinationServiceArea": "A1",
    "commitDay": "TUE",
    "customTransitTime": "ONE_DAY"
    },
    "carrierCode": "FDXE",
    "completedHoldAtLocationDetail":
    {
    "holdingLocationType": "FEDEX_STAFFED",
    "holdingLocation":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "tollFreePhoneNumber": "6127812",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "faxNumber": "1234567890",
    "pagerNumber": "6127812",
    "companyName": "Fedex",
    "title": "title"
    }
    }
    },
    "completedEtdDetail":
    {
    "folderId": "0b0493e580dc1a1b",
    "type": "COMMERCIAL_INVOICE",
    "uploadDocumentReferenceDetails":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ]
    },
    "packagingDescription": "description",
    "masterTrackingId":
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    },
    "serviceDescription":
    {
    "serviceType": "FEDEX_1_DAY_FREIGHT",
    "code": "80",
    "names":
    [
    {
    "type": "long",
    "encoding": "UTF-8",
    "value": "F-2"
    }
    ],
    "operatingOrgCodes":
    [
    "FXE"
    ],
    "astraDescription": "2 DAY FRT",
    "description": "description",
    "serviceId": "EP1000000027",
    "serviceCategory": "freight"
    },
    "usDomestic": true,
    "hazardousShipmentDetail":
    {
    "hazardousSummaryDetail":
    {
    "smallQuantityExceptionPackageCount": 10
    },
    "adrLicense":
    {
    "licenseOrPermitDetail":
    {
    "number": "12345",
    "effectiveDate": "2019-08-09",
    "expirationDate": "2019-04-09"
    }
    },
    "dryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68
    },
    "packageCount": 10,
    "processingOptions":
    {
    "options":
    [
    "options"
    ]
    }
    }
    },
    "shipmentRating":
    {
    "actualRateType": "PAYOR_LIST_SHIPMENT",
    "shipmentRateDetails":
    [
    {
    "rateZone": "US001O",
    "ratedWeightMethod": "ACTUAL",
    "totalDutiesTaxesAndFees": 24.56,
    "pricingCode": "LTL_FREIGHT",
    "totalFreightDiscounts": 1.56,
    "totalTaxes": 3.45,
    "totalDutiesAndTaxes": 6.78,
    "totalAncillaryFeesAndTaxes": 5.67,
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalRebates": 1.98,
    "fuelSurchargePercent": 4.56,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "totalNetFreight": 9.56,
    "totalNetFedExCharge": 88.56,
    "shipmentLegRateDetails":
    [
    {
    "rateZone": "rateZone",
    "pricingCode": "pricingCode",
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalDimWeight":
    {
    "units": "KG",
    "value": 68
    },
    "totalRebates": 2,
    "fuelSurchargePercent": 6,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "dimDivisor": 6,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "legDestinationLocationId": "legDestinationLocationId",
    "dimDivisorType": "dimDivisorType",
    "totalBaseCharge": 6,
    "ratedWeightMethod": "ratedWeightMethod",
    "totalFreightDiscounts": 9,
    "totalTaxes": 12.6,
    "minimumChargeType": "minimumChargeType",
    "totalDutiesAndTaxes": 17.78,
    "totalNetFreight": 6,
    "totalNetFedExCharge": 3.2,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 5,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "6702",
    "totalNetCharge": 25.3,
    "totalNetChargeWithDutiesAndTaxes": 25.67,
    "currency": "USD"
    }
    ],
    "dimDivisor": 0,
    "rateType": "RATED_ACCOUNT_SHIPMENT",
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 9.88,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "00000",
    "totalNetCharge": 3.78,
    "totalBaseCharge": 234.56,
    "totalNetChargeWithDutiesAndTaxes": 222.56,
    "currency": "USD"
    }
    ]
    },
    "documentRequirements":
    {
    "requiredDocuments":
    [
    "COMMERCIAL_OR_PRO_FORMA_INVOICE",
    "AIR_WAYBILL"
    ],
    "prohibitedDocuments":
    [
    "CERTIFICATE_OF_ORIGIN"
    ],
    "generationDetails":
    [
    {
    "type": "COMMERCIAL_INVOICE",
    "minimumCopiesRequired": 3,
    "letterhead": "OPTIONAL",
    "electronicSignature": "OPTIONAL"
    }
    ]
    },
    "exportComplianceStatement": "12345678901234567",
    "accessDetail":
    {
    "accessorDetails":
    [
    {
    "password": "password",
    "role": "role",
    "emailLabelUrl": "emailLabelUrl",
    "userId": "userId"
    }
    ]
    }
    },
    "shipmentAdvisoryDetails":
    {
    "regulatoryAdvisory":
    {
    "commodityClarifications":
    [
    {
    "commodityIndex": 25,
    "suggestions":
    [
    {
    "description": "description",
    "harmonizedCode": "harmonized Code"
    }
    ]
    }
    ],
    "prohibitions":
    [
    {
    "derivedHarmonizedCode": "01",
    "advisory":
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    },
    "commodityIndex": 12,
    "source": "source",
    "categories":
    [
    "categories"
    ],
    "type": "type",
    "waiver":
    {
    "advisories":
    [
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    }
    ],
    "description": "description",
    "id": "id"
    },
    "status": "status"
    }
    ]
    }
    },
    "masterTrackingNumber": "794953535000"
    }
  ],
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Modify Open Shipment

This endpoint helps you to modify an Open shipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-modifyOpenShipment
MinimumSamplePayload-modifyOpenShipment

index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
requestedShipment required	object (OpenshipmentRequestedShipment) The detailed transaction data for the requested Open Shipment.
openShipmentAction	string (OpenShipAction) Enum: "STRONG_VALIDATION" "WEAK_VALIDATION" "CREATE_PACKAGE" Indicates the optional actions that can be performed during the modification of packages in Open Shipment. Here are the values: CREATE_PACKAGE - Use CREATE_PACKAGE option to create Open Shipment. STRONG_VALIDATION – Full shipment edits: any edit that fails will cause the transaction to fail. If the transaction is successful, a tracking number may be returned and the transaction will be saved to the database (committed). WEAK_VALIDATION - Full shipment edits: any edit that fails will return errors but the transaction does not fail. The tracking number is returned and the transaction is saved in the database if the core edits are passed. Fix errors with the ModifyRequests transaction using the Index and returned tracking number.
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/openshipments/

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/

Production Server

https://apis.fedex.com/ship/v1/openshipments/

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"requestedShipment":
{
- "shipDatestamp": "2019-10-14",
- "pickupType": "USE_SCHEDULED_PICKUP",
- "serviceType": "PRIORITY_OVERNIGHT",
- "packagingType": "YOUR_PACKAGING",
- "totalWeight": 20.6,
- "shipper":
  {
  - "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "1234567890",
    "companyName": "Fedex"
    },
  - "tins":
    [
    {
    "number": "XXX567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
  },
- "recipients":
  [
  - {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "FedEx"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "deliveryInstructions": "Delivery Instructions"
    }
  ],
- "soldTo":
  {
  - "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "1234567890",
    "companyName": "Fedex"
    },
  - "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
  - "accountNumber":
    {
    "value": "Your account number"
    }
  },
- "origin":
  {
  - "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
  },
- "shippingChargesPayment":
  {
  - "paymentType": "SENDER",
  - "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "XXXX567890",
    "phoneExtension": "phone extension",
    "companyName": "Fedex",
    "faxNumber": "fax number"
    },
    "accountNumber":
    {
    "value": "Your account number"
    }
    }
    }
  },
- "shipmentSpecialServices":
  {
  - "specialServiceTypes":
    [
    "THIRD_PARTY_CONSIGNEE",
    "PROTECTION_FROM_FREEZING"
    ],
  - "etdDetail":
    {
    "attributes":
    [
    "POST_SHIPMENT_UPLOAD_REQUESTED"
    ],
    "attachedDocuments":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ],
    "requestedDocumentTypes":
    [
    "VICS_BILL_OF_LADING",
    "GENERAL_AGENCY_AGREEMENT"
    ]
    },
  - "deliveryOnInvoiceAcceptanceDetail":
    {
    "recipient":
    {
    "address":
    {
    "streetLines":
    [
    "23, RUE JOSEPH-DE MA",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "1234567890",
    "companyName": "Fedex"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "deliveryInstructions": "Delivery Instructions"
    }
    },
  - "internationalTrafficInArmsRegulationsDetail":
    {
    "licenseOrExemptionNumber": "9871234"
    },
  - "holdAtLocationDetail":
    {
    "locationId": "YBZA",
    "locationContactAndAddress":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
    "locationType": "FEDEX_ONSITE"
    },
  - "shipmentCODDetail":
    {
    "addTransportationChargesDetail":
    {
    "rateType": "ACCOUNT",
    "rateLevelType": "BUNDLED_RATE",
    "chargeLevelType": "CURRENT_PACKAGE",
    "chargeType": "COD_SURCHARGE"
    },
    "codRecipient":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
    "remitToName": "remitToName",
    "codCollectionType": "ANY",
    "financialInstitutionContactAndAddress":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "returnReferenceIndicatorType": "INVOICE",
    "shipmentCodAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
  - "shipmentDryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "packageCount": 12
    },
  - "internationalControlledExportDetail":
    {
    "licenseOrPermitExpirationDate": "2019-12-03",
    "licenseOrPermitNumber": "11",
    "entryNumber": "125",
    "foreignTradeZoneCode": "US",
    "type": "WAREHOUSE_WITHDRAWAL"
    },
  - "homeDeliveryPremiumDetail":
    {
    "phoneNumber":
    {
    "areaCode": "901",
    "localNumber": "3575012",
    "extension": "200",
    "personalIdentificationNumber": "98712345"
    },
    "deliveryDate": "2019-06-26",
    "homedeliveryPremiumType": "APPOINTMENT"
    }
  },
- "emailNotificationDetail":
  {
  - "aggregationType": "PER_PACKAGE",
  - "emailNotificationRecipients":
    [
    {
    "name": "Joe Smith",
    "emailNotificationRecipientType": "SHIPPER",
    "emailAddress": "jsmith3@aol.com",
    "notificationFormatType": "TEXT",
    "notificationType": "EMAIL",
    "locale": "en_US",
    "notificationEventType":
    [
    "ON_PICKUP_DRIVER_ARRIVED",
    "ON_SHIPMENT"
    ]
    }
    ],
  - "personalMessage": "your personal message here"
  },
- "expressFreightDetail":
  {
  - "bookingConfirmationNumber": "123456789812",
  - "shippersLoadAndCount": 123,
  - "packingListEnclosed": true
  },
- "variableHandlingChargeDetail":
  {
  - "rateType": "PREFERRED_CURRENCY",
  - "percentValue": 12.45,
  - "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
  - "fixedValue":
    {
    "amount": 24.45,
    "currency": "USD"
    },
  - "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
  },
- "customsClearanceDetail":
  {
  - "regulatoryControls": "NOT_IN_FREE_CIRCULATION",
  - "brokers":
    [
    {
    "broker":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 91,
    "companyName": "Fedex",
    "faxNumber": 1234567
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "deliveryInstructions": "deliveryInstructions"
    },
    "type": "IMPORT"
    }
    ],
  - "commercialInvoice":
    {
    "originatorName": "originator Name",
    "comments":
    [
    "optional comments for the commercial invoice"
    ],
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
    "taxesOrMiscellaneousCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousChargeType": "COMMISSIONS",
    "freightCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "packingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "handlingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "declarationStatement": "declarationStatement",
    "termsOfSale": "FCA",
    "specialInstructions": "specialInstructions\"",
    "shipmentPurpose": "REPAIR_AND_RETURN",
    "emailNotificationDetail":
    {
    "emailAddress": "neena@fedex.com",
    "type": "EMAILED",
    "recipientType": "SHIPPER"
    }
    },
  - "freightOnValue": "OWN_RISK",
  - "dutiesPayment":
    {
    "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "phone extension",
    "companyName": "Fedex",
    "faxNumber": "fax number"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    },
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    }
    },
    "billingDetails":
    {
    "billingCode": "billingCode",
    "billingType": "billingType",
    "aliasId": "aliasId",
    "accountNickname": "accountNickname",
    "accountNumber": "Your account number",
    "accountNumberCountryCode": "US"
    },
    "paymentType": "SENDER"
    },
  - "commodities":
    [
    {
    "unitPrice":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "additionalMeasures":
    [
    {
    "quantity": 12.45,
    "units": "KG"
    }
    ],
    "numberOfPieces": 12,
    "quantity": 125,
    "quantityUnits": "Ea",
    "customsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "countryOfManufacture": "US",
    "cIMarksAndNumbers": "87123",
    "harmonizedCode": "0613",
    "description": "description",
    "name": "non-threaded rivets",
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "exportLicenseNumber": "26456",
    "exportLicenseExpirationDate": "2025-04-06T03:14:39Z",
    "partNumber": "167",
    "purpose": "BUSINESS",
    "usmcaDetail":
    {
    "originCriterion": "A"
    }
    }
    ],
  - "isDocumentOnly": true,
  - "recipientCustomsId":
    {
    "type": "PASSPORT",
    "value": "123"
    },
  - "customsOption":
    {
    "description": "Description",
    "type": "COURTESY_RETURN_LABEL"
    },
  - "importerOfRecord":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
  - "generatedDocumentLocale": "en_US",
  - "exportDetail":
    {
    "destinationControlDetail":
    {
    "endUser": "dest country user",
    "statementTypes": "DEPARTMENT_OF_COMMERCE",
    "destinationCountries":
    [
    "USA",
    "India"
    ]
    },
    "b13AFilingOption": "NOT_REQUIRED",
    "exportComplianceStatement": "12345678901234567",
    "permitNumber": "12345"
    },
  - "totalCustomsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "partiesToTransactionAreRelated": true,
  - "declarationStatementDetail":
    {
    "usmcaLowValueStatementDetail":
    {
    "countryOfOriginLowValueDocumentRequested": true,
    "customsRole": "EXPORTER"
    }
    },
  - "insuranceCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    }
  },
- "smartPostInfoDetail":
  {
  - "ancillaryEndorsement": "RETURN_SERVICE",
  - "hubId": "5015",
  - "indicia": "PRESORTED_STANDARD",
  - "specialServices": "USPS_DELIVERY_CONFIRMATION"
  },
- "blockInsightVisibility": true,
- "rateRequestType":
  [
  - "LIST",
  - "PREFERRED"
  ],
- "preferredCurrency": "USD",
- "requestedPackageLineItems":
  [
  - {
    "sequenceNumber": "1",
    "subPackagingType": "BUCKET",
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
    "declaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
    "groupPackageCount": 2,
    "itemDescriptionForClearance": "description",
    "contentRecord":
    [
    {
    "itemNumber": "2876",
    "receivedQuantity": 256,
    "description": "Description",
    "partNumber": "456"
    }
    ],
    "itemDescription": "item description for the package",
    "variableHandlingChargeDetail":
    {
    "rateType": "PREFERRED_CURRENCY",
    "percentValue": 12.45,
    "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
    "fixedValue":
    {
    "amount": 24.45,
    "currency": "USD"
    },
    "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
    },
    "packageSpecialServices":
    {
    "specialServiceTypes":
    [
    "ALCOHOL",
    "NON_STANDARD_CONTAINER"
    ],
    "signatureOptionType": "SERVICE_DEFAULT",
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
    "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
    }
  ]
},
"openShipmentAction": "CREATE_PACKAGE",
"accountNumber":
{
- "value": "Your account number"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "string",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "asynchronousProcessingResultsDetail": "SYNCHRONOUSLY_PROCESSED",
- "jobId": "abc123456",
- "transactionShipments":
  [
  - {
    "serviceType": "FEDEX_2_DAY_FREIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "serviceName": "FedEx 2 Day Freight",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "completedShipmentDetail":
    {
    "completedPackageDetails":
    [
    {
    "sequenceNumber": 256,
    "operationalDetail":
    {
    "astraHandlingText": "astraHandlingText",
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value": "string"
    }
    ],
    "stringBarcodes":
    [
    {
    "type": "ADDRESS",
    "value": "1010062512241535917900794953544894"
    }
    ]
    },
    "operationalInstructions":
    [
    {
    "number": 17,
    "content": "content"
    }
    ]
    },
    "signatureOption": "DIRECT",
    "trackingIds":
    [
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    }
    ],
    "groupNumber": 567,
    "oversizeClass": "OVERSIZE_1, OVERSIZE_2, OVERSIZE_3",
    "packageRating":
    {
    "effectiveNetDiscount": 0,
    "actualRateType": "PAYOR_ACCOUNT_PACKAGE",
    "packageRateDetails":
    [
    {
    "ratedWeightMethod": "DIM",
    "totalFreightDiscounts": 44.55,
    "totalTaxes": 3.45,
    "minimumChargeType": "minimumChargeType",
    "baseCharge": 45.67,
    "totalRebates": 4.56,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "billingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "netFreight": 4.89,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 22.56,
    "netFedExCharge": 12.56,
    "netCharge": 121.56,
    "currency": "USD"
    }
    ]
    },
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68
    },
    "hazardousPackageDetail":
    {
    "regulation": "IATA",
    "accessibility": "ACCESSIBLE",
    "labelType": "II_YELLOW",
    "containers":
    [
    {
    "qvalue": 2,
    "hazardousCommodities":
    [
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "options":
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "innerReceptacles":
    [
    {
    "quantity":
    {
    "quantityType": "NET",
    "amount": 34.56,
    "units": "Kg"
    }
    }
    ],
    "options":
    {
    "labelTextOption": "APPEND",
    "customerSuppliedLabelText": "Customer Supplied Label Text."
    },
    "description":
    {
    "sequenceNumber": 9812,
    "processingOptions":
    [
    "INCLUDE_SPECIAL_PROVISIONS"
    ],
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "technicalName": "technicalName",
    "packingDetails":
    {
    "packingInstructions": "packing Instructions",
    "cargoAircraftOnly": true
    },
    "authorization": "authorization",
    "reportableQuantity": true,
    "percentage": 12.45,
    "id": "123",
    "packingGroup": "I",
    "properShippingName": "properShippingName",
    "hazardClass": "hazard Class"
    }
    },
    "description":
    {
    "sequenceNumber": 876,
    "packingInstructions": "packingInstructions",
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "tunnelRestrictionCode": "UN2919",
    "specialProvisions": "specialProvisions",
    "properShippingNameAndDescription": "properShippingNameAndDescription",
    "technicalName": "technicalName",
    "symbols": "symbols",
    "authorization": "authorization",
    "attributes":
    [
    "attributes"
    ],
    "id": "1234",
    "packingGroup": "packingGroup",
    "properShippingName": "properShippingName",
    "hazardClass": "hazardClass"
    },
    "netExplosiveDetail":
    {
    "amount": 10,
    "units": "units",
    "type": "NET_EXPLOSIVE_WEIGHT"
    },
    "massPoints": 2
    }
    ]
    }
    ],
    "cargoAircraftOnly": true,
    "referenceId": "123456",
    "radioactiveTransportIndex": 2.45
    }
    }
    ],
    "operationalDetail":
    {
    "originServiceArea": "A1",
    "serviceCode": "010",
    "airportId": "DFW",
    "postalCode": "38010",
    "scac": "scac",
    "deliveryDay": "TUE",
    "originLocationId": "678",
    "countryCode": "US",
    "astraDescription": "SMART POST",
    "originLocationNumber": 243,
    "deliveryDate": "2001-04-05",
    "deliveryEligibilities":
    [
    "deliveryEligibilities"
    ],
    "ineligibleForMoneyBackGuarantee": true,
    "maximumTransitTime": "SEVEN_DAYS",
    "destinationLocationStateOrProvinceCode": "GA",
    "astraPlannedServiceLevel": "TUE - 15 OCT 10:30A",
    "destinationLocationId": "DALA",
    "transitTime": "TWO_DAYS",
    "stateOrProvinceCode": "GA",
    "destinationLocationNumber": 876,
    "packagingCode": "03",
    "commitDate": "2019-10-15",
    "publishedDeliveryTime": "10:30A",
    "ursaSuffixCode": "Ga",
    "ursaPrefixCode": "XH",
    "destinationServiceArea": "A1",
    "commitDay": "TUE",
    "customTransitTime": "ONE_DAY"
    },
    "carrierCode": "FDXE",
    "completedHoldAtLocationDetail":
    {
    "holdingLocationType": "FEDEX_STAFFED",
    "holdingLocation":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "tollFreePhoneNumber": "6127812",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "faxNumber": "1234567890",
    "pagerNumber": "6127812",
    "companyName": "Fedex",
    "title": "title"
    }
    }
    },
    "completedEtdDetail":
    {
    "folderId": "0b0493e580dc1a1b",
    "type": "COMMERCIAL_INVOICE",
    "uploadDocumentReferenceDetails":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ]
    },
    "packagingDescription": "description",
    "masterTrackingId":
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    },
    "serviceDescription":
    {
    "serviceType": "FEDEX_1_DAY_FREIGHT",
    "code": "80",
    "names":
    [
    {
    "type": "long",
    "encoding": "UTF-8",
    "value": "F-2"
    }
    ],
    "operatingOrgCodes":
    [
    "FXE"
    ],
    "astraDescription": "2 DAY FRT",
    "description": "description",
    "serviceId": "EP1000000027",
    "serviceCategory": "freight"
    },
    "usDomestic": true,
    "hazardousShipmentDetail":
    {
    "hazardousSummaryDetail":
    {
    "smallQuantityExceptionPackageCount": 10
    },
    "adrLicense":
    {
    "licenseOrPermitDetail":
    {
    "number": "12345",
    "effectiveDate": "2019-08-09",
    "expirationDate": "2019-04-09"
    }
    },
    "dryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68
    },
    "packageCount": 10,
    "processingOptions":
    {
    "options":
    [
    "options"
    ]
    }
    }
    },
    "shipmentRating":
    {
    "actualRateType": "PAYOR_LIST_SHIPMENT",
    "shipmentRateDetails":
    [
    {
    "rateZone": "US001O",
    "ratedWeightMethod": "ACTUAL",
    "totalDutiesTaxesAndFees": 24.56,
    "pricingCode": "LTL_FREIGHT",
    "totalFreightDiscounts": 1.56,
    "totalTaxes": 3.45,
    "totalDutiesAndTaxes": 6.78,
    "totalAncillaryFeesAndTaxes": 5.67,
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalRebates": 1.98,
    "fuelSurchargePercent": 4.56,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "totalNetFreight": 9.56,
    "totalNetFedExCharge": 88.56,
    "shipmentLegRateDetails":
    [
    {
    "rateZone": "rateZone",
    "pricingCode": "pricingCode",
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalDimWeight":
    {
    "units": "KG",
    "value": 68
    },
    "totalRebates": 2,
    "fuelSurchargePercent": 6,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "dimDivisor": 6,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "legDestinationLocationId": "legDestinationLocationId",
    "dimDivisorType": "dimDivisorType",
    "totalBaseCharge": 6,
    "ratedWeightMethod": "ratedWeightMethod",
    "totalFreightDiscounts": 9,
    "totalTaxes": 12.6,
    "minimumChargeType": "minimumChargeType",
    "totalDutiesAndTaxes": 17.78,
    "totalNetFreight": 6,
    "totalNetFedExCharge": 3.2,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 5,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "6702",
    "totalNetCharge": 25.3,
    "totalNetChargeWithDutiesAndTaxes": 25.67,
    "currency": "USD"
    }
    ],
    "dimDivisor": 0,
    "rateType": "RATED_ACCOUNT_SHIPMENT",
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 9.88,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "00000",
    "totalNetCharge": 3.78,
    "totalBaseCharge": 234.56,
    "totalNetChargeWithDutiesAndTaxes": 222.56,
    "currency": "USD"
    }
    ]
    },
    "documentRequirements":
    {
    "requiredDocuments":
    [
    "COMMERCIAL_OR_PRO_FORMA_INVOICE",
    "AIR_WAYBILL"
    ],
    "prohibitedDocuments":
    [
    "CERTIFICATE_OF_ORIGIN"
    ],
    "generationDetails":
    [
    {
    "type": "COMMERCIAL_INVOICE",
    "minimumCopiesRequired": 3,
    "letterhead": "OPTIONAL",
    "electronicSignature": "OPTIONAL"
    }
    ]
    },
    "exportComplianceStatement": "12345678901234567",
    "accessDetail":
    {
    "accessorDetails":
    [
    {
    "password": "password",
    "role": "role",
    "emailLabelUrl": "emailLabelUrl",
    "userId": "userId"
    }
    ]
    }
    },
    "shipmentAdvisoryDetails":
    {
    "regulatoryAdvisory":
    {
    "commodityClarifications":
    [
    {
    "commodityIndex": 25,
    "suggestions":
    [
    {
    "description": "description",
    "harmonizedCode": "harmonized Code"
    }
    ]
    }
    ],
    "prohibitions":
    [
    {
    "derivedHarmonizedCode": "01",
    "advisory":
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    },
    "commodityIndex": 12,
    "source": "source",
    "categories":
    [
    "categories"
    ],
    "type": "type",
    "waiver":
    {
    "advisories":
    [
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    }
    ],
    "description": "description",
    "id": "id"
    },
    "status": "status"
    }
    ]
    }
    },
    "masterTrackingNumber": "794953535000"
    }
  ],
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Confirm Open Shipment

Use this endpoint to validate and upload the Open Ship shipment data to FedEx Systems once all packages are added in the Shipment request.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-confirmOpenShipment
MinimumSamplePayload-confirmOpenShipment

labelResponseOptions required	string (LABELRESPONSEOPTIONS) Enum: "URL_ONLY" "LABEL" Specify whether the encoded bytecode or the label URL to be returned in the response. Valid values: LABEL – Indicates request is for encoded bytecode. URL_ONLY – Indicates label URL request. Note: For asynchronous shipment (More than 40 packages) request only the value LABEL is suported. Note: With URL_ONLY option, the URL once created will be active for 12 hours.
edtRequestType	string Enum: "ALL" "NONE" Indicate whether to have estimated duties and taxes provided with the rate quotes on this shipment. Only applies for International Shipment.
labelSpecification required	object (LabelSpecification) These are label specification details includes the image type, printer format, and label stock for label. Can also specify specific details such as doc-tab content, regulatory labels, and masking data on the label.
index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
shippingDocumentSpecification	object (ShippingDocumentSpecification) Use this object to provide all data required for additional (non-label) shipping documents to be produced.
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/

Production Server

https://apis.fedex.com/ship/v1/openshipments/

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all

{

"labelResponseOptions": "LABEL",
"edtRequestType": "ALL",
"labelSpecification":
{
- "labelFormatType": "COMMON2D",
- "labelOrder": "SHIPPING_LABEL_FIRST",
- "customerSpecifiedDetail":
  {
  - "maskedData":
    [
    "[\"CUSTOMS_VALUE\",\"TOTAL_WEIGHT\"]"
    ],
  - "regulatoryLabels":
    [
    {
    "generationOptions": "CONTENT_ON_SHIPPING_LABEL_ONLY",
    "type": "ALCOHOL_SHIPMENT_LABEL"
    }
    ],
  - "additionalLabels":
    [
    {
    "type": "CONSIGNEE",
    "count": 1
    }
    ],
  - "docTabContent":
    {
    "docTabContentType": "BARCODED",
    "zone001":
    {
    "docTabZoneSpecifications":
    [
    {
    "zoneNumber": 0,
    "header": "string",
    "dataField": "string",
    "literalValue": "string",
    "justification": "RIGHT"
    }
    ]
    },
    "barcoded":
    {
    "symbology": "UCC128",
    "specification":
    {
    "zoneNumber": 0,
    "header": "string",
    "dataField": "string",
    "literalValue": "string",
    "justification": "RIGHT"
    }
    }
    }
  },
- "printedLabelOrigin":
  {
  - "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
  },
- "labelStockType": "PAPER_85X11_TOP_HALF_LABEL",
- "labelRotation": "UPSIDE_DOWN",
- "imageType": "PDF",
- "labelPrintingOrientation": "TOP_EDGE_OF_TEXT_FIRST",
- "returnedDispositionDetail": true,
- "resolution": 300
},
"index": "Test1234",
"shippingDocumentSpecification":
{
- "generalAgencyAgreementDetail":
  {
  - "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
  },
- "returnInstructionsDetail":
  {
  - "customText": "This is additional text printed on Return instr",
  - "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US\"",
    "docType": "PNG"
    }
  },
- "op900Detail":
  {
  - "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
  - "signatureName": "Signature Name",
  - "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
  },
- "usmcaCertificationOfOriginDetail":
  {
  - "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
  - "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    },
  - "certifierSpecification": "EXPORTER",
  - "importerSpecification": "UNKNOWN",
  - "producerSpecification": "SAME_AS_EXPORTER",
  - "producer":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
  - "blanketPeriod":
    {
    "begins": "22-01-2020",
    "ends": "2-01-2020"
    },
  - "certifierJobTitle": "Manager"
  },
- "usmcaCommercialInvoiceCertificationOfOriginDetail":
  {
  - "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
  - "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    },
  - "certifierSpecification": "EXPORTER",
  - "importerSpecification": "UNKNOWN",
  - "producerSpecification": "SAME_AS_EXPORTER",
  - "producer":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
  - "certifierJobTitle": "Manager"
  },
- "shippingDocumentTypes":
  [
  - "RETURN_INSTRUCTIONS"
  ],
- "certificateOfOrigin":
  {
  - "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
  - "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
  },
- "commercialInvoiceDetail":
  {
  - "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
  - "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
  }
},
"accountNumber":
{
- "value": "Your account number"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "string",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "jobId": "abc123456",
- "transactionShipments":
  [
  - {
    "serviceType": "STANDARD_OVERNIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "shipmentDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "pieceResponses":
    [
    {
    "netChargeAmount": 21.45,
    "transactionDetails":
    [
    {
    "transactionDetails": "transactionDetails",
    "transactionId": "12345"
    }
    ],
    "packageDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "acceptanceTrackingNumber": "794953535000",
    "serviceCategory": "EXPRESS",
    "listCustomerTotalCharge": "listCustomerTotalCharge",
    "deliveryTimestamp": "2012-09-23",
    "trackingIdType": "FEDEX",
    "additionalChargesDiscount": 621.45,
    "netListRateAmount": 1.45,
    "baseRateAmount": 321.45,
    "packageSequenceNumber": 215,
    "netDiscountAmount": 121.45,
    "codcollectionAmount": 231.45,
    "masterTrackingNumber": "794953535000",
    "acceptanceType": "acceptanceType",
    "trackingNumber": "794953535000",
    "successful": true,
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ]
    }
    ],
    "serviceName": "FedEx 2 Day Freight",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "completedShipmentDetail":
    {
    "completedPackageDetails":
    [
    {
    "sequenceNumber": 256,
    "operationalDetail":
    {
    "astraHandlingText": "astraHandlingText",
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value": "string"
    }
    ],
    "stringBarcodes":
    [
    {
    "type": "ADDRESS",
    "value": "1010062512241535917900794953544894"
    }
    ]
    },
    "operationalInstructions":
    [
    {
    "number": 17,
    "content": "content"
    }
    ]
    },
    "signatureOption": "DIRECT",
    "trackingIds":
    [
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    }
    ],
    "groupNumber": 567,
    "oversizeClass": "OVERSIZE_1, OVERSIZE_2, OVERSIZE_3",
    "packageRating":
    {
    "effectiveNetDiscount": 0,
    "actualRateType": "PAYOR_ACCOUNT_PACKAGE",
    "packageRateDetails":
    [
    {
    "ratedWeightMethod": "DIM",
    "totalFreightDiscounts": 44.55,
    "totalTaxes": 3.45,
    "minimumChargeType": "minimumChargeType",
    "baseCharge": 45.67,
    "totalRebates": 4.56,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "billingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "netFreight": 4.89,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 22.56,
    "netFedExCharge": 12.56,
    "netCharge": 121.56,
    "currency": "USD"
    }
    ]
    },
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68
    },
    "hazardousPackageDetail":
    {
    "regulation": "IATA",
    "accessibility": "ACCESSIBLE",
    "labelType": "II_YELLOW",
    "containers":
    [
    {
    "qvalue": 2,
    "hazardousCommodities":
    [
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "options":
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "innerReceptacles":
    [
    {
    "quantity":
    {
    "quantityType": "NET",
    "amount": 34.56,
    "units": "Kg"
    }
    }
    ],
    "options":
    {
    "labelTextOption": "APPEND",
    "customerSuppliedLabelText": "Customer Supplied Label Text."
    },
    "description":
    {
    "sequenceNumber": 9812,
    "processingOptions":
    [
    "INCLUDE_SPECIAL_PROVISIONS"
    ],
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "technicalName": "technicalName",
    "packingDetails":
    {
    "packingInstructions": "packing Instructions",
    "cargoAircraftOnly": true
    },
    "authorization": "authorization",
    "reportableQuantity": true,
    "percentage": 12.45,
    "id": "123",
    "packingGroup": "I",
    "properShippingName": "properShippingName",
    "hazardClass": "hazard Class"
    }
    },
    "description":
    {
    "sequenceNumber": 876,
    "packingInstructions": "packingInstructions",
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "tunnelRestrictionCode": "UN2919",
    "specialProvisions": "specialProvisions",
    "properShippingNameAndDescription": "properShippingNameAndDescription",
    "technicalName": "technicalName",
    "symbols": "symbols",
    "authorization": "authorization",
    "attributes":
    [
    "attributes"
    ],
    "id": "1234",
    "packingGroup": "packingGroup",
    "properShippingName": "properShippingName",
    "hazardClass": "hazardClass"
    },
    "netExplosiveDetail":
    {
    "amount": 10,
    "units": "units",
    "type": "NET_EXPLOSIVE_WEIGHT"
    },
    "massPoints": 2
    }
    ]
    }
    ],
    "cargoAircraftOnly": true,
    "referenceId": "123456",
    "radioactiveTransportIndex": 2.45
    }
    }
    ],
    "operationalDetail":
    {
    "originServiceArea": "A1",
    "serviceCode": "010",
    "airportId": "DFW",
    "postalCode": "38010",
    "scac": "scac",
    "deliveryDay": "TUE",
    "originLocationId": "678",
    "countryCode": "US",
    "astraDescription": "SMART POST",
    "originLocationNumber": 243,
    "deliveryDate": "2001-04-05",
    "deliveryEligibilities":
    [
    "deliveryEligibilities"
    ],
    "ineligibleForMoneyBackGuarantee": true,
    "maximumTransitTime": "SEVEN_DAYS",
    "destinationLocationStateOrProvinceCode": "GA",
    "astraPlannedServiceLevel": "TUE - 15 OCT 10:30A",
    "destinationLocationId": "DALA",
    "transitTime": "TWO_DAYS",
    "stateOrProvinceCode": "GA",
    "destinationLocationNumber": 876,
    "packagingCode": "03",
    "commitDate": "2019-10-15",
    "publishedDeliveryTime": "10:30A",
    "ursaSuffixCode": "Ga",
    "ursaPrefixCode": "XH",
    "destinationServiceArea": "A1",
    "commitDay": "TUE",
    "customTransitTime": "ONE_DAY"
    },
    "carrierCode": "FDXE",
    "completedHoldAtLocationDetail":
    {
    "holdingLocationType": "FEDEX_STAFFED",
    "holdingLocation":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "tollFreePhoneNumber": "6127812",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "faxNumber": "1234567890",
    "pagerNumber": "6127812",
    "companyName": "Fedex",
    "title": "title"
    }
    }
    },
    "completedEtdDetail":
    {
    "folderId": "0b0493e580dc1a1b",
    "type": "COMMERCIAL_INVOICE",
    "uploadDocumentReferenceDetails":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ]
    },
    "packagingDescription": "description",
    "masterTrackingId":
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    },
    "serviceDescription":
    {
    "serviceType": "FEDEX_1_DAY_FREIGHT",
    "code": "80",
    "names":
    [
    {
    "type": "long",
    "encoding": "UTF-8",
    "value": "F-2"
    }
    ],
    "operatingOrgCodes":
    [
    "FXE"
    ],
    "astraDescription": "2 DAY FRT",
    "description": "description",
    "serviceId": "EP1000000027",
    "serviceCategory": "freight"
    },
    "usDomestic": true,
    "hazardousShipmentDetail":
    {
    "hazardousSummaryDetail":
    {
    "smallQuantityExceptionPackageCount": 10
    },
    "adrLicense":
    {
    "licenseOrPermitDetail":
    {
    "number": "12345",
    "effectiveDate": "2019-08-09",
    "expirationDate": "2019-04-09"
    }
    },
    "dryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68
    },
    "packageCount": 10,
    "processingOptions":
    {
    "options":
    [
    "options"
    ]
    }
    }
    },
    "shipmentRating":
    {
    "actualRateType": "PAYOR_LIST_SHIPMENT",
    "shipmentRateDetails":
    [
    {
    "rateZone": "US001O",
    "ratedWeightMethod": "ACTUAL",
    "totalDutiesTaxesAndFees": 24.56,
    "pricingCode": "LTL_FREIGHT",
    "totalFreightDiscounts": 1.56,
    "totalTaxes": 3.45,
    "totalDutiesAndTaxes": 6.78,
    "totalAncillaryFeesAndTaxes": 5.67,
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalRebates": 1.98,
    "fuelSurchargePercent": 4.56,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "totalNetFreight": 9.56,
    "totalNetFedExCharge": 88.56,
    "shipmentLegRateDetails":
    [
    {
    "rateZone": "rateZone",
    "pricingCode": "pricingCode",
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalDimWeight":
    {
    "units": "KG",
    "value": 68
    },
    "totalRebates": 2,
    "fuelSurchargePercent": 6,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "dimDivisor": 6,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "legDestinationLocationId": "legDestinationLocationId",
    "dimDivisorType": "dimDivisorType",
    "totalBaseCharge": 6,
    "ratedWeightMethod": "ratedWeightMethod",
    "totalFreightDiscounts": 9,
    "totalTaxes": 12.6,
    "minimumChargeType": "minimumChargeType",
    "totalDutiesAndTaxes": 17.78,
    "totalNetFreight": 6,
    "totalNetFedExCharge": 3.2,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 5,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "6702",
    "totalNetCharge": 25.3,
    "totalNetChargeWithDutiesAndTaxes": 25.67,
    "currency": "USD"
    }
    ],
    "dimDivisor": 0,
    "rateType": "RATED_ACCOUNT_SHIPMENT",
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 9.88,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "00000",
    "totalNetCharge": 3.78,
    "totalBaseCharge": 234.56,
    "totalNetChargeWithDutiesAndTaxes": 222.56,
    "currency": "USD"
    }
    ]
    },
    "documentRequirements":
    {
    "requiredDocuments":
    [
    "COMMERCIAL_OR_PRO_FORMA_INVOICE",
    "AIR_WAYBILL"
    ],
    "prohibitedDocuments":
    [
    "CERTIFICATE_OF_ORIGIN"
    ],
    "generationDetails":
    [
    {
    "type": "COMMERCIAL_INVOICE",
    "minimumCopiesRequired": 3,
    "letterhead": "OPTIONAL",
    "electronicSignature": "OPTIONAL"
    }
    ]
    },
    "exportComplianceStatement": "12345678901234567",
    "accessDetail":
    {
    "accessorDetails":
    [
    {
    "password": "password",
    "role": "role",
    "emailLabelUrl": "emailLabelUrl",
    "userId": "userId"
    }
    ]
    }
    },
    "shipmentAdvisoryDetails":
    {
    "regulatoryAdvisory":
    {
    "commodityClarifications":
    [
    {
    "commodityIndex": 25,
    "suggestions":
    [
    {
    "description": "description",
    "harmonizedCode": "harmonized Code"
    }
    ]
    }
    ],
    "prohibitions":
    [
    {
    "derivedHarmonizedCode": "01",
    "advisory":
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    },
    "commodityIndex": 12,
    "source": "source",
    "categories":
    [
    "categories"
    ],
    "type": "type",
    "waiver":
    {
    "advisories":
    [
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    }
    ],
    "description": "description",
    "id": "id"
    },
    "status": "status"
    }
    ]
    }
    },
    "masterTrackingNumber": "794953535000"
    }
  ],
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Modify Open Shipment Packages

This endpoint helps you to modify packages in Open Shipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-modifyPackageInOpenShipment
MinimumSamplePayload-modifyPackageInOpenShipment

requestedPackageLineItem required	object Contains the data for the package that is to be modified in the open shipment.
index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
shipAction	string Enum: "STRONG_VALIDATION" "WEAK_VALIDATION" "CREATE_PACKAGE" Allowed values are STRONG_VALIDATION
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number
trackingId required	object (TrackingId) Indicates the tracking details for the package.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/openshipments/packages

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/packages

Production Server

https://apis.fedex.com/ship/v1/openshipments/packages

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"requestedPackageLineItem":
{
- "sequenceNumber": "1",
- "subPackagingType": "BUCKET",
- "customerReferences":
  [
  - {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
  ],
- "declaredValue":
  {
  - "amount": 12.45,
  - "currency": "USD"
  },
- "weight":
  {
  - "units": "KG",
  - "value": 68.25
  },
- "dimensions":
  {
  - "length": 100,
  - "width": 50,
  - "height": 30,
  - "units": "CM"
  },
- "groupPackageCount": 2,
- "itemDescriptionForClearance": "description",
- "contentRecord":
  [
  - {
    "itemNumber": "2876",
    "receivedQuantity": 256,
    "description": "Description",
    "partNumber": "456"
    }
  ],
- "itemDescription": "item description for the package",
- "variableHandlingChargeDetail":
  {
  - "rateType": "PREFERRED_CURRENCY",
  - "percentValue": 12.45,
  - "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
  - "fixedValue":
    {
    "amount": 24.45,
    "currency": "USD"
    },
  - "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
  },
- "packageSpecialServices":
  {
  - "specialServiceTypes":
    [
    "ALCOHOL",
    "NON_STANDARD_CONTAINER"
    ],
  - "signatureOptionType": "SERVICE_DEFAULT",
  - "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
  - "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
  - "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
  - "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
  - "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
  - "pieceCountVerificationBoxCount": 0,
  - "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
  - "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
  - "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
  }
},
"index": "Test1234",
"shipAction": "STRONG_VALIDATION",
"accountNumber":
{
- "value": "Your account number"
},
"trackingId":
{
- "formId": "0201",
- "trackingIdType": "EXPRESS",
- "uspsApplicationId": "92",
- "trackingNumber": "49092000070120032835"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "transactionShipments":
  [
  - {
    "serviceType": "STANDARD_OVERNIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "shipmentDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "pieceResponses":
    [
    {
    "netChargeAmount": 21.45,
    "transactionDetails":
    [
    {
    "transactionDetails": "transactionDetails",
    "transactionId": "12345"
    }
    ],
    "packageDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "acceptanceTrackingNumber": "794953535000",
    "serviceCategory": "EXPRESS",
    "listCustomerTotalCharge": "listCustomerTotalCharge",
    "deliveryTimestamp": "2012-09-23",
    "trackingIdType": "FEDEX",
    "additionalChargesDiscount": 621.45,
    "netListRateAmount": 1.45,
    "baseRateAmount": 321.45,
    "packageSequenceNumber": 215,
    "netDiscountAmount": 121.45,
    "codcollectionAmount": 231.45,
    "masterTrackingNumber": "794953535000",
    "acceptanceType": "acceptanceType",
    "trackingNumber": "794953535000",
    "successful": true,
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ]
    }
    ],
    "serviceName": "FedEx 2 Day Freight",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "completedShipmentDetail":
    {
    "completedPackageDetails":
    [
    {
    "sequenceNumber": 256,
    "operationalDetail":
    {
    "astraHandlingText": "astraHandlingText",
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value": "string"
    }
    ],
    "stringBarcodes":
    [
    {
    "type": "ADDRESS",
    "value": "1010062512241535917900794953544894"
    }
    ]
    },
    "operationalInstructions":
    [
    {
    "number": 17,
    "content": "content"
    }
    ]
    },
    "signatureOption": "DIRECT",
    "trackingIds":
    [
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    }
    ],
    "groupNumber": 567,
    "oversizeClass": "OVERSIZE_1, OVERSIZE_2, OVERSIZE_3",
    "packageRating":
    {
    "effectiveNetDiscount": 0,
    "actualRateType": "PAYOR_ACCOUNT_PACKAGE",
    "packageRateDetails":
    [
    {
    "ratedWeightMethod": "DIM",
    "totalFreightDiscounts": 44.55,
    "totalTaxes": 3.45,
    "minimumChargeType": "minimumChargeType",
    "baseCharge": 45.67,
    "totalRebates": 4.56,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "billingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "netFreight": 4.89,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 22.56,
    "netFedExCharge": 12.56,
    "netCharge": 121.56,
    "currency": "USD"
    }
    ]
    },
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68
    },
    "hazardousPackageDetail":
    {
    "regulation": "IATA",
    "accessibility": "ACCESSIBLE",
    "labelType": "II_YELLOW",
    "containers":
    [
    {
    "qvalue": 2,
    "hazardousCommodities":
    [
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "options":
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "innerReceptacles":
    [
    {
    "quantity":
    {
    "quantityType": "NET",
    "amount": 34.56,
    "units": "Kg"
    }
    }
    ],
    "options":
    {
    "labelTextOption": "APPEND",
    "customerSuppliedLabelText": "Customer Supplied Label Text."
    },
    "description":
    {
    "sequenceNumber": 9812,
    "processingOptions":
    [
    "INCLUDE_SPECIAL_PROVISIONS"
    ],
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "technicalName": "technicalName",
    "packingDetails":
    {
    "packingInstructions": "packing Instructions",
    "cargoAircraftOnly": true
    },
    "authorization": "authorization",
    "reportableQuantity": true,
    "percentage": 12.45,
    "id": "123",
    "packingGroup": "I",
    "properShippingName": "properShippingName",
    "hazardClass": "hazard Class"
    }
    },
    "description":
    {
    "sequenceNumber": 876,
    "packingInstructions": "packingInstructions",
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "tunnelRestrictionCode": "UN2919",
    "specialProvisions": "specialProvisions",
    "properShippingNameAndDescription": "properShippingNameAndDescription",
    "technicalName": "technicalName",
    "symbols": "symbols",
    "authorization": "authorization",
    "attributes":
    [
    "attributes"
    ],
    "id": "1234",
    "packingGroup": "packingGroup",
    "properShippingName": "properShippingName",
    "hazardClass": "hazardClass"
    },
    "netExplosiveDetail":
    {
    "amount": 10,
    "units": "units",
    "type": "NET_EXPLOSIVE_WEIGHT"
    },
    "massPoints": 2
    }
    ]
    }
    ],
    "cargoAircraftOnly": true,
    "referenceId": "123456",
    "radioactiveTransportIndex": 2.45
    }
    }
    ],
    "operationalDetail":
    {
    "originServiceArea": "A1",
    "serviceCode": "010",
    "airportId": "DFW",
    "postalCode": "38010",
    "scac": "scac",
    "deliveryDay": "TUE",
    "originLocationId": "678",
    "countryCode": "US",
    "astraDescription": "SMART POST",
    "originLocationNumber": 243,
    "deliveryDate": "2001-04-05",
    "deliveryEligibilities":
    [
    "deliveryEligibilities"
    ],
    "ineligibleForMoneyBackGuarantee": true,
    "maximumTransitTime": "SEVEN_DAYS",
    "destinationLocationStateOrProvinceCode": "GA",
    "astraPlannedServiceLevel": "TUE - 15 OCT 10:30A",
    "destinationLocationId": "DALA",
    "transitTime": "TWO_DAYS",
    "stateOrProvinceCode": "GA",
    "destinationLocationNumber": 876,
    "packagingCode": "03",
    "commitDate": "2019-10-15",
    "publishedDeliveryTime": "10:30A",
    "ursaSuffixCode": "Ga",
    "ursaPrefixCode": "XH",
    "destinationServiceArea": "A1",
    "commitDay": "TUE",
    "customTransitTime": "ONE_DAY"
    },
    "carrierCode": "FDXE",
    "completedHoldAtLocationDetail":
    {
    "holdingLocationType": "FEDEX_STAFFED",
    "holdingLocation":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "tollFreePhoneNumber": "6127812",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "faxNumber": "1234567890",
    "pagerNumber": "6127812",
    "companyName": "Fedex",
    "title": "title"
    }
    }
    },
    "completedEtdDetail":
    {
    "folderId": "0b0493e580dc1a1b",
    "type": "COMMERCIAL_INVOICE",
    "uploadDocumentReferenceDetails":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ]
    },
    "packagingDescription": "description",
    "masterTrackingId":
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    },
    "serviceDescription":
    {
    "serviceType": "FEDEX_1_DAY_FREIGHT",
    "code": "80",
    "names":
    [
    {
    "type": "long",
    "encoding": "UTF-8",
    "value": "F-2"
    }
    ],
    "operatingOrgCodes":
    [
    "FXE"
    ],
    "astraDescription": "2 DAY FRT",
    "description": "description",
    "serviceId": "EP1000000027",
    "serviceCategory": "freight"
    },
    "usDomestic": true,
    "hazardousShipmentDetail":
    {
    "hazardousSummaryDetail":
    {
    "smallQuantityExceptionPackageCount": 10
    },
    "adrLicense":
    {
    "licenseOrPermitDetail":
    {
    "number": "12345",
    "effectiveDate": "2019-08-09",
    "expirationDate": "2019-04-09"
    }
    },
    "dryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68
    },
    "packageCount": 10,
    "processingOptions":
    {
    "options":
    [
    "options"
    ]
    }
    }
    },
    "shipmentRating":
    {
    "actualRateType": "PAYOR_LIST_SHIPMENT",
    "shipmentRateDetails":
    [
    {
    "rateZone": "US001O",
    "ratedWeightMethod": "ACTUAL",
    "totalDutiesTaxesAndFees": 24.56,
    "pricingCode": "LTL_FREIGHT",
    "totalFreightDiscounts": 1.56,
    "totalTaxes": 3.45,
    "totalDutiesAndTaxes": 6.78,
    "totalAncillaryFeesAndTaxes": 5.67,
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalRebates": 1.98,
    "fuelSurchargePercent": 4.56,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "totalNetFreight": 9.56,
    "totalNetFedExCharge": 88.56,
    "shipmentLegRateDetails":
    [
    {
    "rateZone": "rateZone",
    "pricingCode": "pricingCode",
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalDimWeight":
    {
    "units": "KG",
    "value": 68
    },
    "totalRebates": 2,
    "fuelSurchargePercent": 6,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "dimDivisor": 6,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "legDestinationLocationId": "legDestinationLocationId",
    "dimDivisorType": "dimDivisorType",
    "totalBaseCharge": 6,
    "ratedWeightMethod": "ratedWeightMethod",
    "totalFreightDiscounts": 9,
    "totalTaxes": 12.6,
    "minimumChargeType": "minimumChargeType",
    "totalDutiesAndTaxes": 17.78,
    "totalNetFreight": 6,
    "totalNetFedExCharge": 3.2,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 5,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "6702",
    "totalNetCharge": 25.3,
    "totalNetChargeWithDutiesAndTaxes": 25.67,
    "currency": "USD"
    }
    ],
    "dimDivisor": 0,
    "rateType": "RATED_ACCOUNT_SHIPMENT",
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 9.88,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "00000",
    "totalNetCharge": 3.78,
    "totalBaseCharge": 234.56,
    "totalNetChargeWithDutiesAndTaxes": 222.56,
    "currency": "USD"
    }
    ]
    },
    "documentRequirements":
    {
    "requiredDocuments":
    [
    "COMMERCIAL_OR_PRO_FORMA_INVOICE",
    "AIR_WAYBILL"
    ],
    "prohibitedDocuments":
    [
    "CERTIFICATE_OF_ORIGIN"
    ],
    "generationDetails":
    [
    {
    "type": "COMMERCIAL_INVOICE",
    "minimumCopiesRequired": 3,
    "letterhead": "OPTIONAL",
    "electronicSignature": "OPTIONAL"
    }
    ]
    },
    "exportComplianceStatement": "12345678901234567",
    "accessDetail":
    {
    "accessorDetails":
    [
    {
    "password": "password",
    "role": "role",
    "emailLabelUrl": "emailLabelUrl",
    "userId": "userId"
    }
    ]
    }
    },
    "shipmentAdvisoryDetails":
    {
    "regulatoryAdvisory":
    {
    "commodityClarifications":
    [
    {
    "commodityIndex": 25,
    "suggestions":
    [
    {
    "description": "description",
    "harmonizedCode": "harmonized Code"
    }
    ]
    }
    ],
    "prohibitions":
    [
    {
    "derivedHarmonizedCode": "01",
    "advisory":
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    },
    "commodityIndex": 12,
    "source": "source",
    "categories":
    [
    "categories"
    ],
    "type": "type",
    "waiver":
    {
    "advisories":
    [
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    }
    ],
    "description": "description",
    "id": "id"
    },
    "status": "status"
    }
    ]
    }
    },
    "masterTrackingNumber": "794953535000"
    }
  ],
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Add Open Shipment Packages

This endpoint helps you to add packages to Open Shipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-addPackagesToOpenShipment
MinimumSamplePayload-addPackagesInOpenShipment

index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
shipAction	string Enum: "CONFIRM" "TRANSFER" There are Ship actions as part of processing the shipment.
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number
requestedPackageLineItems required	Array of objects (RequestedPackageLineItem) These are package line item details in the shipment.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/packages

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/packages

Production Server

https://apis.fedex.com/ship/v1/openshipments/packages

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"shipAction": "STRONG_VALIDATION",
"accountNumber":
{
- "value": "Your account number"
},
"requestedPackageLineItems":
[
- {
  - "sequenceNumber": "1",
  - "subPackagingType": "BUCKET",
  - "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
  - "declaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "weight":
    {
    "units": "KG",
    "value": 68.25
    },
  - "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
  - "groupPackageCount": 2,
  - "itemDescriptionForClearance": "description",
  - "contentRecord":
    [
    {
    "itemNumber": "2876",
    "receivedQuantity": 256,
    "description": "Description",
    "partNumber": "456"
    }
    ],
  - "itemDescription": "item description for the package",
  - "variableHandlingChargeDetail":
    {
    "rateType": "PREFERRED_CURRENCY",
    "percentValue": 12.45,
    "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
    "fixedValue":
    {
    "amount": 24.45,
    "currency": "USD"
    },
    "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
    },
  - "packageSpecialServices":
    {
    "specialServiceTypes":
    [
    "ALCOHOL",
    "NON_STANDARD_CONTAINER"
    ],
    "signatureOptionType": "SERVICE_DEFAULT",
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
    "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
  }
]

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "transactionShipments":
  [
  - {
    "serviceType": "STANDARD_OVERNIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "shipmentDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "pieceResponses":
    [
    {
    "netChargeAmount": 21.45,
    "transactionDetails":
    [
    {
    "transactionDetails": "transactionDetails",
    "transactionId": "12345"
    }
    ],
    "packageDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "acceptanceTrackingNumber": "794953535000",
    "serviceCategory": "EXPRESS",
    "listCustomerTotalCharge": "listCustomerTotalCharge",
    "deliveryTimestamp": "2012-09-23",
    "trackingIdType": "FEDEX",
    "additionalChargesDiscount": 621.45,
    "netListRateAmount": 1.45,
    "baseRateAmount": 321.45,
    "packageSequenceNumber": 215,
    "netDiscountAmount": 121.45,
    "codcollectionAmount": 231.45,
    "masterTrackingNumber": "794953535000",
    "acceptanceType": "acceptanceType",
    "trackingNumber": "794953535000",
    "successful": true,
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ]
    }
    ],
    "serviceName": "FedEx 2 Day Freight",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "completedShipmentDetail":
    {
    "completedPackageDetails":
    [
    {
    "sequenceNumber": 256,
    "operationalDetail":
    {
    "astraHandlingText": "astraHandlingText",
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value": "string"
    }
    ],
    "stringBarcodes":
    [
    {
    "type": "ADDRESS",
    "value": "1010062512241535917900794953544894"
    }
    ]
    },
    "operationalInstructions":
    [
    {
    "number": 17,
    "content": "content"
    }
    ]
    },
    "signatureOption": "DIRECT",
    "trackingIds":
    [
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    }
    ],
    "groupNumber": 567,
    "oversizeClass": "OVERSIZE_1, OVERSIZE_2, OVERSIZE_3",
    "packageRating":
    {
    "effectiveNetDiscount": 0,
    "actualRateType": "PAYOR_ACCOUNT_PACKAGE",
    "packageRateDetails":
    [
    {
    "ratedWeightMethod": "DIM",
    "totalFreightDiscounts": 44.55,
    "totalTaxes": 3.45,
    "minimumChargeType": "minimumChargeType",
    "baseCharge": 45.67,
    "totalRebates": 4.56,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "billingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "netFreight": 4.89,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 22.56,
    "netFedExCharge": 12.56,
    "netCharge": 121.56,
    "currency": "USD"
    }
    ]
    },
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68
    },
    "hazardousPackageDetail":
    {
    "regulation": "IATA",
    "accessibility": "ACCESSIBLE",
    "labelType": "II_YELLOW",
    "containers":
    [
    {
    "qvalue": 2,
    "hazardousCommodities":
    [
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "options":
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "innerReceptacles":
    [
    {
    "quantity":
    {
    "quantityType": "NET",
    "amount": 34.56,
    "units": "Kg"
    }
    }
    ],
    "options":
    {
    "labelTextOption": "APPEND",
    "customerSuppliedLabelText": "Customer Supplied Label Text."
    },
    "description":
    {
    "sequenceNumber": 9812,
    "processingOptions":
    [
    "INCLUDE_SPECIAL_PROVISIONS"
    ],
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "technicalName": "technicalName",
    "packingDetails":
    {
    "packingInstructions": "packing Instructions",
    "cargoAircraftOnly": true
    },
    "authorization": "authorization",
    "reportableQuantity": true,
    "percentage": 12.45,
    "id": "123",
    "packingGroup": "I",
    "properShippingName": "properShippingName",
    "hazardClass": "hazard Class"
    }
    },
    "description":
    {
    "sequenceNumber": 876,
    "packingInstructions": "packingInstructions",
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "tunnelRestrictionCode": "UN2919",
    "specialProvisions": "specialProvisions",
    "properShippingNameAndDescription": "properShippingNameAndDescription",
    "technicalName": "technicalName",
    "symbols": "symbols",
    "authorization": "authorization",
    "attributes":
    [
    "attributes"
    ],
    "id": "1234",
    "packingGroup": "packingGroup",
    "properShippingName": "properShippingName",
    "hazardClass": "hazardClass"
    },
    "netExplosiveDetail":
    {
    "amount": 10,
    "units": "units",
    "type": "NET_EXPLOSIVE_WEIGHT"
    },
    "massPoints": 2
    }
    ]
    }
    ],
    "cargoAircraftOnly": true,
    "referenceId": "123456",
    "radioactiveTransportIndex": 2.45
    }
    }
    ],
    "operationalDetail":
    {
    "originServiceArea": "A1",
    "serviceCode": "010",
    "airportId": "DFW",
    "postalCode": "38010",
    "scac": "scac",
    "deliveryDay": "TUE",
    "originLocationId": "678",
    "countryCode": "US",
    "astraDescription": "SMART POST",
    "originLocationNumber": 243,
    "deliveryDate": "2001-04-05",
    "deliveryEligibilities":
    [
    "deliveryEligibilities"
    ],
    "ineligibleForMoneyBackGuarantee": true,
    "maximumTransitTime": "SEVEN_DAYS",
    "destinationLocationStateOrProvinceCode": "GA",
    "astraPlannedServiceLevel": "TUE - 15 OCT 10:30A",
    "destinationLocationId": "DALA",
    "transitTime": "TWO_DAYS",
    "stateOrProvinceCode": "GA",
    "destinationLocationNumber": 876,
    "packagingCode": "03",
    "commitDate": "2019-10-15",
    "publishedDeliveryTime": "10:30A",
    "ursaSuffixCode": "Ga",
    "ursaPrefixCode": "XH",
    "destinationServiceArea": "A1",
    "commitDay": "TUE",
    "customTransitTime": "ONE_DAY"
    },
    "carrierCode": "FDXE",
    "completedHoldAtLocationDetail":
    {
    "holdingLocationType": "FEDEX_STAFFED",
    "holdingLocation":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "tollFreePhoneNumber": "6127812",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "faxNumber": "1234567890",
    "pagerNumber": "6127812",
    "companyName": "Fedex",
    "title": "title"
    }
    }
    },
    "completedEtdDetail":
    {
    "folderId": "0b0493e580dc1a1b",
    "type": "COMMERCIAL_INVOICE",
    "uploadDocumentReferenceDetails":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ]
    },
    "packagingDescription": "description",
    "masterTrackingId":
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    },
    "serviceDescription":
    {
    "serviceType": "FEDEX_1_DAY_FREIGHT",
    "code": "80",
    "names":
    [
    {
    "type": "long",
    "encoding": "UTF-8",
    "value": "F-2"
    }
    ],
    "operatingOrgCodes":
    [
    "FXE"
    ],
    "astraDescription": "2 DAY FRT",
    "description": "description",
    "serviceId": "EP1000000027",
    "serviceCategory": "freight"
    },
    "usDomestic": true,
    "hazardousShipmentDetail":
    {
    "hazardousSummaryDetail":
    {
    "smallQuantityExceptionPackageCount": 10
    },
    "adrLicense":
    {
    "licenseOrPermitDetail":
    {
    "number": "12345",
    "effectiveDate": "2019-08-09",
    "expirationDate": "2019-04-09"
    }
    },
    "dryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68
    },
    "packageCount": 10,
    "processingOptions":
    {
    "options":
    [
    "options"
    ]
    }
    }
    },
    "shipmentRating":
    {
    "actualRateType": "PAYOR_LIST_SHIPMENT",
    "shipmentRateDetails":
    [
    {
    "rateZone": "US001O",
    "ratedWeightMethod": "ACTUAL",
    "totalDutiesTaxesAndFees": 24.56,
    "pricingCode": "LTL_FREIGHT",
    "totalFreightDiscounts": 1.56,
    "totalTaxes": 3.45,
    "totalDutiesAndTaxes": 6.78,
    "totalAncillaryFeesAndTaxes": 5.67,
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalRebates": 1.98,
    "fuelSurchargePercent": 4.56,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "totalNetFreight": 9.56,
    "totalNetFedExCharge": 88.56,
    "shipmentLegRateDetails":
    [
    {
    "rateZone": "rateZone",
    "pricingCode": "pricingCode",
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalDimWeight":
    {
    "units": "KG",
    "value": 68
    },
    "totalRebates": 2,
    "fuelSurchargePercent": 6,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "dimDivisor": 6,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "legDestinationLocationId": "legDestinationLocationId",
    "dimDivisorType": "dimDivisorType",
    "totalBaseCharge": 6,
    "ratedWeightMethod": "ratedWeightMethod",
    "totalFreightDiscounts": 9,
    "totalTaxes": 12.6,
    "minimumChargeType": "minimumChargeType",
    "totalDutiesAndTaxes": 17.78,
    "totalNetFreight": 6,
    "totalNetFedExCharge": 3.2,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 5,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "6702",
    "totalNetCharge": 25.3,
    "totalNetChargeWithDutiesAndTaxes": 25.67,
    "currency": "USD"
    }
    ],
    "dimDivisor": 0,
    "rateType": "RATED_ACCOUNT_SHIPMENT",
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 9.88,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "00000",
    "totalNetCharge": 3.78,
    "totalBaseCharge": 234.56,
    "totalNetChargeWithDutiesAndTaxes": 222.56,
    "currency": "USD"
    }
    ]
    },
    "documentRequirements":
    {
    "requiredDocuments":
    [
    "COMMERCIAL_OR_PRO_FORMA_INVOICE",
    "AIR_WAYBILL"
    ],
    "prohibitedDocuments":
    [
    "CERTIFICATE_OF_ORIGIN"
    ],
    "generationDetails":
    [
    {
    "type": "COMMERCIAL_INVOICE",
    "minimumCopiesRequired": 3,
    "letterhead": "OPTIONAL",
    "electronicSignature": "OPTIONAL"
    }
    ]
    },
    "exportComplianceStatement": "12345678901234567",
    "accessDetail":
    {
    "accessorDetails":
    [
    {
    "password": "password",
    "role": "role",
    "emailLabelUrl": "emailLabelUrl",
    "userId": "userId"
    }
    ]
    }
    },
    "shipmentAdvisoryDetails":
    {
    "regulatoryAdvisory":
    {
    "commodityClarifications":
    [
    {
    "commodityIndex": 25,
    "suggestions":
    [
    {
    "description": "description",
    "harmonizedCode": "harmonized Code"
    }
    ]
    }
    ],
    "prohibitions":
    [
    {
    "derivedHarmonizedCode": "01",
    "advisory":
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    },
    "commodityIndex": 12,
    "source": "source",
    "categories":
    [
    "categories"
    ],
    "type": "type",
    "waiver":
    {
    "advisories":
    [
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    }
    ],
    "description": "description",
    "id": "id"
    },
    "status": "status"
    }
    ]
    }
    },
    "masterTrackingNumber": "794953535000"
    }
  ],
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Delete Open Shipment Packages

This endpoint helps you to delete packages from Open Shipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-deletePackagesFromOpenShipment
MinimumSamplePayload-deletePackagesOpenShipment

index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number
trackingIds required	Array of objects (TrackingId) One or more tracking IDs, for which the packages to be removed from the shipment.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/openshipments/packages/delete

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/packages/delete

Production Server

https://apis.fedex.com/ship/v1/openshipments/packages/delete

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"accountNumber":
{
- "value": "Your account number"
},
"trackingIds":
[
- {
  - "formId": "0201",
  - "trackingIdType": "EXPRESS",
  - "uspsApplicationId": "92",
  - "trackingNumber": "49092000070120032835"
  }
]

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624xxxxx-b709-470c-8c39-4b55112xxxxx",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "deletedPackagesFromOpenshipment": true,
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Retrieve Open Shipment Package

This endpoint helps the user to RETRIEVE specific package request details of the Open Shipment that is created.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-retrievePackageInOpenShipment
MinimumSamplePayload-retrievePackageInOpenShipment

index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number
trackingId required	object (TrackingId) Indicates the tracking details for the package.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/packages/retrieve

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/packages/retrieve

Production Server

https://apis.fedex.com/ship/v1/openshipments/packages/retrieve

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"accountNumber":
{
- "value": "Your account number"
},
"trackingId":
{
- "formId": "0201",
- "trackingIdType": "EXPRESS",
- "uspsApplicationId": "92",
- "trackingNumber": "49092000070120032835"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624xxxxx-b709-470c-8c39-4b55112xxxxx",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "requestedpackageLineItem":
  {
  - "sequenceNumber": "1",
  - "subPackagingType": "BUCKET",
  - "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
  - "declaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "weight":
    {
    "units": "KG",
    "value": 68.25
    },
  - "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
  - "groupPackageCount": 2,
  - "itemDescriptionForClearance": "description",
  - "contentRecord":
    [
    {
    "itemNumber": "2876",
    "receivedQuantity": 256,
    "description": "Description",
    "partNumber": "456"
    }
    ],
  - "itemDescription": "item description for the package",
  - "variableHandlingChargeDetail":
    {
    "rateType": "PREFERRED_CURRENCY",
    "percentValue": 12.45,
    "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
    "fixedValue":
    {
    "amount": 24.45,
    "currency": "USD"
    },
    "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
    },
  - "packageSpecialServices":
    {
    "specialServiceTypes":
    [
    "ALCOHOL",
    "NON_STANDARD_CONTAINER"
    ],
    "signatureOptionType": "SERVICE_DEFAULT",
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
    "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
  },
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

OpenShipmentDelete V1

This endpoint helps you to delete a Openshipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-deleteOpenShipment
MinimumSamplePayload-deleteOpenShipment

index required	string This is a unique value for the shipment (must be unique for stand-alone open shipments, or unique within consolidation if consolidation key is provide). Example: Test1234
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/openshipments/delete

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/delete

Production Server

https://apis.fedex.com/ship/v1/openshipments/delete

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"accountNumber":
{
- "value": "Your account number"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624xxxxx-b709-470c-8c39-4b55112xxxxx",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "deletedOpenshipment": true,
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Retrieve Open Shipment

This endpoint helps the user to RETRIEVE the entire shipment request details of the OpenShipment that is created.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-RetrieveOpenShipment
MinimumSamplePayload-RetrieveOpenShipment

index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

post /ship/v1/openshipments/retrieve

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/retrieve

Production Server

https://apis.fedex.com/ship/v1/openshipments/retrieve

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"accountNumber":
{
- "value": "Your account number"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "XXX_ORDERXXXX789",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "requestedShipment":
  {
  - "shipDatestamp": "2019-10-14",
  - "totalDeclaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "shipper":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "XXXX567890",
    "companyName": "Fedex"
    },
    "tins":
    [
    {
    "number": "XXX567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
  - "recipients":
    [
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "FedEx"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "deliveryInstructions": "Delivery Instructions"
    }
    ],
  - "recipientLocationNumber": "1234567",
  - "pickupType": "USE_SCHEDULED_PICKUP",
  - "serviceType": "PRIORITY_OVERNIGHT",
  - "packagingType": "YOUR_PACKAGING",
  - "totalWeight": 20.6,
  - "origin":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
  - "shippingChargesPayment":
    {
    "paymentType": "SENDER",
    "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "XXXX567890",
    "phoneExtension": "phone extension",
    "companyName": "Fedex",
    "faxNumber": "fax number"
    },
    "accountNumber":
    {
    "value": "Your account number"
    }
    }
    }
    },
  - "shipmentSpecialServices":
    {
    "specialServiceTypes":
    [
    "THIRD_PARTY_CONSIGNEE",
    "PROTECTION_FROM_FREEZING"
    ],
    "etdDetail":
    {
    "attributes":
    [
    "POST_SHIPMENT_UPLOAD_REQUESTED"
    ],
    "attachedDocuments":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ],
    "requestedDocumentTypes":
    [
    "VICS_BILL_OF_LADING",
    "GENERAL_AGENCY_AGREEMENT"
    ]
    },
    "returnShipmentDetail":
    {
    "returnEmailDetail":
    {
    "merchantPhoneNumber": "19012635656",
    "allowedSpecialService":
    [
    "SATURDAY_DELIVERY"
    ]
    },
    "rma":
    {
    "reason": "Wrong Size or Color"
    },
    "returnAssociationDetail":
    {
    "shipDatestamp": "2019-10-01",
    "trackingNumber": "123456789"
    },
    "returnType": "PRINT_RETURN_LABEL"
    },
    "deliveryOnInvoiceAcceptanceDetail":
    {
    "recipient":
    {
    "address":
    {
    "streetLines":
    [
    "23, RUE JOSEPH-DE MA",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "1234567890",
    "companyName": "Fedex"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "deliveryInstructions": "Delivery Instructions"
    }
    },
    "internationalTrafficInArmsRegulationsDetail":
    {
    "licenseOrExemptionNumber": "9871234"
    },
    "pendingShipmentDetail":
    {
    "pendingShipmentType": "EMAIL",
    "processingOptions":
    {
    "options":
    [
    "ALLOW_MODIFICATIONS"
    ]
    },
    "recommendedDocumentSpecification":
    {
    "types": "ANTIQUE_STATEMENT_EUROPEAN_UNION"
    },
    "emailLabelDetail":
    {
    "recipients":
    [
    {
    "emailAddress": "neena@fedex.com",
    "optionsRequested":
    {
    "options":
    [
    "PRODUCE_PAPERLESS_SHIPPING_FORMAT",
    "SUPPRESS_ACCESS_EMAILS"
    ]
    },
    "role": "SHIPMENT_COMPLETOR",
    "locale": "en_US"
    }
    ],
    "message": "your optional message"
    },
    "attachedDocuments":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ],
    "expirationTimeStamp": "2020-01-01"
    },
    "holdAtLocationDetail":
    {
    "locationId": "YBZA",
    "locationContactAndAddress":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
    "locationType": "FEDEX_ONSITE"
    },
    "shipmentCODDetail":
    {
    "addTransportationChargesDetail":
    {
    "rateType": "ACCOUNT",
    "rateLevelType": "BUNDLED_RATE",
    "chargeLevelType": "CURRENT_PACKAGE",
    "chargeType": "COD_SURCHARGE"
    },
    "codRecipient":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
    "remitToName": "remitToName",
    "codCollectionType": "ANY",
    "financialInstitutionContactAndAddress":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "returnReferenceIndicatorType": "INVOICE",
    "shipmentCodAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "shipmentDryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "packageCount": 12
    },
    "internationalControlledExportDetail":
    {
    "licenseOrPermitExpirationDate": "2019-12-03",
    "licenseOrPermitNumber": "11",
    "entryNumber": "125",
    "foreignTradeZoneCode": "US",
    "type": "WAREHOUSE_WITHDRAWAL"
    },
    "homeDeliveryPremiumDetail":
    {
    "phoneNumber":
    {
    "areaCode": "901",
    "localNumber": "3575012",
    "extension": "200",
    "personalIdentificationNumber": "98712345"
    },
    "deliveryDate": "2019-06-26",
    "homedeliveryPremiumType": "APPOINTMENT"
    }
    },
  - "emailNotificationDetail":
    {
    "aggregationType": "PER_PACKAGE",
    "emailNotificationRecipients":
    [
    {
    "name": "Joe Smith",
    "emailNotificationRecipientType": "SHIPPER",
    "emailAddress": "jsmith3@aol.com",
    "notificationFormatType": "TEXT",
    "notificationType": "EMAIL",
    "locale": "en_US",
    "notificationEventType":
    [
    "ON_PICKUP_DRIVER_ARRIVED",
    "ON_SHIPMENT"
    ]
    }
    ],
    "personalMessage": "your personal message here"
    },
  - "expressFreightDetail":
    {
    "bookingConfirmationNumber": "123456789812",
    "shippersLoadAndCount": 123,
    "packingListEnclosed": true
    },
  - "variableHandlingChargeDetail":
    {
    "rateType": "PREFERRED_CURRENCY",
    "percentValue": 12.45,
    "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
    "fixedValue":
    {
    "amount": 24.45,
    "currency": "USD"
    },
    "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
    },
  - "customsClearanceDetail":
    {
    "regulatoryControls": "NOT_IN_FREE_CIRCULATION",
    "brokers":
    [
    {
    "broker":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 91,
    "companyName": "Fedex",
    "faxNumber": 1234567
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "deliveryInstructions": "deliveryInstructions"
    },
    "type": "IMPORT"
    }
    ],
    "commercialInvoice":
    {
    "originatorName": "originator Name",
    "comments":
    [
    "optional comments for the commercial invoice"
    ],
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
    "taxesOrMiscellaneousCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousChargeType": "COMMISSIONS",
    "freightCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "packingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "handlingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "declarationStatement": "declarationStatement",
    "termsOfSale": "FCA",
    "specialInstructions": "specialInstructions\"",
    "shipmentPurpose": "REPAIR_AND_RETURN",
    "emailNotificationDetail":
    {
    "emailAddress": "neena@fedex.com",
    "type": "EMAILED",
    "recipientType": "SHIPPER"
    }
    },
    "freightOnValue": "OWN_RISK",
    "dutiesPayment":
    {
    "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "phone extension",
    "companyName": "Fedex",
    "faxNumber": "fax number"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    },
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    }
    },
    "billingDetails":
    {
    "billingCode": "billingCode",
    "billingType": "billingType",
    "aliasId": "aliasId",
    "accountNickname": "accountNickname",
    "accountNumber": "Your account number",
    "accountNumberCountryCode": "US"
    },
    "paymentType": "SENDER"
    },
    "commodities":
    [
    {
    "unitPrice":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "additionalMeasures":
    [
    {
    "quantity": 12.45,
    "units": "KG"
    }
    ],
    "numberOfPieces": 12,
    "quantity": 125,
    "quantityUnits": "Ea",
    "customsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "countryOfManufacture": "US",
    "cIMarksAndNumbers": "87123",
    "harmonizedCode": "0613",
    "description": "description",
    "name": "non-threaded rivets",
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "exportLicenseNumber": "26456",
    "exportLicenseExpirationDate": "2025-04-06T03:14:39Z",
    "partNumber": "167",
    "purpose": "BUSINESS",
    "usmcaDetail":
    {
    "originCriterion": "A"
    }
    }
    ],
    "isDocumentOnly": true,
    "recipientCustomsId":
    {
    "type": "PASSPORT",
    "value": "123"
    },
    "customsOption":
    {
    "description": "Description",
    "type": "COURTESY_RETURN_LABEL"
    },
    "importerOfRecord":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
    "generatedDocumentLocale": "en_US",
    "exportDetail":
    {
    "destinationControlDetail":
    {
    "endUser": "dest country user",
    "statementTypes": "DEPARTMENT_OF_COMMERCE",
    "destinationCountries":
    [
    "USA",
    "India"
    ]
    },
    "b13AFilingOption": "NOT_REQUIRED",
    "exportComplianceStatement": "12345678901234567",
    "permitNumber": "12345"
    },
    "totalCustomsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "partiesToTransactionAreRelated": true,
    "declarationStatementDetail":
    {
    "usmcaLowValueStatementDetail":
    {
    "countryOfOriginLowValueDocumentRequested": true,
    "customsRole": "EXPORTER"
    }
    },
    "insuranceCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
  - "smartPostInfoDetail":
    {
    "ancillaryEndorsement": "RETURN_SERVICE",
    "hubId": "5015",
    "indicia": "PRESORTED_STANDARD",
    "specialServices": "USPS_DELIVERY_CONFIRMATION"
    },
  - "blockInsightVisibility": true,
  - "labelSpecification":
    {
    "labelFormatType": "COMMON2D",
    "labelOrder": "SHIPPING_LABEL_FIRST",
    "customerSpecifiedDetail":
    {
    "maskedData":
    [
    "[\"CUSTOMS_VALUE\",\"TOTAL_WEIGHT\"]"
    ],
    "regulatoryLabels":
    [
    {
    "generationOptions": "CONTENT_ON_SHIPPING_LABEL_ONLY",
    "type": "ALCOHOL_SHIPMENT_LABEL"
    }
    ],
    "additionalLabels":
    [
    {
    "type": "CONSIGNEE",
    "count": 1
    }
    ],
    "docTabContent":
    {
    "docTabContentType": "BARCODED",
    "zone001":
    {
    "docTabZoneSpecifications":
    [
    {
    "zoneNumber": 0,
    "header": "string",
    "dataField": "string",
    "literalValue": "string",
    "justification": "RIGHT"
    }
    ]
    },
    "barcoded":
    {
    "symbology": "UCC128",
    "specification":
    {
    "zoneNumber": 0,
    "header": "string",
    "dataField": "string",
    "literalValue": "string",
    "justification": "RIGHT"
    }
    }
    }
    },
    "printedLabelOrigin":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
    "labelStockType": "PAPER_85X11_TOP_HALF_LABEL",
    "labelRotation": "UPSIDE_DOWN",
    "imageType": "PDF",
    "labelPrintingOrientation": "TOP_EDGE_OF_TEXT_FIRST",
    "returnedDispositionDetail": true,
    "resolution": 300
    },
  - "shippingDocumentSpecification":
    {
    "generalAgencyAgreementDetail":
    {
    "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
    },
    "returnInstructionsDetail":
    {
    "customText": "This is additional text printed on Return instr",
    "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US\"",
    "docType": "PNG"
    }
    },
    "op900Detail":
    {
    "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
    "signatureName": "Signature Name",
    "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
    },
    "usmcaCertificationOfOriginDetail":
    {
    "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
    "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    },
    "certifierSpecification": "EXPORTER",
    "importerSpecification": "UNKNOWN",
    "producerSpecification": "SAME_AS_EXPORTER",
    "producer":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
    "blanketPeriod":
    {
    "begins": "22-01-2020",
    "ends": "2-01-2020"
    },
    "certifierJobTitle": "Manager"
    },
    "usmcaCommercialInvoiceCertificationOfOriginDetail":
    {
    "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
    "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    },
    "certifierSpecification": "EXPORTER",
    "importerSpecification": "UNKNOWN",
    "producerSpecification": "SAME_AS_EXPORTER",
    "producer":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
    "certifierJobTitle": "Manager"
    },
    "shippingDocumentTypes":
    [
    "RETURN_INSTRUCTIONS"
    ],
    "certificateOfOrigin":
    {
    "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
    "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
    },
    "commercialInvoiceDetail":
    {
    "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
    "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
    }
    },
  - "rateRequestType":
    [
    "LIST",
    "PREFERRED"
    ],
  - "preferredCurrency": "USD",
  - "totalPackageCount": 25,
  - "masterTrackingId":
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    },
  - "requestedPackageLineItems":
    [
    {
    "sequenceNumber": "1",
    "subPackagingType": "BUCKET",
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
    "declaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
    "groupPackageCount": 2,
    "itemDescriptionForClearance": "description",
    "contentRecord":
    [
    {
    "itemNumber": "2876",
    "receivedQuantity": 256,
    "description": "Description",
    "partNumber": "456"
    }
    ],
    "itemDescription": "item description for the package",
    "variableHandlingChargeDetail":
    {
    "rateType": "PREFERRED_CURRENCY",
    "percentValue": 12.45,
    "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
    "fixedValue":
    {
    "amount": 24.45,
    "currency": "USD"
    },
    "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
    },
    "packageSpecialServices":
    {
    "specialServiceTypes":
    [
    "ALCOHOL",
    "NON_STANDARD_CONTAINER"
    ],
    "signatureOptionType": "SERVICE_DEFAULT",
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
    "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
    }
    ]
  },
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Get Open Shipment Results

This endpoint enables you to finalize the Open Shipment. Once an Open Shipment is confirmed, no further changes can be done.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-getOpenShipmentResults
MinimumSamplePayload-getConfirmOpenShipmentResults
MinimumSamplePayload-getCreateOpenShipmentResults
MinimumSamplePayload-getModifyOpenShipmentResults

resultMethodType required	string Enum: "CREATE" "MODIFY" "CONFIRM" The use of this method is to retrieve the results of the CREATE, MODIFY and CONFIRM events of Asynchronous flow. CREATE- Customer will create Async shipment and will get jobId. Using the generated jobId in Get OpenShipment Results endpoint customer can retrieve the result of Create OpenShipment. MODIFY- Customer will modify Async shipment and will get jobId. Using the generated jobId in Get OpenShipment Results endpoint customer can retrieve the result of Modify OpenShipment. CONFIRM- Customer will confirm Async shipment and will get jobId. Using the generated jobId in Get OpenShipment Results endpoint customer can retrieve the result of Confirm OpenShipment.
jobId required	string Indicates the job under which the deferred shipment artifacts must be identified in the subsequent retrieval request. Example: '89sxxxxx233ae24ff31xxxxx'
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/results

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/results

Production Server

https://apis.fedex.com/ship/v1/openshipments/results

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"resultMethodType": "CREATE",
"jobId": "89sxxxxx233ae24ff31xxxxx",
"accountNumber":
{
- "value": "Your account number"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624xxxxx-b709-470c-8c39-4b55112xxxxx",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "transactionShipments":
  [
  - {
    "serviceType": "STANDARD_OVERNIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "shipmentDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "pieceResponses":
    [
    {
    "netChargeAmount": 21.45,
    "transactionDetails":
    [
    {
    "transactionDetails": "transactionDetails",
    "transactionId": "12345"
    }
    ],
    "packageDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "acceptanceTrackingNumber": "794953535000",
    "serviceCategory": "EXPRESS",
    "listCustomerTotalCharge": "listCustomerTotalCharge",
    "deliveryTimestamp": "2012-09-23",
    "trackingIdType": "FEDEX",
    "additionalChargesDiscount": 621.45,
    "netListRateAmount": 1.45,
    "baseRateAmount": 321.45,
    "packageSequenceNumber": 215,
    "netDiscountAmount": 121.45,
    "codcollectionAmount": 231.45,
    "masterTrackingNumber": "794953535000",
    "acceptanceType": "acceptanceType",
    "trackingNumber": "794953535000",
    "successful": true,
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ]
    }
    ],
    "serviceName": "FedEx 2 Day Freight",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "completedShipmentDetail":
    {
    "completedPackageDetails":
    [
    {
    "sequenceNumber": 256,
    "operationalDetail":
    {
    "astraHandlingText": "astraHandlingText",
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value": "string"
    }
    ],
    "stringBarcodes":
    [
    {
    "type": "ADDRESS",
    "value": "1010062512241535917900794953544894"
    }
    ]
    },
    "operationalInstructions":
    [
    {
    "number": 17,
    "content": "content"
    }
    ]
    },
    "signatureOption": "DIRECT",
    "trackingIds":
    [
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    }
    ],
    "groupNumber": 567,
    "oversizeClass": "OVERSIZE_1, OVERSIZE_2, OVERSIZE_3",
    "packageRating":
    {
    "effectiveNetDiscount": 0,
    "actualRateType": "PAYOR_ACCOUNT_PACKAGE",
    "packageRateDetails":
    [
    {
    "ratedWeightMethod": "DIM",
    "totalFreightDiscounts": 44.55,
    "totalTaxes": 3.45,
    "minimumChargeType": "minimumChargeType",
    "baseCharge": 45.67,
    "totalRebates": 4.56,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "billingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "netFreight": 4.89,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 22.56,
    "netFedExCharge": 12.56,
    "netCharge": 121.56,
    "currency": "USD"
    }
    ]
    },
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68
    },
    "hazardousPackageDetail":
    {
    "regulation": "IATA",
    "accessibility": "ACCESSIBLE",
    "labelType": "II_YELLOW",
    "containers":
    [
    {
    "qvalue": 2,
    "hazardousCommodities":
    [
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "options":
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "innerReceptacles":
    [
    {
    "quantity":
    {
    "quantityType": "NET",
    "amount": 34.56,
    "units": "Kg"
    }
    }
    ],
    "options":
    {
    "labelTextOption": "APPEND",
    "customerSuppliedLabelText": "Customer Supplied Label Text."
    },
    "description":
    {
    "sequenceNumber": 9812,
    "processingOptions":
    [
    "INCLUDE_SPECIAL_PROVISIONS"
    ],
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "technicalName": "technicalName",
    "packingDetails":
    {
    "packingInstructions": "packing Instructions",
    "cargoAircraftOnly": true
    },
    "authorization": "authorization",
    "reportableQuantity": true,
    "percentage": 12.45,
    "id": "123",
    "packingGroup": "I",
    "properShippingName": "properShippingName",
    "hazardClass": "hazard Class"
    }
    },
    "description":
    {
    "sequenceNumber": 876,
    "packingInstructions": "packingInstructions",
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "tunnelRestrictionCode": "UN2919",
    "specialProvisions": "specialProvisions",
    "properShippingNameAndDescription": "properShippingNameAndDescription",
    "technicalName": "technicalName",
    "symbols": "symbols",
    "authorization": "authorization",
    "attributes":
    [
    "attributes"
    ],
    "id": "1234",
    "packingGroup": "packingGroup",
    "properShippingName": "properShippingName",
    "hazardClass": "hazardClass"
    },
    "netExplosiveDetail":
    {
    "amount": 10,
    "units": "units",
    "type": "NET_EXPLOSIVE_WEIGHT"
    },
    "massPoints": 2
    }
    ]
    }
    ],
    "cargoAircraftOnly": true,
    "referenceId": "123456",
    "radioactiveTransportIndex": 2.45
    }
    }
    ],
    "operationalDetail":
    {
    "originServiceArea": "A1",
    "serviceCode": "010",
    "airportId": "DFW",
    "postalCode": "38010",
    "scac": "scac",
    "deliveryDay": "TUE",
    "originLocationId": "678",
    "countryCode": "US",
    "astraDescription": "SMART POST",
    "originLocationNumber": 243,
    "deliveryDate": "2001-04-05",
    "deliveryEligibilities":
    [
    "deliveryEligibilities"
    ],
    "ineligibleForMoneyBackGuarantee": true,
    "maximumTransitTime": "SEVEN_DAYS",
    "destinationLocationStateOrProvinceCode": "GA",
    "astraPlannedServiceLevel": "TUE - 15 OCT 10:30A",
    "destinationLocationId": "DALA",
    "transitTime": "TWO_DAYS",
    "stateOrProvinceCode": "GA",
    "destinationLocationNumber": 876,
    "packagingCode": "03",
    "commitDate": "2019-10-15",
    "publishedDeliveryTime": "10:30A",
    "ursaSuffixCode": "Ga",
    "ursaPrefixCode": "XH",
    "destinationServiceArea": "A1",
    "commitDay": "TUE",
    "customTransitTime": "ONE_DAY"
    },
    "carrierCode": "FDXE",
    "completedHoldAtLocationDetail":
    {
    "holdingLocationType": "FEDEX_STAFFED",
    "holdingLocation":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "tollFreePhoneNumber": "6127812",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "faxNumber": "1234567890",
    "pagerNumber": "6127812",
    "companyName": "Fedex",
    "title": "title"
    }
    }
    },
    "completedEtdDetail":
    {
    "folderId": "0b0493e580dc1a1b",
    "type": "COMMERCIAL_INVOICE",
    "uploadDocumentReferenceDetails":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ]
    },
    "packagingDescription": "description",
    "masterTrackingId":
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    },
    "serviceDescription":
    {
    "serviceType": "FEDEX_1_DAY_FREIGHT",
    "code": "80",
    "names":
    [
    {
    "type": "long",
    "encoding": "UTF-8",
    "value": "F-2"
    }
    ],
    "operatingOrgCodes":
    [
    "FXE"
    ],
    "astraDescription": "2 DAY FRT",
    "description": "description",
    "serviceId": "EP1000000027",
    "serviceCategory": "freight"
    },
    "usDomestic": true,
    "hazardousShipmentDetail":
    {
    "hazardousSummaryDetail":
    {
    "smallQuantityExceptionPackageCount": 10
    },
    "adrLicense":
    {
    "licenseOrPermitDetail":
    {
    "number": "12345",
    "effectiveDate": "2019-08-09",
    "expirationDate": "2019-04-09"
    }
    },
    "dryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68
    },
    "packageCount": 10,
    "processingOptions":
    {
    "options":
    [
    "options"
    ]
    }
    }
    },
    "shipmentRating":
    {
    "actualRateType": "PAYOR_LIST_SHIPMENT",
    "shipmentRateDetails":
    [
    {
    "rateZone": "US001O",
    "ratedWeightMethod": "ACTUAL",
    "totalDutiesTaxesAndFees": 24.56,
    "pricingCode": "LTL_FREIGHT",
    "totalFreightDiscounts": 1.56,
    "totalTaxes": 3.45,
    "totalDutiesAndTaxes": 6.78,
    "totalAncillaryFeesAndTaxes": 5.67,
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalRebates": 1.98,
    "fuelSurchargePercent": 4.56,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "totalNetFreight": 9.56,
    "totalNetFedExCharge": 88.56,
    "shipmentLegRateDetails":
    [
    {
    "rateZone": "rateZone",
    "pricingCode": "pricingCode",
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalDimWeight":
    {
    "units": "KG",
    "value": 68
    },
    "totalRebates": 2,
    "fuelSurchargePercent": 6,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "dimDivisor": 6,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "legDestinationLocationId": "legDestinationLocationId",
    "dimDivisorType": "dimDivisorType",
    "totalBaseCharge": 6,
    "ratedWeightMethod": "ratedWeightMethod",
    "totalFreightDiscounts": 9,
    "totalTaxes": 12.6,
    "minimumChargeType": "minimumChargeType",
    "totalDutiesAndTaxes": 17.78,
    "totalNetFreight": 6,
    "totalNetFedExCharge": 3.2,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 5,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "6702",
    "totalNetCharge": 25.3,
    "totalNetChargeWithDutiesAndTaxes": 25.67,
    "currency": "USD"
    }
    ],
    "dimDivisor": 0,
    "rateType": "RATED_ACCOUNT_SHIPMENT",
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 9.88,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "00000",
    "totalNetCharge": 3.78,
    "totalBaseCharge": 234.56,
    "totalNetChargeWithDutiesAndTaxes": 222.56,
    "currency": "USD"
    }
    ]
    },
    "documentRequirements":
    {
    "requiredDocuments":
    [
    "COMMERCIAL_OR_PRO_FORMA_INVOICE",
    "AIR_WAYBILL"
    ],
    "prohibitedDocuments":
    [
    "CERTIFICATE_OF_ORIGIN"
    ],
    "generationDetails":
    [
    {
    "type": "COMMERCIAL_INVOICE",
    "minimumCopiesRequired": 3,
    "letterhead": "OPTIONAL",
    "electronicSignature": "OPTIONAL"
    }
    ]
    },
    "exportComplianceStatement": "12345678901234567",
    "accessDetail":
    {
    "accessorDetails":
    [
    {
    "password": "password",
    "role": "role",
    "emailLabelUrl": "emailLabelUrl",
    "userId": "userId"
    }
    ]
    }
    },
    "shipmentAdvisoryDetails":
    {
    "regulatoryAdvisory":
    {
    "commodityClarifications":
    [
    {
    "commodityIndex": 25,
    "suggestions":
    [
    {
    "description": "description",
    "harmonizedCode": "harmonized Code"
    }
    ]
    }
    ],
    "prohibitions":
    [
    {
    "derivedHarmonizedCode": "01",
    "advisory":
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    },
    "commodityIndex": 12,
    "source": "source",
    "categories":
    [
    "categories"
    ],
    "type": "type",
    "waiver":
    {
    "advisories":
    [
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    }
    ],
    "description": "description",
    "id": "id"
    },
    "status": "status"
    }
    ]
    }
    },
    "masterTrackingNumber": "794953535000"
    }
  ],
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Request
Response

Response

Copy

Developer Portal

Open Ship API

Inleiding

Details over de Open Ship-API

Workflow van de Open Ship-API

Zo werkt de Open Ship-API

Open Zendingen die uit meerdere pakketten bestaan (MPS)

FedEx-verzendetiketten

Bedrijfsregels

JSON API-verzameling

Open Ship API (1.0)

Create Open Shipment

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Modify Open Shipment

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Confirm Open Shipment

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Modify Open Shipment Packages

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Add Open Shipment Packages

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Delete Open Shipment Packages

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Retrieve Open Shipment Package

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

OpenShipmentDelete V1

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Retrieve Open Shipment

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get Open Shipment Results

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Enter your user ID and password to log in