Appointments

Appointments 1.0.0

0
No votes yet
forum Discuss this API in the forum
development
https://api-sandbox.supplychain.fedex.com/api/sandbox

Paths

/availableSlots

post /availableSlots
To use this operation you must use one of the following sets of security requirements.
oauth2
oauth2
(oauth2 accessCode)

Enter Access token

Authorization URL
https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/authorize
Token URL
https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/token
Scopes
Fulfillment_Returns
Read/Write access to Orders, Items, RMAs, Inventory,ASN ,Inbound Shipments and Appointments objects
Client_Id
X-IBM-Client-Id
(apiKey located in header)

Enter Client ID

Client_Secret
X-IBM-Client-Secret
(apiKey located in header)

Enter Client Secret

availableSlots_json_body
Required in body
object

Sample Json Request:{ "appointmentType":"Live Load", "appointmentDates":[01/08/2019,01/09/2019], "facility":"HFY", "loadType":"", "trailerType":"", "palletHeight":"", "numberOfPallets":"", }

{
    "schema": {
        "type": "object"
    }
}
AccessToken
Optional in header
string

Please pass access token, It is mandatory field

Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
POST https://api-sandbox.supplychain.fedex.com/api/sandbox/v1/availableSlots
Try this operation
https://api-sandbox.supplychain.fedex.com/api/sandbox/v1/availableSlots
content-type
accept
AccessToken

/appointments

post /appointments

This API creates appointments for the facility and dates provided in the request

To use this operation you must use one of the following sets of security requirements.
oauth2
oauth2
(oauth2 accessCode)

Enter Access token

Authorization URL
https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/authorize
Token URL
https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/token
Scopes
Fulfillment_Returns
Read/Write access to Orders, Items, RMAs, Inventory,ASN ,Inbound Shipments and Appointments objects
Client_Secret
X-IBM-Client-Secret
(apiKey located in header)

Enter Client Secret

Client_Id
X-IBM-Client-Id
(apiKey located in header)

Enter Client ID

appointments_json_body
Required in body
object

Sample Json Request:{ "appointmentType": "Live Unload", "facility": "HFY", "appointmentDttm" :"2019-06-8T00:00:00-05:00", "duration": 120, "objectType": "ASN", "objectIds": ["12223","3333","4444"], "loadType": "Pallets", "trailerType": "LTL", "palletHeight": "7 ft", "numberOfPallets": 1, "numberOfCases": 100, "singleSkuFlag": True, "trailerNumber": "123", "notes": "" }

{
    "schema": {
        "type": "object"
    }
}
AccessToken
Optional in header
string

Enter AccessToken, it is mandatory in case of basic authentication.

Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
POST https://api-sandbox.supplychain.fedex.com/api/sandbox/v1/appointments
Try this operation
https://api-sandbox.supplychain.fedex.com/api/sandbox/v1/appointments
content-type
accept
AccessToken
get /appointments

This API retrieves a list of appointment objects or an individual appointment object in the Platform

To use this operation you must use one of the following sets of security requirements.
oauth2
oauth2
(oauth2 accessCode)

Enter Access token

Authorization URL
https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/authorize
Token URL
https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/token
Scopes
Fulfillment_Returns
Read/Write access to Orders, Items, RMAs, Inventory,ASN ,Inbound Shipments and Appointments objects
Client_Secret
X-IBM-Client-Secret
(apiKey located in header)

Enter Client Secret

Client_Id
X-IBM-Client-Id
(apiKey located in header)

Enter Client ID

AccessToken
Optional in header
string

Enter AccessToken, it is mandatory in case of basic authentication.

query_params
Required in query
string

Enter all the query parameters. Sample:-appointmentId=010201-031219-355,010201-031219-357

Accept
Optional in header
string
application/json
fsc-api-admin@fedex.com
satayoday.sinha@fedex.com
200

200 OK

Example Request
Example Response
GET https://api-sandbox.supplychain.fedex.com/api/sandbox/v1/appointments
Try this operation
https://api-sandbox.supplychain.fedex.com/api/sandbox/v1/appointments
accept
AccessToken
query_params

/appointments/{appointmentId}

put /appointments/{appointmentId}

This API updates an existing appointment. If the appointment cannot be updated, the API call will return an error

To use this operation you must use one of the following sets of security requirements.
oauth2
oauth2
(oauth2 accessCode)

Enter Access token

Authorization URL
https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/authorize
Token URL
https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/token
Scopes
Fulfillment_Returns
Read/Write access to Orders, Items, RMAs, Inventory,ASN ,Inbound Shipments and Appointments objects
Client_Secret
X-IBM-Client-Secret
(apiKey located in header)

Enter Client Secret

Client_Id
X-IBM-Client-Id
(apiKey located in header)

Enter Client ID

appointmentId
Required in path
string

appointmentId as input parameter

AccessToken
Optional in header
string

Mandatory access token

UpdateAppointments_json_body
Required in body
object

Sample Json Request:{ "appointmentType": "Live Unload", "facility": "HFY", "appointmentDttm" :"2019-06-8T00:00:00-05:00", "duration": 120, "objectType": "ASN", "objectIds": ["12223","3333","4444"], "loadType": "Pallets", "trailerType": "LTL", "palletHeight": "7 ft", "numberOfPallets": 1, "numberOfCases": 100, "singleSkuFlag": True, "trailerNumber": "123", "notes": "" }

{
    "schema": {
        "type": "object"
    }
}
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
PUT https://api-sandbox.supplychain.fedex.com/api/sandbox/v1/appointments/{appointmentId}
Try this operation
https://api-sandbox.supplychain.fedex.com/api/sandbox/v1/appointments/{appointmentId}
content-type
accept
AccessToken
appointmentId

/appointments/{appointmentId}/cancel

post /appointments/{appointmentId}/cancel

This API cancels an existing appointment. If the appointment cannot be canceled, the API call will return an error

To use this operation you must use one of the following sets of security requirements.
oauth2
oauth2
(oauth2 accessCode)

Enter Access token

Authorization URL
https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/authorize
Token URL
https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/token
Scopes
Fulfillment_Returns
Read/Write access to Orders, Items, RMAs, Inventory,ASN ,Inbound Shipments and Appointments objects
Client_Secret
X-IBM-Client-Secret
(apiKey located in header)

Enter Client Secret

Client_Id
X-IBM-Client-Id
(apiKey located in header)

Enter Client ID

AccessToken
Optional in header
string

Enter AccessToken, it is mandatory in case of basic authentication.

appointmentId
Required in path
string

Enter appointmentId

UpdateAppointments_json_body
Required in body
object

Sample Json Request:-{ "cancellationReason": "CLT", "cancellationNotes": "Carrier is arriving late" }

{
    "schema": {
        "type": "object"
    }
}
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
fsc-api-admin@fedex.com
satayoday.sinha@fedex.com
200

200 OK

Example Request
Example Response
POST https://api-sandbox.supplychain.fedex.com/api/sandbox/v1/appointments/{appointmentId}/cancel
Try this operation
https://api-sandbox.supplychain.fedex.com/api/sandbox/v1/appointments/{appointmentId}/cancel
content-type
accept
AccessToken
appointmentId