Jump to

• Request
• Response

Get Price for Item/Locations on Provided Date

post

/services/private/priceInquiry

The Price Inquiry web service allows user to request the the past, present or future price of one or more ranged items at one or more locations.

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

• date: string (date)
• itemLocations: array array itemLocations
• pageNumber: integer (int32)
• pageSize: integer (int32)
• sortOrder: string

{
    "type":"object",
    "properties":{
        "itemLocations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PriceInquiryItemLocation"
            }
        },
        "date":{
            "type":"string",
            "format":"date"
        },
        "pageNumber":{
            "type":"integer",
            "format":"int32"
        },
        "pageSize":{
            "type":"integer",
            "format":"int32"
        },
        "sortOrder":{
            "type":"string"
        }
    }
}

Nested Schema : itemLocations

Type: array

Show Source

• Array of: object PriceInquiryItemLocation

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

Nested Schema : PriceInquiryItemLocation

Type: object

Show Source

• item: string
• location: integer (int64)

{
    "type":"object",
    "properties":{
        "item":{
            "type":"string"
        },
        "location":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• date: string (date)
• itemLocations: array array itemLocations
• pageNumber: integer (int32)
• pageSize: integer (int32)
• sortOrder: string

{
    "type":"object",
    "properties":{
        "itemLocations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PriceInquiryItemLocation"
            }
        },
        "date":{
            "type":"string",
            "format":"date"
        },
        "pageNumber":{
            "type":"integer",
            "format":"int32"
        },
        "pageSize":{
            "type":"integer",
            "format":"int32"
        },
        "sortOrder":{
            "type":"string"
        }
    }
}

Nested Schema : itemLocations

Type: array

Show Source

• Array of: object PriceInquiryItemLocation

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

Nested Schema : PriceInquiryItemLocation

Type: object

Show Source

• item: string
• location: integer (int64)

{
    "type":"object",
    "properties":{
        "item":{
            "type":"string"
        },
        "location":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

Default Response

default response

Body ()

Root Schema : PriceInquiryResponse

Type: object

Show Source

• hyperMediaContent: object object hyperMediaContent
• itemLocationPrices: array array itemLocationPrices
• links: array array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "SELF_LINK",
                    "NEXT_LINK",
                    "PREV_LINK",
                    "CUSTOM_LINK"
                ]
            }
        },
        "itemLocationPrices":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ItemLocationPrice"
            }
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : itemLocationPrices

Type: array

Show Source

• Array of: object ItemLocationPrice

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

Nested Schema : links

Type: array

Show Source

• Array of: string
  Allowed Values: [ "SELF_LINK", "NEXT_LINK", "PREV_LINK", "CUSTOM_LINK" ]

{
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "SELF_LINK",
            "NEXT_LINK",
            "PREV_LINK",
            "CUSTOM_LINK"
        ]
    }
}

Nested Schema : ItemLocationPrice

Type: object

Show Source

• currency: string
• date: string (date)
• location: integer (int64)
• onClearance: string
• requestedItem: string
• sellingPrice: number
• sellingUom: string
• transactionItem: string

{
    "type":"object",
    "properties":{
        "requestedItem":{
            "type":"string"
        },
        "transactionItem":{
            "type":"string"
        },
        "location":{
            "type":"integer",
            "format":"int64"
        },
        "date":{
            "type":"string",
            "format":"date"
        },
        "onClearance":{
            "type":"string"
        },
        "sellingPrice":{
            "type":"number"
        },
        "sellingUom":{
            "type":"string"
        },
        "currency":{
            "type":"string"
        }
    }
}

Back to Top