---
swagger: "2.0"
info:
  x-ibm-name: appointments
  title: Appointments
  version: 1.0.0
  description: ""
schemes:
- https
basePath: /v1
consumes:
- application/json
produces:
- application/json
- fsc-api-admin@fedex.com
- satayoday.sinha@fedex.com
securityDefinitions:
  oauth2:
    type: oauth2
    description: Enter Access token
    flow: accessCode
    scopes:
      Fulfillment_Returns: Read/Write access to Orders, Items, RMAs, Inventory,ASN
        ,Inbound Shipments and Appointments objects
    authorizationUrl: https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/authorize
    tokenUrl: https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/token
    x-tokenIntrospect:
      url: https://vp1npmqdp01-v1.genco.com:443/api/sandbox/fsc/oauth/introspect
  Client_Secret:
    type: apiKey
    description: Enter Client Secret
    in: header
    name: X-IBM-Client-Secret
  Client_Id:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
    description: Enter Client ID
security:
- Client_Secret: []
  oauth2:
  - Fulfillment_Returns
  Client_Id: []
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /availableSlots:
    post:
      responses:
        200:
          description: 200 OK
      parameters:
      - name: availableSlots_json_body
        required: true
        in: body
        schema:
          type: object
        description: Sample Json Request:{     "appointmentType":"Live Load",     "appointmentDates":[01/08/2019,01/09/2019],     "facility":"HFY",     "loadType":"",     "trailerType":"",     "palletHeight":"",     "numberOfPallets":"",
          }
      - name: AccessToken
        type: string
        required: false
        in: header
        description: Please pass access token, It is mandatory field
      consumes:
      - application/json
      produces:
      - application/json
      security:
      - oauth2:
        - Fulfillment_Returns
      - Client_Id: []
        Client_Secret: []
  /appointments:
    post:
      responses:
        200:
          description: 200 OK
      summary: This API creates appointments for the facility and dates provided in
        the request
      parameters:
      - name: appointments_json_body
        required: true
        in: body
        schema:
          type: object
        description: '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": ""     }'
      - name: AccessToken
        type: string
        required: false
        in: header
        description: Enter AccessToken, it is mandatory in case of basic authentication.
      security:
      - oauth2:
        - Fulfillment_Returns
      - Client_Secret: []
        Client_Id: []
      consumes:
      - application/json
      produces:
      - application/json
    get:
      responses:
        200:
          description: 200 OK
      summary: This API retrieves a list of appointment objects or an individual appointment
        object in the Platform
      parameters:
      - name: AccessToken
        type: string
        required: false
        in: header
        description: Enter AccessToken, it is mandatory in case of basic authentication.
      - name: query_params
        type: string
        required: true
        in: query
        description: Enter all the query parameters. Sample:-appointmentId=010201-031219-355,010201-031219-357
      security:
      - oauth2:
        - Fulfillment_Returns
      - Client_Secret: []
        Client_Id: []
  /appointments/{appointmentId}:
    put:
      responses:
        200:
          description: 200 OK
      summary: This API updates an existing appointment. If the appointment cannot
        be updated, the API call will return an error
      parameters:
      - name: appointmentId
        type: string
        required: true
        in: path
        description: appointmentId as input parameter
      - name: AccessToken
        type: string
        required: false
        in: header
        description: Mandatory access token
      - name: UpdateAppointments_json_body
        required: true
        in: body
        schema:
          type: object
        description: '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": ""     }'
      security:
      - oauth2:
        - Fulfillment_Returns
      - Client_Secret: []
        Client_Id: []
      consumes:
      - application/json
      produces:
      - application/json
  /appointments/{appointmentId}/cancel:
    post:
      responses:
        200:
          description: 200 OK
      summary: This API cancels an existing appointment. If the appointment cannot
        be canceled, the API call will return an error
      parameters:
      - name: AccessToken
        type: string
        required: false
        in: header
        description: Enter AccessToken, it is mandatory in case of basic authentication.
      - name: appointmentId
        type: string
        required: true
        in: path
        description: Enter appointmentId
      - name: UpdateAppointments_json_body
        required: true
        in: body
        schema:
          type: object
        description: 'Sample Json Request:-{     "cancellationReason": "CLT",     "cancellationNotes":
          "Carrier is arriving late" }'
      security:
      - oauth2:
        - Fulfillment_Returns
      - Client_Secret: []
        Client_Id: []
tags: []
x-ibm-endpoints:
- endpointUrl: https://api-sandbox.supplychain.fedex.com/api/sandbox
  type:
  - development
...