Get Labels

The Labels API provides the capability of retrieving FedEx labels for a given label ID.

Swagger

			
swagger: '2.0'
info:
  x-ibm-name: label
  title: Label
  version: 1.0.0
schemes:
  - https
host: $(catalog.host)
basePath: /v1
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  oauth2:
    type: oauth2
    description: ''
    flow: accessCode
    authorizationUrl: 'https://<............................>/fsc/oauth2/authorize'
    scopes:
      Fulfillment_Returns: ''
    tokenUrl: 'https://<............................>/fsc/oauth2/token'
  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_Id: []
    Client_Secret: []
    oauth2:
      - Fulfillment_Returns
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /labels/{labelId}:
    get:
      responses:
        '200':
        description: 200 OK      
    deprecated: false
    parameters:    
    - name: accessToken
      type: string
      required: false
      in: header
      description: 'Enter AccessToken, it is mandatory.'
    - name: labelId
      type: string
      required: true
        in: path
        description: '12701'
		summary: Label
		description: The Labels API provides the capability of retrieving FedEx labels for a given label ID.
			
		

Sample Request

			
	•	Retrieve all lables details using lableId
	https://<........>/api/v1/labels/15701
				Request Header	Accept: application/pdf.

					
				
			
		

Sample Response

Success Response

			Response will be the PDF file.
		

Sample Request

			
	•	Retrieve all lables details using lableId
	https://<........>/api/v1/labels/15701
				Request Header	No request header specified.

					
				
			
		

Sample Response

Success Response

			{
  "requestIdentifier" : "COM1482178",
  "transactionDate" : "2014-01-09T13:31:00-05:00",
  "status" : true,
  "labels" : [{
    "id" : "23094",
    "trackingNumber" : "79405496348",
    "labelContent" : "<…BASE64 CONTENT…>"
  },{
    "id" : "23095",
    "trackingNumber" : "79405496349",
    "labelContent" : "<…BASE64 CONTENT…>"
  }],
  "errors" : [{
      "code" : "ERR-LBL-0001",
      "description" : "Something went wrong"
    }
  ]
}
			
		

OAuth 2.0

Custom authentication

Query Parameters

Response Attribute

HTTP Status Code

Error Code