/api/shipment/get-rates

Edited
->request(
  'GET',
  'https://eshipping.hillebrandgori.app/api/shipment/get-rates',
  ['headers' => [
        'X-AUTH-TOKEN' => 'ESHIPPING_TOKEN',
      ],
      'query' => [
      	    'expAddress[addressType]' => 'company',
            'expAddress[zipCode]' => 45000,
            'expAddress[city]' => Orléans
            'expAddress[country]' => 'FR',
            'destAddress[addressType]' => 'individual',
            'destAddress[zipCode]' => 76000
            'destAddress[city]' => Rouen
            'destAddress[country]' => 'FR',
            'packages' => [
		'nb' => 1,
                'weight' => 10,
                'width' => 27,
                'height' => 40,
                'length' => 39
	    ],
            'nbBottles' => 6,
            'pickupDate' => '2023-09-18',
            'minHour' => '10:10:00',
            'cutoff' => '18:00:00',
	    'nonAlcoholic' => false,
	    'document' => false,	
	    'pallets' => false,
	    'commodityValue' => 12.5
     ]
  ]
);

Retrieve the shipping rates of a shipment based on below parameters :

  • expAddress[addressType] : company | individual

  • expAddress[zipCode]

  • expAddress[city]

  • expAddress[country]

  • expAddress[state]

  • destAddress[addressType] : company | individual

  • destAddress[zipCode]

  • destAddress[city]

  • destAddress[state]

  • packages[ :

    • packages[][nb]

    • packages[][weight]

    • packages[][width]

    • packages[][height]

    • packages[][length]

    ]

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

  • nbBottles : number of bottles contained in the shipment

  • pickupDate : shipment pickup date

  • minHour : package ready time

  • cutoff : pickup place closing time

  • nonAlcoholic : does the shipment only contain non alcoholic commodities

  • documents : does the shipment only contain documents

  • pallets : is the shipment on a pallet ?

  • commodityValue : to calculate the insurance cost