Jump to

• Request
• Response

Create Fulfillment Orders

post

/services/private/inventory/createFulfillOrders

Create new Customer Orders or Transfers in RMS based on customer order fulfillment requests from an external Order Management System (OMS).

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

• fulfillOrders: array fulfillOrders
  Array of fulfillment order

{
    "type":"object",
    "properties":{
        "fulfillOrders":{
            "type":"array",
            "description":"Array of fulfillment order",
            "items":{
                "$ref":"#/components/schemas/createfulfillorders$FulfilOrdDesc"
            }
        }
    },
    "xml":{
        "name":"fulfilOrdColDesc"
    }
}

Nested Schema : fulfillOrders

Type: array

Array of fulfillment order

Show Source

• Array of: object fulfilOrdDesc
  Array of fulfillment order

{
    "type":"array",
    "description":"Array of fulfillment order",
    "items":{
        "$ref":"#/components/schemas/createfulfillorders$FulfilOrdDesc"
    }
}

Nested Schema : fulfilOrdDesc

Type: object

Array of fulfillment order

Show Source

• carrierCode: string
  Indicates the carrier the order is to be shipped with, if specified on the order.

  Example: 30
• carrierServiceCode: string
  Indicates the method that was selected for shipping by the customer placing the order (e. g. Standard Shipping, Overnight, etc. ).

  Example: D
• comments: string
  Any comments sent by OMS about the order.

  Example: commentDesc
• consumerDeliveryDate(required): string (date)
  Indicates the desired date the delivery is required by the customer. This will be the GMT time.
• consumerDeliveryTime: string (date-time)
  Indicates the desired time the delivery is required by the customer. This will be the GMT time.
• customerDetail: object fulfilOrdCustDesc
  Referenced object for customer information related to the order.
• customerOrderNo(required): string
  Holds the master customer order number from OMS.

  Example: 12342132156
• deliveryCharges: number
  Contains the delivery charges on drop ship. Mostly relevant for Brazil.

  Example: 3
• deliveryChargesCurrency: string
  Contains the currency of the delivery charges.

  Example: USD
• deliveryType: string
  Allowed Values: [ "S", "C" ]

  Indicates the fulfillment method - ship to customer or store pickup. Expected values are 'S' (ship direct) and 'C' (customer pickup).

  Example: S
• 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: 123123213
• orderDetails(required): array orderDetails
  References a collection of customer order fulfillment details.
• orderPlacedStore: integer (int32)
  Indicates the store number associated with the location that the customer order was placed. For on-line orders this will contain the virtual store number associated with the on-line store. For orders captured in a physical store this will contain the store number for the physical store.

  Example: 1311
• partialDeliveryInd(required): string
  Allowed Values: [ "Y", "N" ]

  Indicates if the order can be picked and shipped partially ('N') or if it should be shipped only when complete ('Y').

  Example: N
• 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":[
        "consumerDeliveryDate",
        "customerOrderNo",
        "fulfillLocId",
        "fulfillOrderNo",
        "orderDetails",
        "partialDeliveryInd"
    ],
    "type":"object",
    "properties":{
        "customerOrderNo":{
            "type":"string",
            "description":"Holds the master customer order number from OMS.",
            "example":"12342132156"
        },
        "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":"123123213"
        },
        "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
        },
        "partialDeliveryInd":{
            "type":"string",
            "description":"Indicates if the order can be picked and shipped partially ('N') or if it should be shipped only when complete ('Y').",
            "example":"N",
            "enum":[
                "Y",
                "N"
            ]
        },
        "deliveryType":{
            "type":"string",
            "description":"Indicates the fulfillment method - ship to customer or store pickup. Expected values are 'S' (ship direct) and 'C' (customer pickup).",
            "example":"S",
            "enum":[
                "S",
                "C"
            ]
        },
        "carrierCode":{
            "type":"string",
            "description":"Indicates the carrier the order is to be shipped with, if specified on the order.",
            "example":"30"
        },
        "carrierServiceCode":{
            "type":"string",
            "description":"Indicates the method that was selected for shipping by the customer placing the order (e. g. Standard Shipping, Overnight, etc. ).",
            "example":"D"
        },
        "consumerDeliveryDate":{
            "type":"string",
            "description":"Indicates the desired date the delivery is required by the customer. This will be the GMT time.",
            "format":"date"
        },
        "consumerDeliveryTime":{
            "type":"string",
            "description":"Indicates the desired time the delivery is required by the customer. This will be the GMT time.",
            "format":"date-time"
        },
        "deliveryCharges":{
            "type":"number",
            "description":"Contains the delivery charges on drop ship. Mostly relevant for Brazil.",
            "example":3
        },
        "deliveryChargesCurrency":{
            "type":"string",
            "description":"Contains the currency of the delivery charges.",
            "example":"USD"
        },
        "comments":{
            "type":"string",
            "description":"Any comments sent by OMS about the order.",
            "example":"commentDesc"
        },
        "customerDetail":{
            "$ref":"#/components/schemas/createfulfillorders$FulfilOrdCustDesc"
        },
        "orderDetails":{
            "type":"array",
            "description":"References a collection of customer order fulfillment details.",
            "items":{
                "$ref":"#/components/schemas/createfulfillorders$FulfilOrdDtl"
            }
        },
        "orderPlacedStore":{
            "type":"integer",
            "description":"Indicates the store number associated with the location that the customer order was placed. For on-line orders this will contain the virtual store number associated with the on-line store. For orders captured in a physical store this will contain the store number for the physical store.",
            "format":"int32",
            "example":1311
        }
    },
    "description":"Array of fulfillment order",
    "xml":{
        "name":"fulfilOrdDesc"
    }
}

