Pickup Request API

บทนำ

API สำหรับการนัดเข้ารับพัสดุช่วยให้คุณตรวจสอบความพร้อมในการมารับพัสดุ นัดหมายผู้ให้บริการขนส่งเพื่อเข้ารับพัสดุ และยกเลิกคำขอการเข้ารับพัสดุ

API สำหรับการนัดเข้ารับพัสดุใช้ได้กับพัสดุใหม่หรือที่ผ่านการดำเนินการก่อนหน้านี้ในทุกภูมิภาคสำหรับการจัดส่งแบบ FedEx Express และ FedEx Ground (ทั้งแบบส่งคืนและแบบขาออก) คำแนะนำโดยละเอียดนี้จะช่วยให้คุณเข้าใจได้อย่างรวดเร็วและสอนทุกสิ่งที่คุณจำเป็นต้องรู้เกี่ยวกับ API สำหรับการนัดเข้ารับพัสดุ

รายละเอียด API สำหรับการนัดเข้ารับพัสดุ

ต่อไปนี้เป็นคุณสมบัติหลักที่เกี่ยวข้องกับ API สำหรับการนัดเข้ารับพัสดุ:

ความพร้อมในการมารับพัสดุ

ด้วยความพร้อมในการมารับพัสดุ คุณสามารถตรวจสอบความพร้อมในการให้บริการรับพัสดุตามคำขอที่ป้อนได้ โดยความพร้อมในการมารับพัสดุขึ้นอยู่กับสองปัจจัย: เวลาตัดยอดและเวลาที่เข้าถึง

เวลาตัดยอด - เวลานัดรับพัสดุที่ช้าที่สุดที่อนุญาต โดยเวลาจะเป็นเวลาท้องถิ่นสำหรับรหัสไปรษณีย์ที่รับพัสดุ

เวลาที่เข้าถึง - ช่วงเวลาระหว่างเวลาที่พร้อมสำหรับรับพัสดุ (เมื่อพัสดุพร้อมให้มารับ) กับเวลาที่พนักงานขับรถพร้อมที่จะมารับพัสดุ

สร้างการรับพัสดุ

ตัวเลือกนี้ช่วยให้คุณกำหนดการรับพัสดุและนำไปใช้กับการจัดส่งแบบ FedEx Express^® และ FedEx Ground^® ทั้งในและระหว่างประเทศได้ โดย API สำหรับการนัดเข้ารับพัสดุของ FedEx Ground และ Express จะส่งคืนหมายเลขยืนยันการรับพัสดุ และจะมีการส่งคืนรหัสที่อยู่พร้อมกับคำขอรับพัสดุ Express สำหรับการรับพัสดุตามกำหนดเวลา และคุณยังสามารถกำหนดเวลารับพัสดุสำหรับพัสดุส่งคืนโดยใช้ API นี้ได้อีกด้วย

บรรทัดที่อยู่ผู้รับเพิ่มเติม (บรรทัดที่อยู่ 3) ช่วยให้คุณระบุรายละเอียดตำแหน่งที่ครบถ้วนและแม่นยำยิ่งขึ้นเพื่อให้การจัดส่งพัสดุ FedEx Express^® รวดเร็วยิ่งขึ้น คุณยังสามารถประหยัดเวลาด้วยการกำหนดเวลาให้ผู้ให้บริการขนส่งของ FedEx ไปรับสินค้าขึ้นรถได้จากตำแหน่งที่ตั้งของคุณหรือจากสถานที่อื่น โดยมีค่าบริการเพิ่มเติม

ยกเลิกการรับพัสดุ

ตัวเลือกนี้ช่วยให้คุณสามารถยกเลิกการรับพัสดุที่กำหนดเวลาไว้ก่อนหน้านี้ได้ ตัวเลือกนี้ใช้กับการจัดส่งแบบ FedEx Express และ FedEx Ground ทั้งในประเทศและระหว่างประเทศ สามารถยกเลิกการรับพัสดุของ FedEx Express ทั้งในประเทศและระหว่างประเทศได้ในวันเดียวกัน สามารถทำการยกเลิกการจัดส่งแบบ FedEx Ground ทั้งในประเทศและระหว่างประเทศได้ 24 ชม. หลังจากส่งคำขอรับพัสดุแล้ว หากมีการรับพัสดุของคุณไปแล้ว กรุณาติดต่อแผนกบริการลูกค้าของ FedEx ที่ 800 FedEx (800 3339) เพื่อดำเนินการยกเลิก

