Cancel an Order

{
  "type": "object",
  "required": [
    "currentStatus",
    "id",
    "merchant",
    "merchantOrderId",
    "merchantShippingMethod",
    "originalConsignee",
    "recordedOn",
    "validatedConsignee"
  ],
  "properties": {
    "currentStatus": {
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "createdBy": {
          "type": "object",
          "required": [
            "id"
          ],
          "properties": {
            "id": {
              "type": "integer"
            }
          }
        },
        "date": {
          "type": "string",
          "format": "date-time",
          "description": "DateTime of Status Event"
        },
        "id": {
          "type": "integer"
        },
        "reason": {
          "type": "string",
          "description": "Explanation for status"
        },
        "status": {
          "type": "object",
          "required": [
            "code",
            "detailCode",
            "stage",
            "state"
          ],
          "properties": {
            "actionRequiredBy": {
              "type": "object",
              "description": "Responsibility for resolving this issue",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "name": {
                  "type": "string",
                  "description": "Human readable description of responsible party to resolve the issue"
                }
              }
            },
            "code": {
              "type": "string",
              "description": "Code, see [status codes](#section/Getting-Started/Status-Codes)"
            },
            "detail": {
              "type": "string"
            },
            "detailCode": {
              "type": "string"
            },
            "id": {
              "type": "integer",
              "description": "Depricated, use code instead"
            },
            "isClosed": {
              "type": "boolean",
              "description": "Depricated, does this status event close the order"
            },
            "name": {
              "type": "string",
              "description": "Depricated, use stage/state instead"
            },
            "reason": {
              "type": "string",
              "description": "Depricated"
            },
            "stage": {
              "type": "object",
              "properties": {
                "code": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                }
              }
            },
            "state": {
              "type": "object",
              "properties": {
                "code": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "departDate": {
      "type": "string",
      "format": "date-time",
      "description": "DateTime order departed an FDC warehouse"
    },
    "dispatchDate": {
      "type": "string",
      "format": "date-time",
      "description": "DateTime order was dispatched for fulfillment by FDC"
    },
    "id": {
      "type": "integer",
      "description": "FDC ID for this order"
    },
    "merchant": {
      "type": "object",
      "required": [
        "id",
        "name"
      ],
      "properties": {
        "id": {
          "type": "integer"
        },
        "name": {
          "type": "string",
          "description": "Merchant Company Name"
        }
      }
    },
    "merchantOrderId": {
      "type": "string",
      "description": "Merchant provided ID"
    },
    "merchantShippingMethod": {
      "type": "string",
      "description": "Requested ship method"
    },
    "originalConsignee": {
      "type": "object",
      "required": [
        "address1",
        "addressLocality",
        "addressRegion",
        "country",
        "firstName",
        "id",
        "lastName",
        "postalCode"
      ],
      "properties": {
        "address1": {
          "type": "string"
        },
        "address2": {
          "type": "string"
        },
        "addressLocality": {
          "type": "string",
          "description": "City"
        },
        "addressRegion": {
          "type": "string",
          "description": "Province / State"
        },
        "companyName": {
          "type": "string"
        },
        "country": {
          "type": "string",
          "description": "Ideally provide the two character ISO code"
        },
        "email": {
          "type": "string"
        },
        "firstName": {
          "type": "string"
        },
        "id": {
          "type": "integer"
        },
        "iso": {
          "type": "object",
          "properties": {
            "id": {
              "type": "integer"
            },
            "iso2": {
              "type": "string",
              "description": "Two character ISO code"
            },
            "name": {
              "type": "string",
              "description": "Country Name"
            }
          }
        },
        "lastName": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "postalCode": {
          "type": "string",
          "description": "Postal Code / Zip"
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time"
        },
        "updatedBy": {
          "type": "object",
          "required": [
            "id"
          ],
          "properties": {
            "id": {
              "type": "integer"
            }
          }
        }
      }
    },
    "parentOrder": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Reference to parent `id` if order was grouped"
        }
      }
    },
    "purchaseOrderNum": {
      "type": "string",
      "description": "Merchant provided PO#"
    },
    "recordedOn": {
      "type": "string",
      "format": "date-time",
      "description": "DateTime order was recorded by FDC"
    },
    "trackingNumbers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "barcodeScanValue": {
            "type": "string",
            "description": "The computer readable alternative to the human readable"
          },
          "carrier": {
            "type": "object",
            "required": [
              "id"
            ],
            "properties": {
              "id": {
                "type": "integer"
              }
            }
          },
          "value": {
            "type": "string",
            "description": "The human readable tracking number recipients (consignee) expect"
          }
        }
      }
    },
    "validatedConsignee": {
      "type": "object",
      "required": [
        "address1",
        "addressLocality",
        "addressRegion",
        "country",
        "firstName",
        "id",
        "lastName",
        "postalCode"
      ],
      "properties": {
        "address1": {
          "type": "string"
        },
        "address2": {
          "type": "string"
        },
        "addressLocality": {
          "type": "string",
          "description": "City"
        },
        "addressRegion": {
          "type": "string",
          "description": "Province / State"
        },
        "companyName": {
          "type": "string"
        },
        "country": {
          "type": "string",
          "description": "Ideally provide the two character ISO code"
        },
        "email": {
          "type": "string"
        },
        "firstName": {
          "type": "string"
        },
        "id": {
          "type": "integer"
        },
        "iso": {
          "type": "object",
          "properties": {
            "id": {
              "type": "integer"
            },
            "iso2": {
              "type": "string",
              "description": "Two character ISO code"
            },
            "name": {
              "type": "string",
              "description": "Country Name"
            }
          }
        },
        "lastName": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "postalCode": {
          "type": "string",
          "description": "Postal Code / Zip"
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time"
        },
        "updatedBy": {
          "type": "object",
          "required": [
            "id"
          ],
          "properties": {
            "id": {
              "type": "integer"
            }
          }
        }
      }
    },
    "warehouse": {
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "integer"
        }
      }
    }
  }
}