Nested Schema : fulfilOrdCustDesc

Type: object

Referenced object for customer information related to the order.

Show Source

• billAddress1: string
  First line of the billing address for the customer.

  Example: 101 First Street
• billAddress2: string
  Second line of the billing address for the customer.

  Example: 201 Second Street
• billAddress3: string
  Third line of the billing address for the customer.

  Example: 301 Third Street
• billCity: string
  City portion of the billing address.

  Example: Minneapolis
• billCompanyName: string
  Contains the company name for the billing address on the order.

  Example: billCompanyName
• billCountryId: string
  Country portion of the billing address.

  Example: US
• billCounty: string
  County portion of the billing address.

  Example: Some County
• billEmail: string
  Contains the billing email.

  Example: [e-mail]
• billFirstName: string
  Contains the first name for the billing address on the order.

  Example: First
• billJurisdiction: string
  Identifies the jurisdiction code for the billing country-state relationship.

  Example:
• billLastName: string
  Contains the last name for the billing address on the order.

  Example: Last
• billPhone: string
  Contains the billing phone number.

  Example: 1800800800
• billPhoneticFirst: string
  Contains the phonetic first name for the billing address on the order.

  Example: First
• billPhoneticLast: string
  Contains the phonetic last name for the billing address on the order.

  Example: Last
• billPost: string
  Postal code portion of the billing address.

  Example: 55555-1234
• billPreferredName: string
  Contains the preferred name for the billing address on the order.

  Example: billPreferredName
• billState: string
  State portion of the billing address.

  Example: MN
• customerNo: string
  Indicates the number that uniquely identifies the customer in OMS.

  Example: 123456
• deliverAddress1: string
  First line of the delivery address for the customer.

  Example: 101 First Street
• deliverAddress2: string
  Second line of the delivery address for the customer.

  Example: 201 Second Street
• deliverAddress3: string
  Third line of the delivery address for the customer.

  Example: 301 Third Street
• deliverCity: string
  City portion of the delivery address.

  Example: Minneapolis
• deliverCompanyName: string
  Contains the company name for the delivery address on the order.

  Example: Company Name
• deliverCountryId: string
  Country portion of the delivery address.

  Example: US
• deliverCounty: string
  County portion of the delivery address.

  Example: Some County
• deliverEmail: string
  Contains the delivery email.

  Example: [e-mail]
• deliverFirstName: string
  Contains the first name for the delivery address on the order.

  Example: First
• deliverJurisdiction: string
  Identifies the jurisdiction code for the delivery country-state relationship.

  Example:
• deliverLastName: string
  Contains the last name for the delivery address on the order.

  Example: Last
• deliverPhone: string
  Contains the delivery phone number.

  Example: 1800800800
• deliverPhoneticFirst: string
  Contains the phonetic first name for the delivery address on the order.

  Example: First
• deliverPhoneticLast: string
  Contains the phonetic last name for the delivery address on the order.

  Example: Last
• deliverPost: string
  Postal code portion of the delivery address.

  Example: 55555-1234
• deliverPreferredName: string
  Contains the preferred name for the delivery address on the order.

  Example: Preferred Name
• deliverState: string
  State portion of the delivery address.

  Example: MN

