/api/shipment/create

->request(
    'POST',
    'https://eshipping.hillebrandgori.app/api/shipment/create',
    ['headers' => [
        'Content-Type' => 'application/json',
        'X-AUTH-TOKEN' => 'ESHIPPING_TOKEN',
    ],
    'json' => [
        'expAddress' => [
            'addressType' => 'company',
            'company' => ACME,
            'contact' => John Doe,
            'telephone' => 0033980802020,
            'address' => 69B rue du Colombier,
            'addressComplement' => '',
            'zipCode' => 45000,
            'city' => Orléans,
            'state' => '',
            'country' => FR,
            'fda' => '15609537810',
            'eori' => 'FR52926125700032',
            'notify' => '1',
            'vatNumber' => 'FR95529261257',
            'exciseNumber' => '',
            'importLicense' => '',
            'email' => john@mail.com,
        ],
        'destAddress' => [
            'addressType' => 'individual',
            'company' => '',
            'contact' => Marjolaine LETEURTRE,
            'lastname' => 'LETEURTRE',
            'firstname' => 'Marjolaine',
            'telephone' => 0033120304050,
            'address' => 1600, Pennsylvania Avenue NW,
            'addressComplement' => '',
            'zipCode' => 20500,
            'city' => Washington,
            'country' => 'US',
            'state' => 'DC',
            'notify' => '1',
            'saveAddress' => '0',
            'addressName' => '',
            'vatNumber' => '',
            'exciseNumber' => '',
            'importLicense' => '',
            'destTax' => '',
            'email' => 'marjolaine@mail.com',
        ],
        'packages' => [
            'nb' => '1',
            'weight' => '10',
            'width' => '27',
            'height' => '40',
            'length' => '39'
        ],
        'carrier' => [
            'pickupDate': '2023-06-07',
            'name': 'fedex',
            'service': 'FEDEX International Economy',
            'serviceCode': 'INTERNATIONAL_ECONOMY',
            'price': 108.72,
            'currency': 'EUR',
            'surcharges': {
                '1': {
                    'GlobalServiceName': 'Peak Surcharge',
                    'SurchargeType': 'PEAK',
                    'Amount': '3'
                }
            },
            'local': null,
            'cutoff': '14:30:00',
            'pickupTime': '16:00:00',
            'deliveryDate': '2023-06-13',
            'deliveryTime': '16:30:00',
            'pickupAccessDelay': '90',
            'saturdayDelivery': null,
            'guaranteedDelay': '0'
        ],
        'details' => [
            'appellation' => 'Chinon',
            'origin' => 'France',
            'description' => 'Les Puys',
            'capacity' => '750',
            'alcoholDegree' => '12.5',
            'color' => 'red',
            'hsCode' => '2204.21.48',
            'vintage' => '2019',
            'unitValue' => '18.5',
            'quantity' => '6',
            'manufacturer' => '',
        ],
        'insurance' => '1',
        'totalValue' => 150,
        'currency' => 'EUR',
        'detailsType' => 'vente',
        'circulation' => 'CRD',
        'minHour' => '10:10:00',
        'cutOff' => '18:00:00',
        'nbBottles' => 12,
        'wineType' => 'wine',
    ]
]);

Send the parameters required to register your shipment in the carrier's network :

• producingCountry : country ISO-2 code.

  💡 Can be retrieved from /api/address/get-countries

• expAddress[

  • expAddress[addressType] : company | individual

  • expAddress[company]

  • expAddress[contact]

  • expAddress[telephone]

  • expAddress[address]

  • expAddress[addressComplement]

  • expAddress[zipCode]

  • expAddress[city]

  • expAddress[country]

  • expAddress[state]

  • expAddress[fda]

  • expAddress[eori]

  • expAddress[notify]

  • expAddress[vatNumber]

  • expAddress[exciseNumber]

  ]