รายละเอียดคำขอรับพัสดุ

คำขอรับพัสดุของ FedEx Express

เวลาที่พัสดุของคุณจะพร้อมให้มารับต้องไม่ช้ากว่าเวลาตัดยอดรหัสไปรษณีย์สำหรับสถานที่ของคุณ ซึ่งสามารถเรียกดูเวลาตัดยอดได้ด้วยคำขอความพร้อมในการรับพัสดุ
ระยะเวลาตั้งแต่เมื่อพัสดุของคุณจะพร้อมจนถึงเวลาที่ผู้ให้บริการขนส่งจะไม่สามารถเข้าไปในสถานที่เพื่อรับพัสดุได้อีกต่อไป จะต้องไม่น้อยไปกว่า "เวลาที่เข้าถึง" ซึ่งสามารถเรียกดูได้ด้วยคำขอความพร้อมในการรับพัสดุ

ตัวอย่างเช่น: 'PT4H0M' ระบุว่าเวลาที่รับพัสดุคือ 4 ชั่วโมง 0 นาที

การรับพัสดุ FedEx Express สามารถกำหนดวันนัดหมายสำหรับวันทำการปัจจุบันหรือวันทำการถัดไปได้
จำนวนพัสดุสูงสุดสำหรับคำขอรับพัสดุในครั้งเดียวคือ 99 รายการ
หากคุณมีการรับพัสดุตามกำหนดเวลาปกติแล้ว ไม่จำเป็นต้องกำหนดเวลาการรับพัสดุแบบครั้งเดียวหรือเพิ่มการรับพัสดุตามกำหนดเวลาอื่น
คุณไม่สามารถเปลี่ยนแปลงคำขอรับพัสดุได้ หากต้องการเปลี่ยนคำขอ คุณต้องยกเลิกคำขอเดิมและป้อนคำขอใหม่
ขณะนี้ระบบของ FedEx รองรับฟังก์ชันการรับพัสดุภายในประเทศในสหราชอาณาจักร

คำขอรับพัสดุของ FedEx Ground

สามารถกำหนดเวลารับพัสดุในวันทำการถัดไปหรือวันทำการใดก็ได้ล่วงหน้าสูงสุด 2 สัปดาห์
จำนวนพัสดุสูงสุดสำหรับคำขอรับพัสดุในครั้งเดียวคือ 99 รายการ
หากคุณมีการรับพัสดุตามกำหนดเวลาปกติแล้ว ไม่จำเป็นต้องกำหนดเวลาการรับพัสดุแบบครั้งเดียวหรือเพิ่มการรับพัสดุตามกำหนดเวลาอื่น
มีบริการรับพัสดุตามที่อยู่ปัจจุบัน โดยมีค่าบริการเพิ่มเติม
คุณไม่สามารถเปลี่ยนแปลงคำขอรับพัสดุได้ หากต้องการเปลี่ยนคำขอ คุณต้องยกเลิกคำขอเดิมและป้อนคำขอใหม่

ประเภทบริการของ API สำหรับการนัดเข้ารับพัสดุ

การรับพัสดุ FedEx Express

จะมีการคิดค่าธรรมเนียมในการรับพัสดุโดยผู้ให้บริการขนส่งเมื่อคุณต้องการให้ไปรับพัสดุ FedEx Express รวมถึงคำขอที่ส่งผ่าน fedex.com และแผนกบริการลูกค้าของ FedEx

การรับพัสดุ FedEx Ground

