Jump to

• Request
• Response

Create Book Transfer

post

/services/private/Transfer/customerOrderBookTransfer

This service will be built to virtually move inventory from one location to the other for the purposes of attributing the sale to a location different from the location that is fulfilling the order physically.

Request

Header Parameters

• Accept-Language:
  Accept-Language header

  Example:

  en-US

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: array

Show Source

• Array of: object RestCustomerOrderBtsfRec

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RestCustomerOrderBtsfRec"
    }
}

Nested Schema : RestCustomerOrderBtsfRec

Type: object

Show Source

• approvalDate: string (date-time)
• attributeNames: array attributeNames
• attributes: array attributes
• customerOrderNumber: string
• fromLocation: integer (int64)
• fulfillOrderNumber: string
• hyperMediaContent: object hyperMediaContent
• itemsDetail: array itemsDetail
• jsonFieldNameMap: object jsonFieldNameMap
  Additional Properties Allowed: additionalProperties
• links: array links
• toLocation: integer (int64)
• updateCustomerReservedQty: string
• userId: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "attributeNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "attributes":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "jsonFieldNameMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "fromLocation":{
            "type":"integer",
            "format":"int64"
        },
        "toLocation":{
            "type":"integer",
            "format":"int64"
        },
        "customerOrderNumber":{
            "type":"string"
        },
        "fulfillOrderNumber":{
            "type":"string"
        },
        "updateCustomerReservedQty":{
            "type":"string"
        },
        "itemsDetail":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RestCustomerOrdBtsfDtlRec"
            }
        },
        "approvalDate":{
            "type":"string",
            "format":"date-time"
        },
        "userId":{
            "type":"string"
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : attributeNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : itemsDetail

Type: array

Show Source

• Array of: object RestCustomerOrdBtsfDtlRec

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RestCustomerOrdBtsfDtlRec"
    }
}

Nested Schema : jsonFieldNameMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : items

Type: object

Nested Schema : RestCustomerOrdBtsfDtlRec

Type: object

Show Source

• attributeNames: array attributeNames
• attributes: array attributes
• hyperMediaContent: object hyperMediaContent
• item: string
• jsonFieldNameMap: object jsonFieldNameMap
  Additional Properties Allowed: additionalProperties
• links: array links
• quantity: number

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "attributeNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "attributes":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "jsonFieldNameMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "item":{
            "type":"string"
        },
        "quantity":{
            "type":"number"
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : attributeNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : jsonFieldNameMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : items

Type: object

Nested Schema : Link

Type: object

Show Source

• href: string
• methodType: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string"
        },
        "rel":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "methodType":{
            "type":"string"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object RestCustomerOrderBtsfRec

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RestCustomerOrderBtsfRec"
    }
}

Nested Schema : RestCustomerOrderBtsfRec

Type: object

Show Source

• approvalDate: string (date-time)
• attributeNames: array attributeNames
• attributes: array attributes
• customerOrderNumber: string
• fromLocation: integer (int64)
• fulfillOrderNumber: string
• hyperMediaContent: object hyperMediaContent
• itemsDetail: array itemsDetail
• jsonFieldNameMap: object jsonFieldNameMap
  Additional Properties Allowed: additionalProperties
• links: array links
• toLocation: integer (int64)
• updateCustomerReservedQty: string
• userId: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "attributeNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "attributes":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "jsonFieldNameMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "fromLocation":{
            "type":"integer",
            "format":"int64"
        },
        "toLocation":{
            "type":"integer",
            "format":"int64"
        },
        "customerOrderNumber":{
            "type":"string"
        },
        "fulfillOrderNumber":{
            "type":"string"
        },
        "updateCustomerReservedQty":{
            "type":"string"
        },
        "itemsDetail":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RestCustomerOrdBtsfDtlRec"
            }
        },
        "approvalDate":{
            "type":"string",
            "format":"date-time"
        },
        "userId":{
            "type":"string"
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : attributeNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : itemsDetail

Type: array

Show Source

• Array of: object RestCustomerOrdBtsfDtlRec

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RestCustomerOrdBtsfDtlRec"
    }
}

Nested Schema : jsonFieldNameMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : items

Type: object

Nested Schema : RestCustomerOrdBtsfDtlRec

Type: object

Show Source

• attributeNames: array attributeNames
• attributes: array attributes
• hyperMediaContent: object hyperMediaContent
• item: string
• jsonFieldNameMap: object jsonFieldNameMap
  Additional Properties Allowed: additionalProperties
• links: array links
• quantity: number

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "attributeNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "attributes":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "jsonFieldNameMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "item":{
            "type":"string"
        },
        "quantity":{
            "type":"number"
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : attributeNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : jsonFieldNameMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : items

Type: object

Nested Schema : Link

Type: object

Show Source

• href: string
• methodType: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string"
        },
        "rel":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "methodType":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

Default Response

default response

Body ()

Root Schema : Record

Type: object

Show Source

• attributeNames: array attributeNames
• attributes: array attributes
• hyperMediaContent: object hyperMediaContent
• jsonFieldNameMap: object jsonFieldNameMap
  Additional Properties Allowed: additionalProperties
• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "attributeNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "attributes":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "jsonFieldNameMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : attributeNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : jsonFieldNameMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : items

Type: object

Nested Schema : Link

Type: object

Show Source

• href: string
• methodType: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string"
        },
        "rel":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "methodType":{
            "type":"string"
        }
    }
}

Back to Top