--- 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 basePath: /v1 consumes: - application/json produces: - application/json - fsc-api-admin@fedex.com - maheswararao.challa@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://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/api/sandbox/fsc/oauth/introspect 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 phase: realized paths: /inboundShipments: post: responses: 200: description: 200 OK summary: Create Inbound Shipment parameters: - name: inboundShipments_json_body required: true in: body schema: type: object description: 'Sample Json 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, "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, "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", "carrierName": "USPS", "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, "palletLpns": [ { "dimension": { "length": 35.6, "width": 45.6, "height": 29 }, "weight": 32, "stackable": true } ] } }' - name: AccessToken type: string required: false in: header description: Enter AccessToken, it is mandatory in case of basic authentication. security: - Client_Secret: [] Client_Id: [] - oauth2: - Fulfillment_Returns consumes: - application/json description: 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. produces: - application/json 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. /inboundShipments/{shipmentId}: put: responses: 200: description: 200 OK parameters: - name: shipmentId type: string required: true in: path description: shipment id as input parameter - name: accesstoken type: string required: false in: header description: AccessToken - name: inboundShipments_json_body required: true in: body schema: type: object description: '{ "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, "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, "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", "carrierName": "USPS", "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, "palletLpns": [ { "dimension": { "length": 35.6, "width": 45.6, "height": 29 }, "weight": 32, "stackable": true } ] } }' security: - Client_Secret: [] Client_Id: [] - oauth2: - Fulfillment_Returns description: This API updates an existing shipment within the fulfillment platform. If the shipment cannot be updated, the API call will return an error. operationId: Update Inbound Shipment consumes: - application/json produces: - application/json summary: Update Inbound Shipment /inboundShipments/{shipmentId}/cancel: post: responses: 200: description: 200 OK parameters: - name: AccessToken type: string required: false in: header description: accesstoken - name: shipmentId type: string required: true in: path description: Enter ShipmentId security: - Client_Secret: [] Client_Id: [] - oauth2: - Fulfillment_Returns summary: Cancel Inbound Shipment description: This API cancels an existing inbound shipment by providing the shipment ID. The shipment can be canceled only when it has been already received by the fulfillment center. consumes: - application/json produces: - application/json /inboundShipments/{shipmentId}/requestQuote: get: responses: 200: description: 200 OK 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 - name: shipmentId type: string required: true in: path description: ENter shipment id security: - Client_Secret: [] Client_Id: [] - oauth2: - Fulfillment_Returns summary: Request Shipment Quote description: This API requests a shipment quote for the inbound shipment. This currently supports shipment quotes for freight shipments. The call returns the carrier quotes for the shipment. consumes: - application/json produces: - application/json /inboundShipments/{shipmentId}/approveQuote: post: responses: 200: description: 200 OK parameters: - name: AccessToken type: string required: false in: header description: Enter AccessToken, it is mandatory in case of basic authentication. - name: shipmentId type: string required: true in: path description: Enther shipment id - name: approveshipmentquote_json_body required: true in: body schema: type: object description: 'sample Input message:- { "quoteId": "139041", "optionId": "413641" }' security: - Client_Secret: [] Client_Id: [] - oauth2: - Fulfillment_Returns summary: Approve Shipment Quote description: This API allows you to approve the shipment quote for the inbound shipment. This currently supports shipment quotes for freight shipments. The call returns the status of the transactions. Inbound shipment status will also be updated after the quote is approved. consumes: - application/json produces: - application/json /inboundShipments/{shipmentId}/shipping: post: responses: 200: description: 200 OK parameters: - name: shipmentId type: string required: true in: path description: shipment id as input parameter - name: Sample_json_body required: false in: body schema: type: object description: '{"fedexManaged": true,"freightShipping": true,"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}' description: This API creates or updates the shipping details for a shipment. The inbound shipment will not be sent to a fulfillment center by the system until the shipping details are provided. The shipping details cannot be updated if the shipment is already received by the fulfillment center. summary: This API creates or updates the shipping details for a shipment. The inbound shipment will not be sent to a fulfillment center by the system until the shipping details are provided. The shipping details cannot be updated if the shipment is already received by the fulfillment center. security: - Client_Secret: [] Client_Id: [] - oauth2: - Fulfillment_Returns tags: [] x-ibm-endpoints: - endpointUrl: https://api-sandbox.supplychain.fedex.com/api/sandbox type: - development ...