FedEx Ground ให้บริการรับพัสดุเมื่อมีการร้องขอ โดยมีค่าบริการเพิ่มเติม สำหรับลูกค้าที่มีกำหนดรับพัสดุตามเวลาปกติ เราจะประเมินค่าธรรมเนียมสำหรับการรับพัสดุเป็นรายสัปดาห์ตามหมายเลขบัญชีที่เชื่อมโยงกับการรับพัสดุตามกำหนดเวลาปกติ

สำหรับลูกค้าที่ไม่มีกำหนดรับพัสดุตามเวลาปกติ เราจะประเมินค่าธรรมเนียมในการเรียกรับพัสดุต่อชิ้น หากคุณฝากพัสดุของคุณที่สถานที่จัดส่งพัสดุของ FedEx จะไม่มีการคิดค่าธรรมเนียมในการเรียกรับพัสดุ นอกจากนี้ จะไม่มีการคิดค่าธรรมเนียมในการเรียกรับพัสดุกับการรับพัสดุที่มีฉลากส่งคืนแบบพิมพ์ของ FedEx Ground^® Economy (เดิมเรียกว่า FedEx SmartPost^®) ฉลากการส่งคืนทางอีเมลของ FedEx Ground^® Economy (เดิมเรียกว่า FedEx SmartPost^®) และโปรแกรมส่งคืนพัสดุของ FedEx Ground^®
สำหรับลูกค้าที่มารับพัสดุตามกำหนดเวลาปกติ FedEx Ground จะให้บริการรับพัสดุเมื่อมีการร้องขอจากที่อยู่อื่นนอกเหนือจากสถานที่จัดส่งของหมายเลขบัญชี FedEx Ground และมีค่าธรรมเนียมการรับพัสดุสำหรับที่อยู่สำรองเพิ่มเติมต่อที่อยู่ที่ไม่ซ้ำกันต่อสัปดาห์สำหรับบริการนี้

FedEx Extra Hours

มีบริการ FedEx Extra Hours ในการรับพัสดุด้วยการส่งข้ามคืน 1 วันในวันจันทร์ถึงวันศุกร์ ทำให้ผู้ค้าปลีกสามารถจัดการกับคำสั่งซื้อในช่วงเย็นด้วยการจัดส่งในพื้นที่ของ FedEx Express ในวันถัดไปได้

สำหรับข้อมูลเพิ่มเติมเกี่ยวกับบริการที่มีให้ โปรดไปที่ fedex.com

API สำหรับการนัดเข้ารับพัสดุทำงานอย่างไร

ต่อไปนี้คือตัวเลือกการรับพัสดุที่มีใน API สำหรับการนัดเข้ารับพัสดุ:

ตรวจสอบความพร้อมในการมารับพัสดุ

ใช้ปลายทางนี้เพื่อขอรายละเอียดกำหนดเวลารับพัสดุ

ข้อมูลสำคัญที่เกี่ยวข้องกับคำขอนี้ได้แก่:

ที่อยู่รับพัสดุ/ รายละเอียดที่ทำการไปรษณีย์
ประเภทคำขอรับพัสดุ (เช่น วันเดียวกัน/ วันที่ในอนาคต)
ผู้ให้บริการขนส่งของ FedEx สำหรับการรับพัสดุ (เช่น แบบด่วน/ แบบภาคพื้นดิน)
ไม่ว่าจะเป็นการรับพัสดุในหรือต่างประเทศก็ตาม

การตอบรับที่สำเร็จของคำขอนี้จะส่งคืนรายละเอียดกำหนดเวลารับพัสดุ เช่น เวลาตัดยอดสำหรับการรับพัสดุ วันที่เข้ารับพัสดุ เวลาเข้ารับพัสดุ เวลาที่พร้อมให้เข้ารับพัสดุเริ่มต้น และรายละเอียดกำหนดเวลาที่พร้อมให้เข้ารับพัสดุอื่นๆ นอกจากนี้ยังส่งคืนข้อผิดพลาดและคำอธิบายในกรณีที่เกิดความล้มเหลว

สร้างการรับพัสดุ

ใช้ปลายทางนี้เพื่อสร้างคำขอรับพัสดุสำหรับบรรจุภัณฑ์ที่ต้องการให้เข้าไปรับพัสดุ