{
    "type":"object",
    "properties":{
        "customerNo":{
            "type":"string",
            "description":"Indicates the number that uniquely identifies the customer in OMS.",
            "example":"123456"
        },
        "deliverFirstName":{
            "type":"string",
            "description":"Contains the first name for the delivery address on the order.",
            "example":"First"
        },
        "deliverPhoneticFirst":{
            "type":"string",
            "description":"Contains the phonetic first name for the delivery address on the order.",
            "example":"First"
        },
        "deliverLastName":{
            "type":"string",
            "description":"Contains the last name for the delivery address on the order.",
            "example":"Last"
        },
        "deliverPhoneticLast":{
            "type":"string",
            "description":"Contains the phonetic last name for the delivery address on the order.",
            "example":"Last"
        },
        "deliverPreferredName":{
            "type":"string",
            "description":"Contains the preferred name for the delivery address on the order.",
            "example":"Preferred Name"
        },
        "deliverCompanyName":{
            "type":"string",
            "description":"Contains the company name for the delivery address on the order.",
            "example":"Company Name"
        },
        "deliverAddress1":{
            "type":"string",
            "description":"First line of the delivery address for the customer.",
            "example":"101 First Street"
        },
        "deliverAddress2":{
            "type":"string",
            "description":"Second line of the delivery address for the customer.",
            "example":"201 Second Street"
        },
        "deliverAddress3":{
            "type":"string",
            "description":"Third line of the delivery address for the customer.",
            "example":"301 Third Street"
        },
        "deliverCounty":{
            "type":"string",
            "description":"County portion of the delivery address.",
            "example":"Some County"
        },
        "deliverCity":{
            "type":"string",
            "description":"City portion of the delivery address.",
            "example":"Minneapolis"
        },
        "deliverState":{
            "type":"string",
            "description":"State portion of the delivery address.",
            "example":"MN"
        },
        "deliverCountryId":{
            "type":"string",
            "description":"Country portion of the delivery address.",
            "example":"US"
        },
        "deliverPost":{
            "type":"string",
            "description":"Postal code portion of the delivery address.",
            "example":"55555-1234"
        },
        "deliverJurisdiction":{
            "type":"string",
            "description":"Identifies the jurisdiction code for the delivery country-state relationship.",
            "example":""
        },
        "deliverPhone":{
            "type":"string",
            "description":"Contains the delivery phone number.",
            "example":"1800800800"
        },
        "deliverEmail":{
            "type":"string",
            "description":"Contains the delivery email.",
            "example":"[e-mail]"
        },
        "billFirstName":{
            "type":"string",
            "description":"Contains the first name for the billing address on the order.",
            "example":"First"
        },
        "billPhoneticFirst":{
            "type":"string",
            "description":"Contains the phonetic first name for the billing address on the order.",
            "example":"First"
        },
        "billLastName":{
            "type":"string",
            "description":"Contains the last name for the billing address on the order.",
            "example":"Last"
        },
        "billPhoneticLast":{
            "type":"string",
            "description":"Contains the phonetic last name for the billing address on the order.",
            "example":"Last"
        },
        "billPreferredName":{
            "type":"string",
            "description":"Contains the preferred name for the billing address on the order.",
            "example":"billPreferredName"
        },
        "billCompanyName":{
            "type":"string",
            "description":"Contains the company name for the billing address on the order.",
            "example":"billCompanyName"
        },
        "billAddress1":{
            "type":"string",
            "description":"First line of the billing address for the customer.",
            "example":"101 First Street"
        },
        "billAddress2":{
            "type":"string",
            "description":"Second line of the billing address for the customer.",
            "example":"201 Second Street"
        },
        "billAddress3":{
            "type":"string",
            "description":"Third line of the billing address for the customer.",
            "example":"301 Third Street"
        },
        "billCounty":{
            "type":"string",
            "description":"County portion of the billing address.",
            "example":"Some County"
        },
        "billCity":{
            "type":"string",
            "description":"City portion of the billing address.",
            "example":"Minneapolis"
        },
        "billState":{
            "type":"string",
            "description":"State portion of the billing address.",
            "example":"MN"
        },
        "billCountryId":{
            "type":"string",
            "description":"Country portion of the billing address.",
            "example":"US"
        },
        "billPost":{
            "type":"string",
            "description":"Postal code portion of the billing address.",
            "example":"55555-1234"
        },
        "billJurisdiction":{
            "type":"string",
            "description":"Identifies the jurisdiction code for the billing country-state relationship.",
            "example":""
        },
        "billPhone":{
            "type":"string",
            "description":"Contains the billing phone number.",
            "example":"1800800800"
        },
        "billEmail":{
            "type":"string",
            "description":"Contains the billing email.",
            "example":"[e-mail]"
        }
    },
    "description":"Referenced object for customer information related to the order.",
    "xml":{
        "name":"fulfilOrdCustDesc"
    }
}

Nested Schema : orderDetails

Type: array

References a collection of customer order fulfillment details.

Show Source

• Array of: object fulfilOrdDtl
  References a collection of customer order fulfillment details.

{
    "type":"array",
    "description":"References a collection of customer order fulfillment details.",
    "items":{
        "$ref":"#/components/schemas/createfulfillorders$FulfilOrdDtl"
    }
}

Nested Schema : fulfilOrdDtl

Type: object

References a collection of customer order fulfillment details.

Show Source

