Get Inbound Shipment

This API retrieves a shipment or list of shipments, based on the query parameters provided in the request.

Swagger

         
swagger: '2.0'
info:
  x-ibm-name: inboundShipments
  title: InboundShipments
  version: 1.0.0
  description: 'The Inbound Shipments API provides the capability of creating a new shipment, updating a shipment, canceling a shipment and getting a list of shipments or a specific shipment. Once the shipment is created in the system, it will be processed and sent to the warehouse to provide notice to the operations team.'
schemes:
  - https
host: $(catalog.host)
basePath: /v1
consumes:
  - application/json
produces:
  - application/json
  - fsc-api-admin@fedex.com
securityDefinitions:
  Client_Secret:
    type: apiKey
    description: Enter Client Secret
    in: header
    name: X-IBM-Client-Secret
  oauth2:
    type: oauth2
    description: ''
    flow: accessCode
    scopes:
      Fulfillment_Returns: "Read/Write access to Orders, Items, RMAs, Inventory,ASN  and 1.1\tInbound Shipments objects"
    authorizationUrl: 'https://<.........................>/fsc/oauth2/authorize'
    tokenUrl: 'https://<.........................>/fsc/oauth2/token'    
  Client_Id:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
    description: Enter Client ID
security:
  - Client_Id: []
    oauth2:
      - Fulfillment_Returns
    Client_Secret: []
x-ibm-configuration:
  testable: true
  enforced: true
paths:
  /inboundShipments:
    get:
      responses:
        '200':
          description: 200 OK
      summary: Get Inbound Shipment details
      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:  createdTimestamp=gt|2016-09-21T14:30:59-05:00&responseFilter=All&pageLimit=5'
      security:
        - oauth2:
            - Fulfillment_Returns
        - Client_Id: []
          Client_Secret: []
      consumes:
        - application/json
      description: 'This API retrieves a shipment or list of shipments, based on the query parameters provided in the request.'

      

Sample Request

         
	•	Retrieve shipment details using shipmentId.
	https://<........>/api/v1/inboundShipments?shipmentId=0001-062417-001,0001-062417-002, 0001-062417-002,0001-062417-003,0001-062417-004
	•	Retrieve only basic shipment details of inbound shipment created on or after the time stamp provided. 
	https://<........>/api/v1/ inboundShipments?createdTimestamp=ge|2016-09-21T14:30:59-05:00&responseFilter=Basic
	•	Retrieve basic and Lpn details of inbound shipments that are either in In Transit or Receiving or Complete.
	https://<........>/api/v1/ inboundShipments?orderStatus=In Transit,Receiving,Complete&responseFilter=Basic,Lpn

 
      

Sample Response

Success Response

         