ข้อมูลสำคัญที่เกี่ยวข้องกับคำขอนี้ได้แก่:

จะมีการเรียกเก็บเงินสำหรับการรับพัสดุตามหมายเลขบัญชี FedEx
รายละเอียดต้นทาง (ที่อยู่ สถานที่ และประเภทที่อยู่เพื่อเข้ารับพัสดุ เช่น บัญชี/ ผู้จัดส่ง/ อื่นๆ)
ผู้ให้บริการขนส่งของ FedEx สำหรับการรับพัสดุ (แบบด่วน/ แบบภาคพื้นดิน)
รายละเอียดที่อยู่สำหรับบัญชีที่เกี่ยวข้อง

คำขอรับพัสดุที่สำเร็จจะส่งคืนหมายเลขการยืนยันการรับพัสดุ การแจ้งเตือนนัดรับพัสดุ และรหัสสถานที่สำหรับการรับพัสดุที่กำหนด นอกจากนี้ยังส่งคืนข้อผิดพลาดและคำอธิบายในกรณีที่เกิดความล้มเหลว

ยกเลิกการรับพัสดุ

ใช้คำขอนี้เพื่อยกเลิกคำขอรับพัสดุที่กำหนดเวลาแล้ว

ข้อมูลสำคัญที่เกี่ยวข้องกับคำขอนี้ได้แก่:

รหัสยืนยันการรับพัสดุ (ได้รับขณะส่งคำขอรับพัสดุ)
ผู้ให้บริการขนส่งของ FedEx สำหรับการรับพัสดุ (แบบด่วน/ แบบภาคพื้นดิน)
วันที่ที่กำหนด (วันที่เข้ารับพัสดุ)
สถานที่ (สำนักงานของ FedEx Express รับผิดชอบในการดำเนินการตามคำขอรับพัสดุ)

การยกเลิกการรับพัสดุที่สำเร็จจะส่งคืนหมายเลขยืนยันและข้อความยืนยันการยกเลิกการรับพัสดุ นอกจากนี้ยังส่งคืนข้อผิดพลาดและคำอธิบายในกรณีที่เกิดความล้มเหลว

หมายเหตุ: ส่งหมายเลขการยืนยันการรับพัสดุและรหัสสถานที่ที่เกี่ยวข้อง (ใช้กับ FDXE เท่านั้น) เพื่อยกเลิกการรับพัสดุที่กำหนดเวลาแล้ว จะได้รับหมายเลขการยืนยันการรับพัสดุและรหัสสถานที่ที่เกี่ยวข้อง (ใช้กับ FDXE เท่านั้น) ขณะส่งคำขอรับพัสดุ โดยระบบจะส่งการแจ้งเตือนความล้มเหลว หากคุณพยายามยกเลิกการรับพัสดุหลังจากที่ผู้รับส่งพัสดุของ FedEx ดำเนินการจัดส่งพัสดุไปยังสถานที่รับพัสดุแล้ว

กฎการดำเนินธุรกิจ