• comments: string
  Used to indicate any special instructions for the item, such as services (monograms, engrave, etc).

  Example: commentDesc
• 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
• orderQtySuom(required): number
  Indicates the quantity of the item ordered by the customer in item's standard unit of measure.

  Example: 3
• 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:
• retailCurrrency: string
  Indicates currency of unit retail and total retail. This will only be used by Brazil orders in case of Warehouse Fulfillment or vendor sourced POs shipped directly to the customer. It is needed for Sales NF generation.

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

  Example: EA
• substituteInd(required): string
  Indicates if substitutes are allowed on a customer order. This will only be used by orders passed to SIM.

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

  Example: EA
• unitRetail: number
  Indicates the unit sales retail of item on the customer order. This will only be used by Brazil orders in case of Warehouse Fulfillment or vendor sourced POs shipped directly to the customer. It is needed for Sales NF generation.

  Example: 12

{
    "required":[
        "item",
        "orderQtySuom",
        "substituteInd"
    ],
    "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":""
        },
        "orderQtySuom":{
            "type":"number",
            "description":"Indicates the quantity of the item ordered by the customer 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"
        },
        "substituteInd":{
            "type":"string",
            "description":"Indicates if substitutes are allowed on a customer order. This will only be used by orders passed to SIM.",
            "example":"N"
        },
        "unitRetail":{
            "type":"number",
            "description":"Indicates the unit sales retail of item on the customer order. This will only be used by Brazil orders in case of Warehouse Fulfillment or vendor sourced POs shipped directly to the customer. It is needed for Sales NF generation.",
            "example":12
        },
        "retailCurrrency":{
            "type":"string",
            "description":"Indicates currency of unit retail and total retail. This will only be used by Brazil orders in case of Warehouse Fulfillment or vendor sourced POs shipped directly to the customer. It is needed for Sales NF generation.",
            "example":"USD"
        },
        "comments":{
            "type":"string",
            "description":"Used to indicate any special instructions for the item, such as services (monograms, engrave, etc).",
            "example":"commentDesc"
        },
        "itemLineNo":{
            "type":"integer",
            "description":"Indicates the detail item line number on the order.",
            "format":"int32",
            "example":1
        }
    },
    "description":"References a collection of customer order fulfillment details.",
    "xml":{
        "name":"fulfilOrdDtl"
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• fulfillOrders: array fulfillOrders
  Array of fulfillment order

{
    "type":"object",
    "properties":{
        "fulfillOrders":{
            "type":"array",
            "description":"Array of fulfillment order",
            "items":{
                "$ref":"#/components/schemas/createfulfillorders$FulfilOrdDesc"
            }
        }
    },
    "xml":{
        "name":"fulfilOrdColDesc"
    }
}

Nested Schema : fulfillOrders

Type: array

Array of fulfillment order

Show Source

• Array of: object fulfilOrdDesc
  Array of fulfillment order

{
    "type":"array",
    "description":"Array of fulfillment order",
    "items":{
        "$ref":"#/components/schemas/createfulfillorders$FulfilOrdDesc"
    }
}

Nested Schema : fulfilOrdDesc

Type: object

Array of fulfillment order

Show Source

• carrierCode: string
  Indicates the carrier the order is to be shipped with, if specified on the order.

  Example: 30
• carrierServiceCode: string
  Indicates the method that was selected for shipping by the customer placing the order (e. g. Standard Shipping, Overnight, etc. ).

  Example: D
• comments: string
  Any comments sent by OMS about the order.

  Example: commentDesc
• consumerDeliveryDate(required): string (date)
  Indicates the desired date the delivery is required by the customer. This will be the GMT time.
• consumerDeliveryTime: string (date-time)
  Indicates the desired time the delivery is required by the customer. This will be the GMT time.
• customerDetail: object fulfilOrdCustDesc
  Referenced object for customer information related to the order.
• customerOrderNo(required): string
  Holds the master customer order number from OMS.

  Example: 12342132156
• deliveryCharges: number
  Contains the delivery charges on drop ship. Mostly relevant for Brazil.

  Example: 3
• deliveryChargesCurrency: string
  Contains the currency of the delivery charges.

  Example: USD
• deliveryType: string
  Allowed Values: [ "S", "C" ]

  Indicates the fulfillment method - ship to customer or store pickup. Expected values are 'S' (ship direct) and 'C' (customer pickup).

  Example: S
• 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: 123123213
• orderDetails(required): array orderDetails
  References a collection of customer order fulfillment details.
• orderPlacedStore: integer (int32)
  Indicates the store number associated with the location that the customer order was placed. For on-line orders this will contain the virtual store number associated with the on-line store. For orders captured in a physical store this will contain the store number for the physical store.

  Example: 1311
• partialDeliveryInd(required): string
  Allowed Values: [ "Y", "N" ]

  Indicates if the order can be picked and shipped partially ('N') or if it should be shipped only when complete ('Y').

  Example: N
• 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":[
        "consumerDeliveryDate",
        "customerOrderNo",
        "fulfillLocId",
        "fulfillOrderNo",
        "orderDetails",
        "partialDeliveryInd"
    ],
    "type":"object",
    "properties":{
        "customerOrderNo":{
            "type":"string",
            "description":"Holds the master customer order number from OMS.",
            "example":"12342132156"
        },
        "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":"123123213"
        },
        "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
        },
        "partialDeliveryInd":{
            "type":"string",
            "description":"Indicates if the order can be picked and shipped partially ('N') or if it should be shipped only when complete ('Y').",
            "example":"N",
            "enum":[
                "Y",
                "N"
            ]
        },
        "deliveryType":{
            "type":"string",
            "description":"Indicates the fulfillment method - ship to customer or store pickup. Expected values are 'S' (ship direct) and 'C' (customer pickup).",
            "example":"S",
            "enum":[
                "S",
                "C"
            ]
        },
        "carrierCode":{
            "type":"string",
            "description":"Indicates the carrier the order is to be shipped with, if specified on the order.",
            "example":"30"
        },
        "carrierServiceCode":{
            "type":"string",
            "description":"Indicates the method that was selected for shipping by the customer placing the order (e. g. Standard Shipping, Overnight, etc. ).",
            "example":"D"
        },
        "consumerDeliveryDate":{
            "type":"string",
            "description":"Indicates the desired date the delivery is required by the customer. This will be the GMT time.",
            "format":"date"
        },
        "consumerDeliveryTime":{
            "type":"string",
            "description":"Indicates the desired time the delivery is required by the customer. This will be the GMT time.",
            "format":"date-time"
        },
        "deliveryCharges":{
            "type":"number",
            "description":"Contains the delivery charges on drop ship. Mostly relevant for Brazil.",
            "example":3
        },
        "deliveryChargesCurrency":{
            "type":"string",
            "description":"Contains the currency of the delivery charges.",
            "example":"USD"
        },
        "comments":{
            "type":"string",
            "description":"Any comments sent by OMS about the order.",
            "example":"commentDesc"
        },
        "customerDetail":{
            "$ref":"#/components/schemas/createfulfillorders$FulfilOrdCustDesc"
        },
        "orderDetails":{
            "type":"array",
            "description":"References a collection of customer order fulfillment details.",
            "items":{
                "$ref":"#/components/schemas/createfulfillorders$FulfilOrdDtl"
            }
        },
        "orderPlacedStore":{
            "type":"integer",
            "description":"Indicates the store number associated with the location that the customer order was placed. For on-line orders this will contain the virtual store number associated with the on-line store. For orders captured in a physical store this will contain the store number for the physical store.",
            "format":"int32",
            "example":1311
        }
    },
    "description":"Array of fulfillment order",
    "xml":{
        "name":"fulfilOrdDesc"
    }
}

