Cancel Inbound Shipment

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.

Swagger

         
swagger: '2.0'
info:
  x-ibm-name: orders
  title: Orders
  version: 1.0.0
schemes:
  - https
host: $(catalog.host)
basePath: /v1
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  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_Secret: []
    Client_Id: []
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /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
 
      

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": "Canceled"
				}
			}
		
      

Error Response

 
	
		 {
			"requestIdentifier": "01749ea2-4b8f-4f3d-a9dc-f0b862a3d72e",
			"transactionDate": "2017-01-20T15:12:54-05:00",
			"success": false,
			"errors": [{
					"code": "ERR-ASN-0040",
					"description": "Shipment ID does not exist"
				}
			]
		 }


    

Custom authentication

Response Attribute

HTTP Status Code

Error Code