Create/Update Shipping Details

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.

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/{shipmentId}/shipping:
    post:
      responses:
        200:
          description: 200 OK
      parameters:
      - name: sample_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

         
FedEx-managed – Pallet shipment
{
	"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
}

FedEx - managed – Pallet shipment for case packing
{
	"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,
	"palletLpns": [{
			"dimension": {
				"length": 25.6,
				"width": 45.6,
				"height": 19
			},
			"weight": 12,
			"stackable": true
		}, {
			"dimension": {
				"length": 25.6,
				"width": 45.6,
				"height": 19
			},
			"weight": 12,
			"stackable": true
		}
	]
}

Non-FedEx-managed – Parcel shipment

{
  "fedexManaged": false,
  "expectedArrivalDate": "2017-07-15",
  "carrierName": "USPS",
  "trackingBOLNumbers": [
    "13432432421",
    "324231412342314"
  ]
}

 
      

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

Request Attributes

Response Attribute

HTTP Status Code

Error Code