Nested Schema : fulfilOrdCustDesc

Type: object

Referenced object for customer information related to the order.

Show Source

• billAddress1: string
  First line of the billing address for the customer.

  Example: 101 First Street
• billAddress2: string
  Second line of the billing address for the customer.

  Example: 201 Second Street
• billAddress3: string
  Third line of the billing address for the customer.

  Example: 301 Third Street
• billCity: string
  City portion of the billing address.

  Example: Minneapolis
• billCompanyName: string
  Contains the company name for the billing address on the order.

  Example: billCompanyName
• billCountryId: string
  Country portion of the billing address.

  Example: US
• billCounty: string
  County portion of the billing address.

  Example: Some County
• billEmail: string
  Contains the billing email.

  Example: [e-mail]
• billFirstName: string
  Contains the first name for the billing address on the order.

  Example: First
• billJurisdiction: string
  Identifies the jurisdiction code for the billing country-state relationship.

  Example:
• billLastName: string
  Contains the last name for the billing address on the order.

  Example: Last
• billPhone: string
  Contains the billing phone number.

  Example: 1800800800
• billPhoneticFirst: string
  Contains the phonetic first name for the billing address on the order.

  Example: First
• billPhoneticLast: string
  Contains the phonetic last name for the billing address on the order.

  Example: Last
• billPost: string
  Postal code portion of the billing address.

  Example: 55555-1234
• billPreferredName: string
  Contains the preferred name for the billing address on the order.

  Example: billPreferredName
• billState: string
  State portion of the billing address.

  Example: MN
• customerNo: string
  Indicates the number that uniquely identifies the customer in OMS.

  Example: 123456
• deliverAddress1: string
  First line of the delivery address for the customer.

  Example: 101 First Street