หากต้องการให้ไปรับพัสดุที่ประเทศอื่น ต้องใส่องค์ประกอบของประเทศดังกล่าวพร้อมรหัสประเทศที่เหมาะสมที่คุณต้องการให้ FedEx ไปรับพัสดุของคุณ
FedEx จะส่งคืนหมายเลขยืนยันการจัดส่งสำหรับคำขอจัดส่งที่สำเร็จ โดยควรจำกัดคำขอจัดส่งให้ไม่เกินหนึ่งคำขอต่อวัน เว้นแต่คุณจะเพิ่มพัสดุที่มีขนาดหรือน้ำหนักเกินกว่าคำขอเดิม
คำขอจัดส่งอาจล้มเหลวหากคุณป้อนกรอบเวลาที่ไม่เพียงพอระหว่างเวลาที่พร้อมสำหรับพัสดุและเวลาปิดทำการ หากคุณมีคำถามเกี่ยวกับเวลารับพัสดุ กรุณาติดต่อสายด่วนฝ่ายสนับสนุนของ FedEx ประจำภูมิภาคของคุณ
API สำหรับการนัดเข้ารับพัสดุรองรับประเภทน้ำหนักเป็น “ปอนด์″ และ ″กก.″ โดยหน่วยน้ำหนักสำหรับพัสดุและสินค้าควรเหมือนกัน มิฉะนั้น คำขอจะเกิดข้อผิดพลาดได้
หากคุณต้องการกำหนดเวลารับพัสดุสำหรับพัสดุของ FedEx Express (รวมถึงการจัดส่งภายในเม็กซิโก) และ FedEx Ground คุณจะต้องกำหนดเวลารับพัสดุหนึ่งรายการต่อผู้ให้บริการจัดส่งแต่ละรายแยกกัน
หากสถานที่รับพัสดุของคุณอยู่ในสถานที่ห่างไกล ต้องตรวจสอบให้แน่ใจก่อนว่าพัสดุของคุณรองรับการกำหนดการรับพัสดุจากสถานที่ห่างไกล
ต้องระบุเวลาที่ช้าที่สุดที่สามารถเข้าไปรับพัสดุของคุณได้เสมอ (หรือเวลาปิดทำการของบริษัทของคุณ)
มีบริการรับพัสดุในวันเสาร์ในบางพื้นที่ทั่วโลกสำหรับพัสดุ FedEx Express ของคุณ และยังมีบริการส่งสินค้าในวันเสาร์ที่ศูนย์บริการ FedEx อีกหลายแห่ง โดยใช้ปลายทางของบริการจากศูนย์บริการเพื่อรับรายการสถานที่สำหรับส่งสินค้าในวันเสาร์
สำหรับการรับพัสดุของ FedEx Ground และ FedEx Express คุณสามารถขอที่อยู่สำรองสำหรับการรับพัสดุนอกเหนือจากสถานที่จัดส่งที่แนบมากับหมายเลขบัญชี FedEx ของคุณได้
หากคุณต้องการใช้บริการรับพัสดุตามปกติของ FedEx Express หรือ FedEx Ground กรุณาติดต่อเจ้าหน้าที่บริการบัญชีลูกค้า FedEx ของคุณ
คุณสามารถยกเลิกการรับพัสดุ FedEx Express หรือ FedEx Ground ได้ก็ต่อเมื่อ:
- ยังไม่ถึงเวลาที่พร้อมให้ไปรับพัสดุตามที่ร้องขอ และ
- ผู้ให้บริการขนส่งยังไม่ได้ดำเนินการจัดส่ง

คอลเล็กชัน JSON API

Pickup Request API (1.0.0)

Create Pickup

Use this endpoint to create a pickup request for a package.
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

Full_Schema_Create_Pickup
Create_Pickup_Ground
Create_Pickup_Express
MinimumSamplePayload-ExpressFreightPickup

associatedAccountNumber required	object (AccountNumber) This is the FedEx account number. Example: Your account number
originDetail required	object The origin address if different than the one associated with the shipper account. This element value is required when the package is to be picked up from an address other than the shipper account address.
associatedAccountNumberType	string This enumeration represents a kind of legacy account number from a FedEx operating entity for the account number associated to the pickup. Valid values are: FEDEX_EXPRESS FEDEX_GROUND
totalWeight	object Specify The total weight of the packages for the pickup. Unit of measure is LB.
packageCount	integer <int32> Specify the total number of packages for the pickup. Example: 5
carrierCode required	string Enum: "FDXE" "FDXG" Specify the four letter code of a FedEx operating company that meets your requirements. Examples of FedEx Operating Comapnies are : FDXE- FedEx Express FDXG- FedEx Ground
accountAddressOfRecord	object The city name, state or province code and the address classification associated with the customer account which requested the pickup.
remarks	string Placeholder for any message to be passed to the FedEx pickup courier. Note:Maximum length is 60 characters. Example: Please ring bell at loading dock.
countryRelationships	string Enum: "DOMESTIC" "INTERNATIONAL" Describes the country relationship among the shipments being picked up. This element is not mandatory for this request, but when added, the mandatory values are DOMESTIC or INTERNATIONAL. Empty or incorrect values will result in to errors.
pickupType	string Indicate the pickup type method by which the shipment to be tendered to FedEx. Note: The value of this element does not specify dispatching the courier for package pickup. Example: ON_CALL, PACKAGE_RETURN_PROGRAM, REGULAR_STOP Click here for more information on Pickup Types.
trackingNumber	string This is a Tracking number for FedEx packages used for tracking a single package or group of packages. Example: 795803657326 Click here to see mock tracking numbers for FedEx Express and FedEx Ground.
commodityDescription	string Description of the commodity being shipped. Example:This field contains Commodity Description. Click here to see Vague commodity descriptions
expressFreightDetail	object Placeholder for Express Freight pickup details.
oversizePackageCount	integer <int32> Specify the number of oversize packages that are tendered to FedEx Ground.
pickupNotificationDetail	object This object allows user to request for pickup confirmation email. User can specify upto 5 email addresses.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /pickup/v1/pickups

