Jump to

• Request
• Response

Cancel Fulfillment Orders

put

/services/private/inventory/cancelFulfillOrders

Cancel an existing Customer Order or Transfer in RMS based on customer order fulfillment cancellation requests from an external Order Management System.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• fulfillOrderReferences: array fulfillOrderReferences
  Array of fulfillment orders for cancellation

{
    "type":"object",
    "properties":{
        "fulfillOrderReferences":{
            "type":"array",
            "description":"Array of fulfillment orders for cancellation",
            "items":{
                "$ref":"#/components/schemas/cancelfulfillorders$FulfilOrdRef"
            }
        }
    },
    "xml":{
        "name":"fulfilOrdColRef"
    }
}

Nested Schema : fulfillOrderReferences

Type: array

Array of fulfillment orders for cancellation

Show Source

• Array of: object fulfilOrdRef
  Array of fulfillment orders for cancellation

{
    "type":"array",
    "description":"Array of fulfillment orders for cancellation",
    "items":{
        "$ref":"#/components/schemas/cancelfulfillorders$FulfilOrdRef"
    }
}

Nested Schema : fulfilOrdRef

Type: object

Array of fulfillment orders for cancellation

Show Source

• customerOrderNo(required): string
  Holds the master customer order number from OMS.

  Example: 123252156
• fulfillLocId(required): integer (int32)
  Indicates the store or warehouse number associated with fulfilling the customer order. For this release, this should always be populated with a virtual or physical store number.

  Example: 1311
• fulfillLocType: string
  Allowed Values: [ "S", "V" ]

  This would be either 'S' (for physical store) or 'V' (for virtual store).

  Example: S
• fulfillOrderNo(required): string
  Unique number from OMS related to the fulfillment details. One or more fulfillment orders could relate back to a single customer order in OMS.

  Example: 1231213
• orderDetails(required): array orderDetails
  Indicates the customer order fulfillment cancellation detail.
• sourceLocId: integer (int32)
  Indicates the supplier, store or warehouse number associated with sourcing the customer order. Only populated for vendor, warehouse or multi-site fulfillment orders.

  Example: 6000
• sourceLocType: string
  Allowed Values: [ "SU", "ST", "WH" ]

  This would be either 'SU' for supplier, 'ST' for store, or 'WH' for warehouse. This would only be populated for vendor, warehouse or multi-site fulfillment orders.

  Example: ST

{
    "required":[
        "customerOrderNo",
        "fulfillLocId",
        "fulfillOrderNo",
        "orderDetails"
    ],
    "type":"object",
    "properties":{
        "customerOrderNo":{
            "type":"string",
            "description":"Holds the master customer order number from OMS.",
            "example":"123252156"
        },
        "fulfillOrderNo":{
            "type":"string",
            "description":"Unique number from OMS related to the fulfillment details. One or more fulfillment orders could relate back to a single customer order in OMS.",
            "example":"1231213"
        },
        "sourceLocType":{
            "type":"string",
            "description":"This would be either 'SU' for supplier, 'ST' for store, or 'WH' for warehouse. This would only be populated for vendor, warehouse or multi-site fulfillment orders.",
            "example":"ST",
            "enum":[
                "SU",
                "ST",
                "WH"
            ]
        },
        "sourceLocId":{
            "type":"integer",
            "description":"Indicates the supplier, store or warehouse number associated with sourcing the customer order. Only populated for vendor, warehouse or multi-site fulfillment orders.",
            "format":"int32",
            "example":6000
        },
        "fulfillLocType":{
            "type":"string",
            "description":"This would be either 'S' (for physical store) or 'V' (for virtual store).",
            "example":"S",
            "enum":[
                "S",
                "V"
            ]
        },
        "fulfillLocId":{
            "type":"integer",
            "description":"Indicates the store or warehouse number associated with fulfilling the customer order. For this release, this should always be populated with a virtual or physical store number.",
            "format":"int32",
            "example":1311
        },
        "orderDetails":{
            "type":"array",
            "description":"Indicates the customer order fulfillment cancellation detail.",
            "items":{
                "$ref":"#/components/schemas/cancelfulfillorders$FulfilOrdDtlRef"
            }
        }
    },
    "description":"Array of fulfillment orders for cancellation",
    "xml":{
        "name":"fulfilOrdRef"
    }
}

Nested Schema : orderDetails

Type: array

Indicates the customer order fulfillment cancellation detail.

Show Source

• Array of: object fulfilOrdDtlRef
  Indicates the customer order fulfillment cancellation detail.

{
    "type":"array",
    "description":"Indicates the customer order fulfillment cancellation detail.",
    "items":{
        "$ref":"#/components/schemas/cancelfulfillorders$FulfilOrdDtlRef"
    }
}