{
  "requestIdentifier": "01749ea2-4b8f-4f3d-a9dc-f0b862a3d72e",
  "transactionDate": "2017-01-20T15:12:54-05:00",
  "inboundShipments": [
    {
      "shipmentId": "0001-063017-0001",
      "shipmentName": "FedExShipment01",
      "status": "Complete",
      "externalRefNumber": "32421-1314324-2131",
      "originFacility": {
        "facilityName": "My Location 1",
        "addressLine1": "100 Papercraft Avenue",
        "addressLine2": "Suite 100",
        "city": "Pittsburgh",
        "stateCode": "PA",
        "zipCode": "15238",
        "countryCode": "US",
        "contactName": "John Smith",
"contactPhoneCountryCode": "+1",
        "contactPhone": "2132331222",
        "contactEmailAddress": "origin.facility@gmail.com"
      },
      "destinationFacility": {
        "facilityCode": "HFY"
      },
      "products": [
        {
          "sku": "Fancy1",
          "quantityShipped": 2700,
          "quantityReceived": 2700
        },
        {
          "sku": "Fancy2",
          "quantityShipped": 2000,
          "quantityReceived": 2000
        }
      ],
      "lpns": [
        {
          "lpnType": "C",
          "lpnName": "Case 1",
          "numberOfLpns": 10,
          "customLpnIds": [],
          "dimension": {
            "length": 35.6,
            "width": 45.6,
            "height": 29
          },
          "weight": 32,
          "stackable": true,
          "lpnDetails": [
            {
              "sku": "Fancy1",
"quantity": 20,
              "batchLotNumber": "A131231",
              "expireDate": "2017-10-14",
              "purchaseOrderNumber": "324324214123421",
              "purchaseOrderLineItemId": "45453513515465"
            },
            {
              "sku": "Fancy2",
              "quantity": 200,
              "lotNumber": null,
              "expireDate": null,
              "purchaseOrderId": "324324214123421",
              "purchaseOrderLineItemId": "45453513515466"
            }
          ]
        },
        {
          "lpnType": "C",
          "lpnName": "Case 2",
          "numberOfLpns": 5,
          "customLpnIds": [
            "00000999990000128970",
            "00000999990000128971",
            "00000999990000128972",
            "00000999990000128973",
            "00000999990000128974"
          ],
          "dimension": {
            "length": 35.6,
            "width": 45.6,
            "height": 29
          },
          "weight": 32,
          "stackable": true,
          "lpnDetails": [
            {
              "sku": "Fancy1",
              "quantity": 500,
              "batchLotNumber": "A131231",
              "expireDate": "2017-10-15",
              "purchaseOrderId": "324324214123421",
              "purchaseOrderLineItemId": "45453513515466"
            }
          ]
        }
      ],
      "productLevelServices": {
        "sku": "sku001",
        "serviceLevelCode": "quality_audit_100",
        "serviceLevelDescription": "Counting"
      },
      "shipping": {
        "fedexManaged": false,
        "fedexShipment": false,
        "expectedArrivalDate": "2017-07-15",
        "carrierName": "FedEx",
        "contactName": "Walter White",
        "phoneCountryCode": "+1",
        "contactPhone": "2313223444",
        "trackingBOLNumbers": [
          "13432432421",
          "324231412342314"
        ],
        "pickupDate": "2017-06-20",
        "pickupStartTime": "18:00",
        "pickupEndTime": "23:50",
        "insidePickup": true,
        "liftGateAtPickup": false,
        "limitedAccess": false
      },
      "labels": [
        {
          "documents": [
            {
              "documentId": "1111",
              "trackingNumber": "79405496348",
              "documentType": "ShippingLabel"
            },
            {
              "documentId": "1112",
              "trackingNumber": "79405499810",
              "documentType": "ShippingLabel"
            },
            {
              "documentId": "1113",
              "documentType": "PackageLabel"
            },
            {
              "documentId": "1114",
              "documentType": "PackageLabel"
            },
            {
              "documentId": "1115",
              "documentType": "PackageLabel"
            }
          ]
        }
      ],
      "packingSlip": [
        {
          "id": "124345346",
          "content": "<…BASE64 CONTENT…>"
        }
      ]
    },
{
      "shipmentId": "0001-063017-0002",
      "shipmentName": "FedExShipment02",
      "status": "In Transit",
      "externalRefNumber": "44421-1314324-2009",
      "originFacility": {
        "facilityName": "My Location 1",
        "addressLine1": "100 Papercraft Avenue",
        "addressLine2": "Suite 100",
        "city": "Pittsburgh",
        "stateCode": "PA",
        "zipCode": "15238",
        "countryCode": "US".
        "contactName": "John Smith",
        "contactPhoneCountryCode": "+1",
        "contactPhone": "2132331222",
        "contactEmailAddress": "origin.facility@gmail.com"
      },
      "destinationFacility": {
        "facilityCode": "HFY"
      },
      "products": [
        {
          "sku": "Fancy1",
          "quantityShipped": 2700,
          "quantityReceived": null
        },
        {
          "sku": "Fancy2",
          "quantityShipped": 2000,
          "quantityReceived": null
        }
      ],
      "lpns": [
        {
          "lpnType": "P",
          "lpnName": "Pallet 1",
          "numberOfLpns": 10,
          "customLpnIds": [],
          "dimension": {
            "length": 35.6,
            "width": 45.6,
            "height": 29
          },
          "weight": 12,
          "stackable": true,
          "lpnDetails": [
            {
              "sku": "Fancy1",
              "quantity": 20,
              "batchLotNumber": "A131231",
              "expireDate": "2017-10-14",
              "purchaseOrderId": "324324214123421",
              "purchaseOrderLineItemId": "324324214123421"
            },
            {
              "sku": "Fancy2",
              "quantity": 200,
              "lotNumber": null,
              "expirationDate": null,
              "purchaseOrderNumber": "324324214123421",
              "purchaseOrderLineItemId": "324324214123421"
            }
          ]
        },
        {
          "lpnType": "P",
          "lpnName": "Pallet 2",
          "numberOfLpns": 5,
          "customLpnIds": [
            "00000999990000128970",
            "00000999990000128971",
            "00000999990000128972",
            "00000999990000128973",
            "00000999990000128974"
          ],
          "dimension": {
            "length": 35.6,
            "width": 45.6,
            "height": 19
          },
          "weight": 12,
          "stackable": true,
          "lpnDetails": [
            {
              "sku": "Fancy1",
              "quantity": 500,
              "lotNumber": "A131231",
              "expirationDate": "2017-10-15",
              "purchaseOrderNumber": "324324214123421",
              "purchaseOrderLineItemId": "324324214123421"
            }
          ]
        }
      ],
      "productLevelServices": [
        {
          "sku": "Fancy1",
          "serviceLevelCode": "quality_audit_100",
          "serviceLevelDescription": "Counting"
        },
        {
          "sku": "Fancy1",
          "serviceLevelCode": "dust_bag_medium",
          "serviceLevelDescription": "Dust bag - medium"
},
        {
          "sku": "Fancy2",
          "serviceLevelCode": "dust_bag_large",
          "serviceLevelDescription": "Dust bag - large"
        }
      ],
      "shipping": {
        "fedexManaged": true,
        "freightShipment": true,
        "expectedArrivalDate": "2017-07-15",
        "carrierName": "FedEx Freight",
        "contactName": "Walter White",
        "phoneCountryCode": "+1",
        "contactPhone": "2132331222",
        "trackingBOLNumbers": [
          "134324324214242",
          "324231412342314"
        ],
        "pickupDate": "2017-11-01",
        "pickupStartTime": "11:01",
        "pickupEndTime": "21:30",
        "insidePickup": true,
        "liftGateAtPickup": true,
        "limitedAccess": false
      },
      "labels": [
        {
          "documents": [
            {
              "documentId": "1212",
              "documentType": "PackageLabel"
            },
            {
              "documentId": "1213",
              "documentType": "PackageLabel"
            }
          ]
        }
      ],
      "packingSlip": [
        {
          "id": "124345346",
          "content": "<…BASE64 CONTENT…>"
        }
      ],
      "billOfLading": [
        {
          "id": "121312",
          "content": "<…BASE64 CONTENT…>"
        }
      ]
    }
  ],
  "paging": {
    "previous": "https://<..........>/api/v1/inboundShipments?pageLimit=25&status=Complete&offset=0",
    "next": "https://<..........>/api/v1/inboundShipments?pageLimit=25&status=Complete&offset=25"
  }
}



      

Sample Error Response

Error Response

         


{
  "requestIdentifier": "01749ea2-4b8f-4f3d-a9dc-f0b862a3d72e",
  "transactionDate": "2017-01-20T15:12:54-05:00",
  "success": false,
  "errors": [
    {
      "code": "ERR-SYS-0001",
      "description": "Your request cannot be processed due to a system error."
    }
  ]
}



      

OAuth 2.0

Query Parameters

Response Attribute

HTTP Status Code

Error Code