Update Order

This API updates an existing Order within the FedEx® Fulfillment portal. If an order cannot be updated, the API call will return an error.

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:
  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_Secret: []
    Client_Id: []
    oauth2:
      - Fulfillment_Returns
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /orders/{fedexOrderId}:
    put:
      responses:
        200:
          description: 200 OK
      summary: Update Order
      description: Updates an existing Order within the Fulfillment portal. If an
        order cannot be updated, API call will return an error.
      parameters:
      - name: updateorder_json_input
        required: true
        in: body
        schema:
          type: object
        description: ''
      - name: fedexOrderId
        type: string
        required: true
        in: path
        description: Enter FedEx Order Id
      - name: AccessToken
        type: string
        required: true
        in: header
        description: Enter the AccessToken, it is mandatory
 
      

Sample Request

         


{
  "order": {
    "orderNumber": "091167792",
    "externalOrderNumber": "CAAMZ67792",
    "orderDate": "2017-01-20T15:12:54-05:00",
    "orderType": "B2C",
    "shipMethod": "FSON",
    "estimatedDeliveryDate": "2017-08-15",
    "shipType": "PCL",
    "salesChannel": "BigCommerce",
    "holdUntilDate": "2017-02-15T00:00:00-05:00",
    "facility": "HFY",
    "freightCost": "23.50",
    "insuranceCost": "10",
    "dutiesAndTaxes": "11.67",
    "alternatePackaging": true,
    "excludeCollateral": true,
    "accessorial": [
      "COA",
      "SAT",
      "DVL"
    ],
    "dropShip": true,
    "externalRefIds": [
      {
        "idKey": "marketplaceId",
        "idValue": "453"
      },
      {
        "idKey": "vendorId",
        "idValue": "V234"
      },
      {
        "idKey": "tradingPartnerId",
        "idValue": "TP435"
      }
    ],
    "destinationAddress": {
      "company": "Smith & Sons Inc.",
      "name": "James Smith",
      "addressLine1": "100 Papercraft Avenue",
      "addressLine2": "Suite 300",
      "city": "Pittsburgh",
      "stateCode": "PA",
      "zipCode": "15238",
      "countryCode": "US",
      "email": "abc@gmail.com",
      "sendTrackingNumber": true,
      "phoneNumber": "888-787-8888",   
      "shipToLocNumber": "433223",
      "storeNumber": "545423"
    },
    "orderNote": [
      {
        "noteCode": "NOTES",
        "noteText": "This is a test order"
      },
      {
        "noteCode": "GIFT_FROM",
        "noteText": "Joseph"
      },
      {
        "noteCode": "GIFT_TO",
        "noteText": "Johnson"
      },
      {
        "noteCode": "GIFT_MSG",
        "noteText": "Happy Birthday!!"
      }
    ],
    "line": [
      {
        "externalLineId": "001",
        "sku": "003-003-0001111",
        "skuDescripton": "Mens Oxford (Small/Blue/Slim)",
        "unitPrice": "2.56",
        "orderedQty": "2",
        "orderedQtyUoM":"CA",
        "vendorSku": "TGTMEN0111",
        "upc": "614141000883",
        "gtin": "50614141000994"
      },
      {
        "externalLineId": "002",
        "sku": "005-001-0001",
        "skuDescription": "Fancy T-Shirt",
        "unitPrice": "2.56",
        "orderedQty": "2",
        "orderedQtyUoM":"CA",
        "vendorSku": "TGTMEN0133",
        "upc": "614141000012",
        "gtin": "00614141000029"
      }
    ]
  }
}

 
       

Sample Response

Success Response

         
{
   "requestIdentifier": "01749ea2-4b8f-4f3d-a9dc-f0b862a3d72e",
   "transactionDate": "2017-01-20T15:12:54-05:00",
  "success": "true",
  "order": {
    "orderNumber": "091167792",
    "fedexOrderId": "0001-0007-H0120173742",
    "orderStatus": "Held"
  }
}


      

Error Response

      
{
   "requestIdentifier": "01749ea2-4b8f-4f3d-a9dc-f0b862a3d72e",
   "transactionDate": "2017-01-20T15:12:54-05:00",
  "success": "false",
  "errors": [
    {
      "code": "ERR-ORD-0004",
      "description": "Invalid or Inactive SKU"
    }
  ]
}


      

OAuth 2.0

Custom authentication

Request Attribute

Response Attribute

HTTP Status Code

Error Code