• deliverAddress2: string
  Second line of the delivery address for the customer.

  Example: 201 Second Street
• deliverAddress3: string
  Third line of the delivery address for the customer.

  Example: 301 Third Street
• deliverCity: string
  City portion of the delivery address.

  Example: Minneapolis
• deliverCompanyName: string
  Contains the company name for the delivery address on the order.

  Example: Company Name
• deliverCountryId: string
  Country portion of the delivery address.

  Example: US
• deliverCounty: string
  County portion of the delivery address.

  Example: Some County
• deliverEmail: string
  Contains the delivery email.

  Example: [e-mail]
• deliverFirstName: string
  Contains the first name for the delivery address on the order.

  Example: First
• deliverJurisdiction: string
  Identifies the jurisdiction code for the delivery country-state relationship.

  Example:
• deliverLastName: string
  Contains the last name for the delivery address on the order.

  Example: Last
• deliverPhone: string
  Contains the delivery phone number.

  Example: 1800800800
• deliverPhoneticFirst: string
  Contains the phonetic first name for the delivery address on the order.

  Example: First
• deliverPhoneticLast: string
  Contains the phonetic last name for the delivery address on the order.

  Example: Last
• deliverPost: string
  Postal code portion of the delivery address.

  Example: 55555-1234
• deliverPreferredName: string
  Contains the preferred name for the delivery address on the order.

  Example: Preferred Name
• deliverState: string
  State portion of the delivery address.

  Example: MN

{
    "type":"object",
    "properties":{
        "customerNo":{
            "type":"string",
            "description":"Indicates the number that uniquely identifies the customer in OMS.",
            "example":"123456"
        },
        "deliverFirstName":{
            "type":"string",
            "description":"Contains the first name for the delivery address on the order.",
            "example":"First"
        },
        "deliverPhoneticFirst":{
            "type":"string",
            "description":"Contains the phonetic first name for the delivery address on the order.",
            "example":"First"
        },
        "deliverLastName":{
            "type":"string",
            "description":"Contains the last name for the delivery address on the order.",
            "example":"Last"
        },
        "deliverPhoneticLast":{
            "type":"string",
            "description":"Contains the phonetic last name for the delivery address on the order.",
            "example":"Last"
        },
        "deliverPreferredName":{
            "type":"string",
            "description":"Contains the preferred name for the delivery address on the order.",
            "example":"Preferred Name"
        },
        "deliverCompanyName":{
            "type":"string",
            "description":"Contains the company name for the delivery address on the order.",
            "example":"Company Name"
        },
        "deliverAddress1":{
            "type":"string",
            "description":"First line of the delivery address for the customer.",
            "example":"101 First Street"
        },
        "deliverAddress2":{
            "type":"string",
            "description":"Second line of the delivery address for the customer.",
            "example":"201 Second Street"
        },
        "deliverAddress3":{
            "type":"string",
            "description":"Third line of the delivery address for the customer.",
            "example":"301 Third Street"
        },
        "deliverCounty":{
            "type":"string",
            "description":"County portion of the delivery address.",
            "example":"Some County"
        },
        "deliverCity":{
            "type":"string",
            "description":"City portion of the delivery address.",
            "example":"Minneapolis"
        },
        "deliverState":{
            "type":"string",
            "description":"State portion of the delivery address.",
            "example":"MN"
        },
        "deliverCountryId":{
            "type":"string",
            "description":"Country portion of the delivery address.",
            "example":"US"
        },
        "deliverPost":{
            "type":"string",
            "description":"Postal code portion of the delivery address.",
            "example":"55555-1234"
        },
        "deliverJurisdiction":{
            "type":"string",
            "description":"Identifies the jurisdiction code for the delivery country-state relationship.",
            "example":""
        },
        "deliverPhone":{
            "type":"string",
            "description":"Contains the delivery phone number.",
            "example":"1800800800"
        },
        "deliverEmail":{
            "type":"string",
            "description":"Contains the delivery email.",
            "example":"[e-mail]"
        },
        "billFirstName":{
            "type":"string",
            "description":"Contains the first name for the billing address on the order.",
            "example":"First"
        },
        "billPhoneticFirst":{
            "type":"string",
            "description":"Contains the phonetic first name for the billing address on the order.",
            "example":"First"
        },
        "billLastName":{
            "type":"string",
            "description":"Contains the last name for the billing address on the order.",
            "example":"Last"
        },
        "billPhoneticLast":{
            "type":"string",
            "description":"Contains the phonetic last name for the billing address on the order.",
            "example":"Last"
        },
        "billPreferredName":{
            "type":"string",
            "description":"Contains the preferred name for the billing address on the order.",
            "example":"billPreferredName"
        },
        "billCompanyName":{
            "type":"string",
            "description":"Contains the company name for the billing address on the order.",
            "example":"billCompanyName"
        },
        "billAddress1":{
            "type":"string",
            "description":"First line of the billing address for the customer.",
            "example":"101 First Street"
        },
        "billAddress2":{
            "type":"string",
            "description":"Second line of the billing address for the customer.",
            "example":"201 Second Street"
        },
        "billAddress3":{
            "type":"string",
            "description":"Third line of the billing address for the customer.",
            "example":"301 Third Street"
        },
        "billCounty":{
            "type":"string",
            "description":"County portion of the billing address.",
            "example":"Some County"
        },
        "billCity":{
            "type":"string",
            "description":"City portion of the billing address.",
            "example":"Minneapolis"
        },
        "billState":{
            "type":"string",
            "description":"State portion of the billing address.",
            "example":"MN"
        },
        "billCountryId":{
            "type":"string",
            "description":"Country portion of the billing address.",
            "example":"US"
        },
        "billPost":{
            "type":"string",
            "description":"Postal code portion of the billing address.",
            "example":"55555-1234"
        },
        "billJurisdiction":{
            "type":"string",
            "description":"Identifies the jurisdiction code for the billing country-state relationship.",
            "example":""
        },
        "billPhone":{
            "type":"string",
            "description":"Contains the billing phone number.",
            "example":"1800800800"
        },
        "billEmail":{
            "type":"string",
            "description":"Contains the billing email.",
            "example":"[e-mail]"
        }
    },
    "description":"Referenced object for customer information related to the order.",
    "xml":{
        "name":"fulfilOrdCustDesc"
    }
}