Nested Schema : fulfilOrdDtlRef

Type: object

Indicates the customer order fulfillment cancellation detail.

Show Source

• cancelQtySuom(required): number
  Indicates the quantity that should be cancelled from the order in item's standard unit of measure.

  Example: 3
• item(required): string
  Indicates the item ordered by the customer.

  Example: 101450060
• itemLineNo: integer (int32)
  Indicates the detail item line number on the order.

  Example: 1
• referenceItem: string
  Indicates the reference item ordered by the customer. Used only if a specific UPC is ordered. This is supported for vendor drop-ships orders only as we don't support transfer requests for a specific reference item.

  Example:
• standardUom: string
  Indicates item's standard unit of measure.

  Example: EA
• transactionUom: string
  Indicates the original transaction unit of measure the order is placed in.

  Example: EA

{
    "required":[
        "cancelQtySuom",
        "item"
    ],
    "type":"object",
    "properties":{
        "item":{
            "type":"string",
            "description":"Indicates the item ordered by the customer.",
            "example":"101450060"
        },
        "referenceItem":{
            "type":"string",
            "description":"Indicates the reference item ordered by the customer. Used only if a specific UPC is ordered. This is supported for vendor drop-ships orders only as we don't support transfer requests for a specific reference item.",
            "example":""
        },
        "cancelQtySuom":{
            "type":"number",
            "description":"Indicates the quantity that should be cancelled from the order in item's standard unit of measure.",
            "example":3
        },
        "standardUom":{
            "type":"string",
            "description":"Indicates item's standard unit of measure.",
            "example":"EA"
        },
        "transactionUom":{
            "type":"string",
            "description":"Indicates the original transaction unit of measure the order is placed in.",
            "example":"EA"
        },
        "itemLineNo":{
            "type":"integer",
            "description":"Indicates the detail item line number on the order.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Indicates the customer order fulfillment cancellation detail.",
    "xml":{
        "name":"fulfilOrdDtlRef"
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• fulfillOrderReferences: array fulfillOrderReferences
  Array of fulfillment orders for cancellation

{
    "type":"object",
    "properties":{
        "fulfillOrderReferences":{
            "type":"array",
            "description":"Array of fulfillment orders for cancellation",
            "items":{
                "$ref":"#/components/schemas/cancelfulfillorders$FulfilOrdRef"
            }
        }
    },
    "xml":{
        "name":"fulfilOrdColRef"
    }
}

Nested Schema : fulfillOrderReferences

Type: array

Array of fulfillment orders for cancellation

Show Source

• Array of: object fulfilOrdRef
  Array of fulfillment orders for cancellation

{
    "type":"array",
    "description":"Array of fulfillment orders for cancellation",
    "items":{
        "$ref":"#/components/schemas/cancelfulfillorders$FulfilOrdRef"
    }
}

Nested Schema : fulfilOrdRef

Type: object

Array of fulfillment orders for cancellation

Show Source

• customerOrderNo(required): string
  Holds the master customer order number from OMS.

  Example: 123252156
• fulfillLocId(required): integer (int32)
  Indicates the store or warehouse number associated with fulfilling the customer order. For this release, this should always be populated with a virtual or physical store number.

  Example: 1311
• fulfillLocType: string
  Allowed Values: [ "S", "V" ]

  This would be either 'S' (for physical store) or 'V' (for virtual store).

  Example: S
• fulfillOrderNo(required): string
  Unique number from OMS related to the fulfillment details. One or more fulfillment orders could relate back to a single customer order in OMS.

  Example: 1231213
• orderDetails(required): array orderDetails
  Indicates the customer order fulfillment cancellation detail.
• sourceLocId: integer (int32)
  Indicates the supplier, store or warehouse number associated with sourcing the customer order. Only populated for vendor, warehouse or multi-site fulfillment orders.

  Example: 6000
• sourceLocType: string
  Allowed Values: [ "SU", "ST", "WH" ]

  This would be either 'SU' for supplier, 'ST' for store, or 'WH' for warehouse. This would only be populated for vendor, warehouse or multi-site fulfillment orders.

  Example: ST

{
    "required":[
        "customerOrderNo",
        "fulfillLocId",
        "fulfillOrderNo",
        "orderDetails"
    ],
    "type":"object",
    "properties":{
        "customerOrderNo":{
            "type":"string",
            "description":"Holds the master customer order number from OMS.",
            "example":"123252156"
        },
        "fulfillOrderNo":{
            "type":"string",
            "description":"Unique number from OMS related to the fulfillment details. One or more fulfillment orders could relate back to a single customer order in OMS.",
            "example":"1231213"
        },
        "sourceLocType":{
            "type":"string",
            "description":"This would be either 'SU' for supplier, 'ST' for store, or 'WH' for warehouse. This would only be populated for vendor, warehouse or multi-site fulfillment orders.",
            "example":"ST",
            "enum":[
                "SU",
                "ST",
                "WH"
            ]
        },
        "sourceLocId":{
            "type":"integer",
            "description":"Indicates the supplier, store or warehouse number associated with sourcing the customer order. Only populated for vendor, warehouse or multi-site fulfillment orders.",
            "format":"int32",
            "example":6000
        },
        "fulfillLocType":{
            "type":"string",
            "description":"This would be either 'S' (for physical store) or 'V' (for virtual store).",
            "example":"S",
            "enum":[
                "S",
                "V"
            ]
        },
        "fulfillLocId":{
            "type":"integer",
            "description":"Indicates the store or warehouse number associated with fulfilling the customer order. For this release, this should always be populated with a virtual or physical store number.",
            "format":"int32",
            "example":1311
        },
        "orderDetails":{
            "type":"array",
            "description":"Indicates the customer order fulfillment cancellation detail.",
            "items":{
                "$ref":"#/components/schemas/cancelfulfillorders$FulfilOrdDtlRef"
            }
        }
    },
    "description":"Array of fulfillment orders for cancellation",
    "xml":{
        "name":"fulfilOrdRef"
    }
}

Nested Schema : orderDetails

Type: array

Indicates the customer order fulfillment cancellation detail.

Show Source

• Array of: object fulfilOrdDtlRef
  Indicates the customer order fulfillment cancellation detail.

{
    "type":"array",
    "description":"Indicates the customer order fulfillment cancellation detail.",
    "items":{
        "$ref":"#/components/schemas/cancelfulfillorders$FulfilOrdDtlRef"
    }
}

Nested Schema : fulfilOrdDtlRef

Type: object

Indicates the customer order fulfillment cancellation detail.

Show Source

• cancelQtySuom(required): number
  Indicates the quantity that should be cancelled from the order in item's standard unit of measure.

  Example: 3
• item(required): string
  Indicates the item ordered by the customer.

  Example: 101450060
• itemLineNo: integer (int32)
  Indicates the detail item line number on the order.

  Example: 1
• referenceItem: string
  Indicates the reference item ordered by the customer. Used only if a specific UPC is ordered. This is supported for vendor drop-ships orders only as we don't support transfer requests for a specific reference item.

  Example:
• standardUom: string
  Indicates item's standard unit of measure.

  Example: EA
• transactionUom: string
  Indicates the original transaction unit of measure the order is placed in.

  Example: EA

{
    "required":[
        "cancelQtySuom",
        "item"
    ],
    "type":"object",
    "properties":{
        "item":{
            "type":"string",
            "description":"Indicates the item ordered by the customer.",
            "example":"101450060"
        },
        "referenceItem":{
            "type":"string",
            "description":"Indicates the reference item ordered by the customer. Used only if a specific UPC is ordered. This is supported for vendor drop-ships orders only as we don't support transfer requests for a specific reference item.",
            "example":""
        },
        "cancelQtySuom":{
            "type":"number",
            "description":"Indicates the quantity that should be cancelled from the order in item's standard unit of measure.",
            "example":3
        },
        "standardUom":{
            "type":"string",
            "description":"Indicates item's standard unit of measure.",
            "example":"EA"
        },
        "transactionUom":{
            "type":"string",
            "description":"Indicates the original transaction unit of measure the order is placed in.",
            "example":"EA"
        },
        "itemLineNo":{
            "type":"integer",
            "description":"Indicates the detail item line number on the order.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Indicates the customer order fulfillment cancellation detail.",
    "xml":{
        "name":"fulfilOrdDtlRef"
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success

Body ()

Root Schema : invocationSuccess

Type: object

Show Source

• message: string
  Success message

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "description":"Success message"
        }
    },
    "xml":{
        "name":"invocationSuccess"
    }
}

400 Response

Error

Body ()

Root Schema : RetailRestValidationException

Type: object

Show Source

• errors: array errors
  Error details
• message: string
  Message

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "description":"Message"
        },
        "errors":{
            "type":"array",
            "description":"Error details",
            "items":{
                "type":"string",
                "description":"Error details"
            }
        }
    },
    "xml":{
        "name":"RetailRestValidationException"
    }
}

Nested Schema : errors

Type: array

Error details

Show Source

• Array of: string
  Error details

{
    "type":"array",
    "description":"Error details",
    "items":{
        "type":"string",
        "description":"Error details"
    }
}

Back to Top