Create Inbound Shipment

This API creates a new inbound shipment within the FedEx fulfillment platform. Once the shipment is submitted, it will be processed and sent to the respective warehouse to provide advance notice to the operations team.

Swagger

         
swagger: '2.0'
info:
  x-ibm-name: inboundShipments
  title: inboundShipments
  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:
  /inboundShipments:
    post:
      responses:
        200:
          description: 200 OK
      parameters:
      - name: create_inboundShipments_json_body
        required: true
        in: body
        schema:
          type: json
        description: ''
      - name: AccessToken
        type: string
        required: false
        in: header
        description: Enter Access Token, it is required header
      	

      

Sample Request

         
{
	"externalRefNumber": "32421-1314324-2131",
	"shipmentName": "FedEx Shipment01",
	"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"
	},
	"lpns": [{
			"lpnType": "C",
			"lpnName": "Case 1",
			"numberOfLpns": 10,
			"customLpnIds": [],
			"dimension": {
				"length": 25.6,
				"width": 45.6,
				"height": 19
			},
			"weight": 12,
			"stackable": true,
			"applyDeclaredValue": true,
			"declaredValue": 125.60,
			"lpnDetails": [{
					"sku": "Fancy1",
					"quantity": 20,
					"batchLotNumber": "A131231",
					"expireDate": "2017-10-14",
					"purchaseOrderId": "324324214123421",
					"purchaseOrderLineItemId": "43532423432432"
				}, {
					"sku": "Fancy2",
					"quantity": 200,
					"batchlotNumber": null,
					"expireDate": null,
					"purchaseOrderId": "324324214123421",
					"purchaseOrderLineItemId": "43532423432433"
				}
			]
		}, {
			"lpnType": "C",
			"lpnName": "Case 2",
			"numberOfLpns": 5,
			"customLpnIds": [
				"00000999990000128970",
				"00000999990000128971",
				"00000999990000128972",
				"00000999990000128973",
				"00000999990000128974"
			],
			"dimension": {
				"length": 25.6,
				"width": 45.6,
				"height": 19
			},
			"weight": 12,
			"stackable": true,
			"applyDeclaredValue": false,
			"lpnDetails": [{
					"sku": "Fancy1",
					"quantity": 500,
					"batchlotNumber": "A131231",
					"expireDate": "2017-10-15",
					"purchaseOrderNumber": "324324214123421",
					"purchaseOrderLineItemId": "43532423432434"
				}
			]
		}
	],
	"productLevelServices": [{
			"sku": "Fancy1",
			"serviceLevelCode": "quality_audit_100"
		}, {
			"sku": "Fancy1",
			"serviceLevelCode": "bubble_wrap_small"
		}, {
			"sku": "Fancy2",
			"serviceLevelCode": "dust_bag_small"
		}
	],
	"shipping": {
		"fedexManaged": false,
		"freightShipment": true,
		"expectedArrivalDate": "2017-07-15",
		"transportation": "carrier",
		"carrierSCAC": "FEDX",
		"trackingBOLNumbers": [
			"134324324214242",
			"324231412342314"
		],
		"pickupDate": "2017-11-01",
		"pickupStartTime": "11:01",
		"pickupEndTime": "21:30",
		"insidePickup": true,
		"liftGateAtPickup": true,
		"limitedAccess": false,
		"palletLpns": [{
				"dimension": {
					"length": 35.6,
					"width": 45.6,
					"height": 29
				},
				"weight": 32,
				"stackable": true
			}
		]
	}
}
 
      

Sample Response

Success Response

         
{
  "requestIdentifier": "01749ea2-4b8f-4f3d-a9dc-f0b862a3d72e",
  "transactionDate": "2017-01-20T15:12:54-05:00",
  "success": true,
  "inboundShipment": {
    "shipmentId": "0001-063017-0001",
    "status": "In Transit"
  }
}



      

Error Response

Error Response

         
{
  "requestIdentifier": "01749ea2-4b8f-4f3d-a9dc-f0b862a3d72e",
  "transactionDate": "2017-01-20T15:12:54-05:00",
  "success": false,
  "errors": [
    {
      "code": "ERR-CMR-0001",
      "description": "Input data validation failed"
    }


      

OAuth 2.0

Custom authentication

Request Attributes

Response Attribute

HTTP Status Code

Error Code