Nested Schema : orderDetails

Type: array

References a collection of customer order fulfillment details.

Show Source

• Array of: object fulfilOrdDtl
  References a collection of customer order fulfillment details.

{
    "type":"array",
    "description":"References a collection of customer order fulfillment details.",
    "items":{
        "$ref":"#/components/schemas/createfulfillorders$FulfilOrdDtl"
    }
}

Nested Schema : fulfilOrdDtl

Type: object

References a collection of customer order fulfillment details.

Show Source

• comments: string
  Used to indicate any special instructions for the item, such as services (monograms, engrave, etc).

  Example: commentDesc
• 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
• orderQtySuom(required): number
  Indicates the quantity of the item ordered by the customer in item's standard unit of measure.

  Example: 3
• 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:
• retailCurrrency: string
  Indicates currency of unit retail and total retail. This will only be used by Brazil orders in case of Warehouse Fulfillment or vendor sourced POs shipped directly to the customer. It is needed for Sales NF generation.

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

  Example: EA
• substituteInd(required): string
  Indicates if substitutes are allowed on a customer order. This will only be used by orders passed to SIM.

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

  Example: EA
• unitRetail: number
  Indicates the unit sales retail of item on the customer order. This will only be used by Brazil orders in case of Warehouse Fulfillment or vendor sourced POs shipped directly to the customer. It is needed for Sales NF generation.

  Example: 12

