Pick Up
POST {{url}}/ship/pickup/
This is a list of the different conditions available in our API that you must take into account at the time of requesting the PickUp of your package.
Country codes must be 2 digits
- State codes must be 2 digits
Get the pickup rules by carrier Pick up Rules.
| Type | Description Pick up Rules. |
|---|---|
Day | day = 1 Monday. day = 2 Tuesday. |
Same Day | sameday: 1 = TRUE. sameday: 0 = FALSE. |
Hour Limit | hour_limit = 14 Meaning you have to create the pickup request before this time for a same day pickup. Use Central Time (GTM -6). |
Hour Start | hour_start = 9 Means that the earliest time you can request the pickup is at 9 am. |
Hour End | hour_end = 18 Means that the latest time you can request the pickup is at 18 pm. |
Hour Span | hour_span = 3 Means that you must at least request the pickup with a span of 3 hours. |
Request Body
{"origin"=>{"name"=>"Raymundo Salazar", "company"=>"Example Company", "email"=>"raymundo@example.com", "phone"=>"81818181", "street"=>"Av Vasconcelos", "number"=>"1400", "district"=>"Palo Blanco", "city"=>"San pedro", "state"=>"NL", "country"=>"MX", "postalCode"=>"66236"}, "shipment"=>{"carrier"=>"fedex", "type"=>1, "pickup"=>{"timeFrom"=>12, "timeTo"=>16, "date"=>"2018-08-21", "instructions"=>"Hola", "totalPackages"=>2, "totalWeight"=>2}}, "settings"=>{"currency"=>"MXN", "labelFormat"=>"pdf"}}