Sandbox Server

https://apis-sandbox.fedex.com/pickup/v1/pickups

Production Server

https://apis.fedex.com/pickup/v1/pickups

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"associatedAccountNumber":
{
- "value": "Your account number"
},
"originDetail":
{
- "pickupAddressType": "ACCOUNT",
- "pickupLocation":
  {
  - "contact":
    {
    "companyName": "Fedex",
    "personName": "John Taylor",
    "phoneNumber": "7194446666",
    "phoneExtension": "phone extension"
    },
  - "address":
    {
    "streetLines":
    [
    "123 Ship Street",
    "Suite 302"
    ],
    "urbanizationCode": "URB FAIR OAKS",
    "city": "Memphis",
    "stateOrProvinceCode": "TN",
    "postalCode": "38017",
    "countryCode": "US",
    "residential": false,
    "addressClassification": "MIXED"
    },
  - "accountNumber":
    {
    "value": "XXX289837"
    },
  - "deliveryInstructions": "deliveryInstructions"
  },
- "readyDateTimestamp": "2020-04-02T11:00:00Z",
- "customerCloseTime": "18:00:00",
- "pickupDateType": "SAME_DAY",
- "packageLocation": "FRONT",
- "buildingPart": "APARTMENT",
- "buildingPartDescription": "111",
- "earlyPickup": false,
- "suppliesRequested": "Supplies requested by customer",
- "geographicalPostalCode": "geographicalPostalCode"
},
"associatedAccountNumberType": "FEDEX_GROUND",
"totalWeight":
{
- "units": "KG",
- "value": 20
},
"packageCount": 5,
"carrierCode": "FDXE",
"accountAddressOfRecord":
{
- "streetLines":
  [
  - "123 Ship Street"
  ],
- "city": "Memphis",
- "stateOrProvinceCode": "TN",
- "postalCode": "38017",
- "countryCode": "US",
- "residential": false,
- "addressClassification": "MIXED"
},
"remarks": "Please ring bell at loading dock.",
"countryRelationships": "DOMESTIC",
"pickupType": "ON_CALL, PACKAGE_RETURN_PROGRAM, REGULAR_STOP.",
"trackingNumber": "795803657326",
"commodityDescription": "This field contains CommodityDescription",
"expressFreightDetail":
{
- "truckType": "DROP_TRAILER_AGREEMENT",
- "service": "FEDEX_1_DAY_FREIGHT",
- "trailerLength": "TRAILER_28_FT",
- "bookingNumber": "1234AGTT",
- "dimensions":
  {
  - "length": 20,
  - "width": 15,
  - "height": 12,
  - "units": "CM"
  }
},
"oversizePackageCount": 2,
"pickupNotificationDetail":
{
- "emailDetails":
  [
  - {
    "address": "sample@gmail.com",
    "locale": "en_US"
    }
  ],
- "format": "HTML",
- "userMessage": "This is the user message"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "pickupConfirmationCode": "3001",
- "message": "Courier on the way",
- "location": "COSA",
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Check Pickup Availability

Use this endpoint to check the availability of a pickup service.
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

Full_Schema_Pickup_Availability
Check_Pickup_Availability_Domestic_Express
Check_Pickup_Availability_Domestic_Ground
Check_Pickup_Availability_International_Express

pickupAddress required	object (PickupAddress) Specify the address for which pickup availability inquiry has been made.
dispatchDate	string Specify the date the package is to be picked up. The format is YYYY-MM-DD. If left blank, the system considers current date as dispatch date. Example: 2020-01-01
packageReadyTime	string Specify the time that the package will be ready for pickup. The time format is HH:MM:SS and it refers to the local timezone. The driver should pick up the package/shipment by the given pickup time. Example: 15:00:00
customerCloseTime	string Specify the latest time the driver gets access to pick up the package. The time format is in HH:MM:SS and it refers to the local timezone. The driver should pick up the package by the given pickup time. Example: 18:00:00
pickupType	string Enum: "ON_CALL" "TAG" Indicate the pickup type method by which the shipment to be tendered to FedEx. Note: The value of this element does not specify dispatching the courier for package pickup. Click here for more information on Pickup Types.
pickupRequestType required	Array of strings Items Enum: "SAME_DAY" "FUTURE_DAY" Specify pickup request type.
shipmentAttributes	object (ShipmentAttributes) Specify the shipment details, such as service type, packaging type, weight and dimensions. Note: serviceType is required for domestic or international pickup availabilities.
numberOfBusinessDays	integer <int32> Specify number of business days to consider when checking availability. For example if you are indicating pickupDate for a Saturday and you indicate 3, Saturday, Sunday and Monday will be considered. Example: 3
packageDetails	Array of objects (RequestedPickupPackageDetail) This object is used to specify the package details.
associatedAccountNumber	string The associated account number, which will be invoiced for the pickup. Example:613787364.
associatedAccountNumberType	string Enum: "FEDEX_EXPRESS" "FEDEX_GROUND" This represents a kind of legacy account number from a FedEx operating entity for the account number associated to the pickup. Valid values are: FEDEX_EXPRESS FEDEX_GROUND
carriers required	Array of strings Items Enum: "FDXE" "FDXG" Specify the four letter code of a FedEx operating company thet meets your requirements. Examples of FedEx Operating Companies are: FDXE - FedEx Express FDXG - FedEx Ground
countryRelationship required	string Enum: "DOMESTIC" "INTERNATIONAL" Specify the country relationship among the shipments being picked up. Empty or incorrect values will result in to errors. Note: shipmentAttributes/serviceType* is required for domestic or international pickup availabilities.*

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /pickup/v1/pickups/availabilities

Sandbox Server

https://apis-sandbox.fedex.com/pickup/v1/pickups/availabilities

Production Server

https://apis.fedex.com/pickup/v1/pickups/availabilities

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"pickupAddress":
{
- "streetLines":
  [
  - "123 Ship Street"
  ],
- "urbanizationCode": "URB FAIR OAKS",
- "city": "Memphis",
- "stateOrProvinceCode": "TN",
- "postalCode": "38017",
- "countryCode": "US",
- "residential": false,
- "addressClassification": "MIXED"
},
"dispatchDate": "2020-10-14",
"packageReadyTime": "15:30:00",
"customerCloseTime": "18:00:00",
"pickupType": "ON_CALL",
"pickupRequestType":
[
- "SAME_DAY"
],
"shipmentAttributes":
{
- "serviceType": "FEDEX_FREIGHT_PRIORITY",
- "weight":
  {
  - "units": "KG",
  - "value": 20
  },
- "packagingType": "YOUR_PACKAGING",
- "dimensions":
  {
  - "length": 7,
  - "width": 8,
  - "units": "CM",
  - "height": 9
  }
},
"numberOfBusinessDays": 1,
"packageDetails":
[
- {
  - "packageSpecialServices":
    {
    "specialServiceTypes":
    [
    "SIGNATURE_OPTION"
    ]
    }
  }
],
"associatedAccountNumber": "613787364",
"associatedAccountNumberType": "FEDEX_EXPRESS",
"carriers":
[
- "FDXE"
],
"countryRelationship": "INTERNATIONAL"

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "requestTimestamp": "2020-04-02T04:19:00",
- "options":
  [
  - {
    "carrier": "FDXE",
    "available": true,
    "pickupDate": "2019-01-20",
    "cutOffTime": "18:30:00",
    "accessTime":
    {
    "hours": 1,
    "minutes": 30
    },
    "residentialAvailable": true,
    "countryRelationship": "INTERNATIONAL",
    "scheduleDay": "SAME_DAY",
    "defaultReadyTime": "14:00:00",
    "defaultLatestTimeOptions": "19:00:00",
    "earlyCutOffTime": "14:30:00",
    "earlyAccessTime":
    {
    "hours": 1,
    "minutes": 30
    },
    "earlyPickupLocationId": "PITA",
    "readyTimeOptions":
    [
    "11:00:00"
    ],
    "latestTimeOptions":
    [
    "12:00:00"
    ]
    }
  ],
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Cancel Pickup

Use this endpoint to cancel the already scheduled pickup request.
Note: A failure notification will be sent if you attempt to cancel a pickup after the FedEx courier has been dispatched to the pickup location.
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

Full_Schema_Cancel_Pickup
Cancel_Pickup_Ground
Cancel_Pickup_Express

associatedAccountNumber required	object (AccountNumber) This is the FedEx account number. Example: Your account number
pickupConfirmationCode required	string The confirmation number provided by FedEx to the customer when the pickup was scheduled or requested. Example: 7
remarks	string Placeholder for any message to be passed to the FedEx pickup courier. Note:Maximum length is 60 characters. Example: Please ring bell at loading dock.
carrierCode	string Enum: "FDXE" "FDXG" This is a placeholder to provide the FedEx operating company (transportation) code used for package delivery. Required for FedEx Ground. Optional for FedEx Express. The Default is FedEx Express i.e. FDXE.
accountAddressOfRecord	object (AccountAddressOfRecord) Address details for the associated pickup account. Indicates if the address is residential. Specifies the city name, country code, streetline number, postal code, address verification Identifier, and state or province code.
scheduledDate required	string Indicates the date the pickup dispatch occurs. Format YYYY-MM-DD Example: 2019-10-15
location	string The FedEx Express location identifier responsible for processing the pickup request. This is returned in the CreatePickup response and is required to cancel a FedEx Express dispatch.Required only for FedEx Express Pickups. Optional for FedEx Ground. Example: LOSA

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /pickup/v1/pickups/cancel

Sandbox Server

https://apis-sandbox.fedex.com/pickup/v1/pickups/cancel

Production Server

https://apis.fedex.com/pickup/v1/pickups/cancel

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"associatedAccountNumber":
{
- "value": "Your account number"
},
"pickupConfirmationCode": "7",
"remarks": "Please ring bell at loading dock.",
"carrierCode": "FDXE",
"accountAddressOfRecord":
{
- "streetLines":
  [
  - "123 Ship Street"
  ],
- "urbanizationCode": "URB FAIR OAKS",
- "city": "Memphis",
- "stateOrProvinceCode": "ON",
- "postalCode": "38017",
- "countryCode": "US",
- "residential": false,
- "addressClassification": "MIXED"
},
"scheduledDate": "2019-10-15",
"location": "LOSA"

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "pickupConfirmationCode": "NQAA97",
- "cancelConfirmationMessage": "Requested pickup has been cancelled Successfully.",
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Request
Response

Response

Copy

Developer Portal

Pickup Request API

บทนำ

รายละเอียด API สำหรับการนัดเข้ารับพัสดุ

API สำหรับการนัดเข้ารับพัสดุทำงานอย่างไร

กฎการดำเนินธุรกิจ

คอลเล็กชัน JSON API

Pickup Request API (1.0.0)

Create Pickup

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Check Pickup Availability

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Cancel Pickup

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Enter your user ID and password to log in