{
    "required":[
        "item",
        "orderQtySuom",
        "substituteInd"
    ],
    "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":""
        },
        "orderQtySuom":{
            "type":"number",
            "description":"Indicates the quantity of the item ordered by the customer 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"
        },
        "substituteInd":{
            "type":"string",
            "description":"Indicates if substitutes are allowed on a customer order. This will only be used by orders passed to SIM.",
            "example":"N"
        },
        "unitRetail":{
            "type":"number",
            "description":"Indicates the unit sales retail of item on the customer order. This will only be used by Brazil orders in case of Warehouse Fulfillment or vendor sourced POs shipped directly to the customer. It is needed for Sales NF generation.",
            "example":12
        },
        "retailCurrrency":{
            "type":"string",
            "description":"Indicates currency of unit retail and total retail. This will only be used by Brazil orders in case of Warehouse Fulfillment or vendor sourced POs shipped directly to the customer. It is needed for Sales NF generation.",
            "example":"USD"
        },
        "comments":{
            "type":"string",
            "description":"Used to indicate any special instructions for the item, such as services (monograms, engrave, etc).",
            "example":"commentDesc"
        },
        "itemLineNo":{
            "type":"integer",
            "description":"Indicates the detail item line number on the order.",
            "format":"int32",
            "example":1
        }
    },
    "description":"References a collection of customer order fulfillment details.",
    "xml":{
        "name":"fulfilOrdDtl"
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success

Body ()

Root Schema : fulfilOrdCfmCol

Type: object

Show Source

• collectionSize(required): integer (int32)
  Number of items in the collection.

  Example: 1
• fulfillOrderConfirmations: array fulfillOrderConfirmations
  Array of fulfillment order confirmation response

{
    "required":[
        "collectionSize"
    ],
    "type":"object",
    "properties":{
        "collectionSize":{
            "type":"integer",
            "description":"Number of items in the collection.",
            "format":"int32",
            "example":1
        },
        "fulfillOrderConfirmations":{
            "type":"array",
            "description":"Array of fulfillment order confirmation response",
            "items":{
                "$ref":"#/components/schemas/createfulfillorders$FulfilOrdCfmDesc"
            }
        }
    },
    "xml":{
        "name":"fulfilOrdCfmCol"
    }
}

Nested Schema : fulfillOrderConfirmations

Type: array

Array of fulfillment order confirmation response

Show Source

• Array of: object fulfilOrdCfmDesc
  Array of fulfillment order confirmation response

{
    "type":"array",
    "description":"Array of fulfillment order confirmation response",
    "items":{
        "$ref":"#/components/schemas/createfulfillorders$FulfilOrdCfmDesc"
    }
}

Nested Schema : fulfilOrdCfmDesc

Type: object

Array of fulfillment order confirmation response

Show Source

• confirmNo: integer (int32)
  Contains the PO or Transfer number in RMS related to the fulfillment order line. Required if fulfillment status is 'P'.

  Example: 9999999
• confirmType(required): string
  Allowed Values: [ "P", "X", "C" ]

  Contains the confirmation type. 'P' - Order Partially Created; 'X' - Order Could not be Created; 'C' - Order Completely Created.
• customerOrderNo(required): string
  Holds the master customer order number from OMS.

  Example: 123456
• fulfillLocId: integer (int32)
  Contains the fulfillment location for the order.

  Example: 6000
• 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: 123456
• orderDetails: array orderDetails
  References a collection of customer order confirmation item details.
• systemCode: string
  The code identifying the system associated with the location.

  Example: INV

{
    "required":[
        "confirmType",
        "customerOrderNo",
        "fulfillOrderNo"
    ],
    "type":"object",
    "properties":{
        "customerOrderNo":{
            "type":"string",
            "description":"Holds the master customer order number from OMS.",
            "example":"123456"
        },
        "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":"123456"
        },
        "confirmType":{
            "type":"string",
            "description":"Contains the confirmation type. 'P' - Order Partially Created; 'X' - Order Could not be Created; 'C' - Order Completely Created.",
            "enum":[
                "P",
                "X",
                "C"
            ]
        },
        "confirmNo":{
            "type":"integer",
            "description":"Contains the PO or Transfer number in RMS related to the fulfillment order line. Required if fulfillment status is 'P'.",
            "format":"int32",
            "example":9999999
        },
        "orderDetails":{
            "type":"array",
            "description":"References a collection of customer order confirmation item details.",
            "items":{
                "$ref":"#/components/schemas/createfulfillorders$FulfilOrdCfmDtl"
            }
        },
        "fulfillLocId":{
            "type":"integer",
            "description":"Contains the fulfillment location for the order.",
            "format":"int32",
            "example":6000
        },
        "systemCode":{
            "type":"string",
            "description":"The code identifying the system associated with the location.",
            "example":"INV"
        }
    },
    "description":"Array of fulfillment order confirmation response",
    "xml":{
        "name":"fulfilOrdCfmDesc"
    }
}

Nested Schema : orderDetails

Type: array

References a collection of customer order confirmation item details.

Show Source

• Array of: object fulfilOrdCfmDtl
  References a collection of customer order confirmation item details.

{
    "type":"array",
    "description":"References a collection of customer order confirmation item details.",
    "items":{
        "$ref":"#/components/schemas/createfulfillorders$FulfilOrdCfmDtl"
    }
}

Nested Schema : fulfilOrdCfmDtl

Type: object

References a collection of customer order confirmation item details.

Show Source

• confirmQty(required): number
  Indicates the quantity of the item that can be sourced or fulfilled on the order.

  Example: 3
• confirmQtyUom(required): string
  Indicates the unit of measure of the confirmation quantity.

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

  Example: 100100076
• 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:

{
    "required":[
        "confirmQty",
        "confirmQtyUom",
        "item"
    ],
    "type":"object",
    "properties":{
        "item":{
            "type":"string",
            "description":"Indicates the item ordered by the customer.",
            "example":"100100076"
        },
        "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":""
        },
        "confirmQty":{
            "type":"number",
            "description":"Indicates the quantity of the item that can be sourced or fulfilled on the order.",
            "example":3
        },
        "confirmQtyUom":{
            "type":"string",
            "description":"Indicates the unit of measure of the confirmation quantity.",
            "example":"EA"
        },
        "itemLineNo":{
            "type":"integer",
            "description":"Indicates the detail item line number on the order.",
            "format":"int32",
            "example":1
        }
    },
    "description":"References a collection of customer order confirmation item details.",
    "xml":{
        "name":"fulfilOrdCfmDtl"
    }
}

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