• destAddress[

  • destAddress[addressType] : company | individual

  • destAddress[company]

  • destAddress[contact]

  • destAddress[lastname]

  • destAddress[firstname]

  • destAddress[telephone]

  • destAddress[address]

  • destAddress[addressComplement]

  • destAddress[zipCode]

  • destAddress[city]

  • destAddress[country]

  • destAddress[state]

  • destAddress[fda]

  • destAddress[eori]

  • destAddress[notify]

  • destAddress[vatCompany]

  • destAddress[vatNumber]

  • destAddress[exciseNumber]

  • destAddress[importLicense]

  • destAddress[destTax]

  • destAddress[email]

]

• packages[

• packages[][nb]

• packages[][weight]

• packages[][width]

• packages[][height]

• packages[][length]

]

💡 Can be retrieved from /api/shipment/get-sizes

• carrier[

  • carrier[pickupDate] 

  • carrier[name]

  • carrier[service]

  • carrier[serviceCode]

  • carrier[price]

  • carrier[surcharges]

  • carrier[local]

  • carrier[coast]

  • carrier[cutoff]

  • carrier[pickupTime]

  • carrier[deliveryDate]

  • carrier[deliveryTime]

  • carrier[pickupAccessDelay]

  • carrier[saturdayDelivery]

]

💡 Can be retrieved from /api/shipment/get-rates

• details[

  • details[][appellation]

  • details[][origin]

  • details[][description]

  • details[][ttb]

  • details[][capacity]

  • details[][alcoholDegree]

  • details[][color]

  • details[][hsCode]

  • details[][vintage]

  • details[][unitValue]

  • details[][quantity]

  • details[][manufacturer]

  • details[][circulation] : CRD | DAE

]

• insurance : 1 | 0

• insurancePrice

• totalValue

• currency : EUR | USD | CAD

• detailsType : gift | sample | sale

• circulation : CRD | DAE -> the products are moving under excise duty paid (CRD) or under suspension of excise duty (DAE)

• reference : free field to identify shipment at time of invoicing

• dutiesTaxes : exp | dest -> import tax and duties payable by shipper (exp) or receiver (dest)

• minHour

• cutoff

• nbBottles

• nbMagnums

• wineType : wine | sparkling | spirits

• champagneAttachments[

  • champagneAttachments[name]

  • champagneAttachments[file]

]

• accessPoint[

  • accessPoint[id]

  • accessPoint[name]

  • accessPoint[addLine1]

  • accessPoint[postal]

  • accessPoint[city]

  • accessPoint[country]

]

💡 Can be retrieved from

• /api/api/relay/get-access-points for UPS deliveries

• /api/relay/get-chronopost-relay-points for Chronopost deliveries

• fiscalRepresentation : 1 | 0

• fiscalRepresentationVatNum : 1 | 0

• charges[

  • charges[exciseDuties]

  • charges[vat] 

  • charges[shippingPrice]

  • charges[paperwork]

  • charges[packagingTax]

  • charges[commodityValue]

  • charges[volumeHL]

  • charges[totalAllInExcisesDest]

  • charges[totalAllInExcisesExp]

  • charges[totalAllInPackagingTaxDest]

  • charges[totalAllInPackagingTaxExp]

  • charges[totalAllInPaperworkDest]

  • charges[totalAllInPaperworkExp]

  • charges[totalAllInCommodityValueDest]

  • charges[totalAllInCommodityValueExp]

  • charges[totalAllInShippingPriceDest]

  • charges[totalAllInShippingPriceExp]

]

💡 Can be retrieved from /api/shipment/get-charges

• colaAttachments[

  • colaAttachments[name]

  • colaAttachments[file]

]

• hasColaWaiver : 1 | 0

• colaWaiverSupplier

• noColaWaiver

• importerColaWaiver[

  • importerColaWaiver[company]

  • importerColaWaiver[telephone]

  • importerColaWaiver[address]

  • importerColaWaiver[addressComplement]

  • importerColaWaiver[zipCode]

  • importerColaWaiver[city]

  • importerColaWaiver[email]

  • importerColaWaiver[license]

]