POST {opco}/api/v1/Customer/{customerId}/Products/Pricing/Search

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerId

string

Required

opco

string

None.

Body Parameters

CustomerPricingRequest
NameDescriptionTypeAdditional information
ProductPricingRequests

Collection of ProductPricingRequest

None.

Request Formats

application/json, text/json

Sample:
{
  "productPricingRequests": [
    {
      "productSearchIdentifier": {
        "type": 0,
        "search": "sample string 1"
      },
      "pricingQuantity": {
        "unitCode": "sample string 1",
        "value": 2
      }
    },
    {
      "productSearchIdentifier": {
        "type": 0,
        "search": "sample string 1"
      },
      "pricingQuantity": {
        "unitCode": "sample string 1",
        "value": 2
      }
    }
  ]
}

application/xml, text/xml

Sample:
<CustomerPricingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalAPI.Models.Customer.v1">
  <ProductPricingRequests>
    <ProductPricingRequest>
      <PricingQuantity>
        <UnitCode>sample string 1</UnitCode>
        <Value>2</Value>
      </PricingQuantity>
      <ProductSearchIdentifier xmlns:d4p1="http://schemas.datacontract.org/2004/07/ExternalAPI.Models.Product.v1">
        <d4p1:Search>sample string 1</d4p1:Search>
        <d4p1:Type>ProductId</d4p1:Type>
      </ProductSearchIdentifier>
    </ProductPricingRequest>
    <ProductPricingRequest>
      <PricingQuantity>
        <UnitCode>sample string 1</UnitCode>
        <Value>2</Value>
      </PricingQuantity>
      <ProductSearchIdentifier xmlns:d4p1="http://schemas.datacontract.org/2004/07/ExternalAPI.Models.Product.v1">
        <d4p1:Search>sample string 1</d4p1:Search>
        <d4p1:Type>ProductId</d4p1:Type>
      </ProductSearchIdentifier>
    </ProductPricingRequest>
  </ProductPricingRequests>
</CustomerPricingRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CustomerPricingRequest'.

Response Information

Resource Description

Collection of CustomerPricingResult
NameDescriptionTypeAdditional information
Id

string

None.

ProductId

string

None.

Quantity

integer

None.

RequestedUnitOfMeasure

string

None.

RoundedPrice

UnitPrice

None.

Price

UnitPrice

None.

RoundedCustomerPrice

UnitPrice

None.

CustomerPrice

UnitPrice

None.

UnitOfMeasure

UnitOfMeasure

None.

QuantityBreaks

Collection of QuantityBreak

None.

ExtendedRoundedPrice

decimal number

None.

ExtendedPrice

decimal number

None.

ExtendedRoundedCustomerPrice

decimal number

None.

ExtendedCustomerPrice

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": "sample string 1",
    "productId": "sample string 2",
    "quantity": 3,
    "requestedUnitOfMeasure": "sample string 4",
    "roundedPrice": {
      "unitCode": "sample string 1",
      "value": 2.0
    },
    "price": {
      "unitCode": "sample string 1",
      "value": 2.0
    },
    "roundedCustomerPrice": {
      "unitCode": "sample string 1",
      "value": 2.0
    },
    "customerPrice": {
      "unitCode": "sample string 1",
      "value": 2.0
    },
    "unitOfMeasure": {
      "unitCode": "sample string 1",
      "baseQuantity": 2,
      "isPricingOnly": true
    },
    "quantityBreaks": [
      {
        "roundedPrice": {
          "unitCode": "sample string 1",
          "value": 2.0
        },
        "price": {
          "unitCode": "sample string 1",
          "value": 2.0
        },
        "quantity": 1,
        "unitOfMeasure": "sample string 2",
        "type": "sample string 3"
      },
      {
        "roundedPrice": {
          "unitCode": "sample string 1",
          "value": 2.0
        },
        "price": {
          "unitCode": "sample string 1",
          "value": 2.0
        },
        "quantity": 1,
        "unitOfMeasure": "sample string 2",
        "type": "sample string 3"
      }
    ],
    "extendedRoundedPrice": 5.0,
    "extendedPrice": 6.0,
    "extendedRoundedCustomerPrice": 7.0,
    "extendedCustomerPrice": 8.0
  },
  {
    "id": "sample string 1",
    "productId": "sample string 2",
    "quantity": 3,
    "requestedUnitOfMeasure": "sample string 4",
    "roundedPrice": {
      "unitCode": "sample string 1",
      "value": 2.0
    },
    "price": {
      "unitCode": "sample string 1",
      "value": 2.0
    },
    "roundedCustomerPrice": {
      "unitCode": "sample string 1",
      "value": 2.0
    },
    "customerPrice": {
      "unitCode": "sample string 1",
      "value": 2.0
    },
    "unitOfMeasure": {
      "unitCode": "sample string 1",
      "baseQuantity": 2,
      "isPricingOnly": true
    },
    "quantityBreaks": [
      {
        "roundedPrice": {
          "unitCode": "sample string 1",
          "value": 2.0
        },
        "price": {
          "unitCode": "sample string 1",
          "value": 2.0
        },
        "quantity": 1,
        "unitOfMeasure": "sample string 2",
        "type": "sample string 3"
      },
      {
        "roundedPrice": {
          "unitCode": "sample string 1",
          "value": 2.0
        },
        "price": {
          "unitCode": "sample string 1",
          "value": 2.0
        },
        "quantity": 1,
        "unitOfMeasure": "sample string 2",
        "type": "sample string 3"
      }
    ],
    "extendedRoundedPrice": 5.0,
    "extendedPrice": 6.0,
    "extendedRoundedCustomerPrice": 7.0,
    "extendedCustomerPrice": 8.0
  }
]

application/xml, text/xml

Sample:
<ArrayOfCustomerPricingResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalAPI.Models.Customer.v1">
  <CustomerPricingResult>
    <CustomerPrice xmlns:d3p1="http://schemas.datacontract.org/2004/07/ExternalAPI.Domain.Models.Customer.v1">
      <d3p1:UnitCode>sample string 1</d3p1:UnitCode>
      <d3p1:Value>2</d3p1:Value>
    </CustomerPrice>
    <ExtendedCustomerPrice>8</ExtendedCustomerPrice>
    <ExtendedPrice>6</ExtendedPrice>
    <ExtendedRoundedCustomerPrice>7</ExtendedRoundedCustomerPrice>
    <ExtendedRoundedPrice>5</ExtendedRoundedPrice>
    <Id>sample string 1</Id>
    <Price xmlns:d3p1="http://schemas.datacontract.org/2004/07/ExternalAPI.Domain.Models.Customer.v1">
      <d3p1:UnitCode>sample string 1</d3p1:UnitCode>
      <d3p1:Value>2</d3p1:Value>
    </Price>
    <ProductId>sample string 2</ProductId>
    <Quantity>3</Quantity>
    <QuantityBreaks xmlns:d3p1="http://schemas.datacontract.org/2004/07/ExternalAPI.Domain.Models.Customer.v1">
      <d3p1:QuantityBreak>
        <d3p1:Price>
          <d3p1:UnitCode>sample string 1</d3p1:UnitCode>
          <d3p1:Value>2</d3p1:Value>
        </d3p1:Price>
        <d3p1:Quantity>1</d3p1:Quantity>
        <d3p1:RoundedPrice>
          <d3p1:UnitCode>sample string 1</d3p1:UnitCode>
          <d3p1:Value>2</d3p1:Value>
        </d3p1:RoundedPrice>
        <d3p1:Type>sample string 3</d3p1:Type>
        <d3p1:UnitOfMeasure>sample string 2</d3p1:UnitOfMeasure>
      </d3p1:QuantityBreak>
      <d3p1:QuantityBreak>
        <d3p1:Price>
          <d3p1:UnitCode>sample string 1</d3p1:UnitCode>
          <d3p1:Value>2</d3p1:Value>
        </d3p1:Price>
        <d3p1:Quantity>1</d3p1:Quantity>
        <d3p1:RoundedPrice>
          <d3p1:UnitCode>sample string 1</d3p1:UnitCode>
          <d3p1:Value>2</d3p1:Value>
        </d3p1:RoundedPrice>
        <d3p1:Type>sample string 3</d3p1:Type>
        <d3p1:UnitOfMeasure>sample string 2</d3p1:UnitOfMeasure>
      </d3p1:QuantityBreak>
    </QuantityBreaks>
    <RequestedUnitOfMeasure>sample string 4</RequestedUnitOfMeasure>
    <RoundedCustomerPrice xmlns:d3p1="http://schemas.datacontract.org/2004/07/ExternalAPI.Domain.Models.Customer.v1">
      <d3p1:UnitCode>sample string 1</d3p1:UnitCode>
      <d3p1:Value>2</d3p1:Value>
    </RoundedCustomerPrice>
    <RoundedPrice xmlns:d3p1="http://schemas.datacontract.org/2004/07/ExternalAPI.Domain.Models.Customer.v1">
      <d3p1:UnitCode>sample string 1</d3p1:UnitCode>
      <d3p1:Value>2</d3p1:Value>
    </RoundedPrice>
    <UnitOfMeasure xmlns:d3p1="http://schemas.datacontract.org/2004/07/ExternalAPI.Domain.Models.Generic">
      <d3p1:BaseQuantity>2</d3p1:BaseQuantity>
      <d3p1:IsPricingOnly>true</d3p1:IsPricingOnly>
      <d3p1:UnitCode>sample string 1</d3p1:UnitCode>
    </UnitOfMeasure>
  </CustomerPricingResult>
  <CustomerPricingResult>
    <CustomerPrice xmlns:d3p1="http://schemas.datacontract.org/2004/07/ExternalAPI.Domain.Models.Customer.v1">
      <d3p1:UnitCode>sample string 1</d3p1:UnitCode>
      <d3p1:Value>2</d3p1:Value>
    </CustomerPrice>
    <ExtendedCustomerPrice>8</ExtendedCustomerPrice>
    <ExtendedPrice>6</ExtendedPrice>
    <ExtendedRoundedCustomerPrice>7</ExtendedRoundedCustomerPrice>
    <ExtendedRoundedPrice>5</ExtendedRoundedPrice>
    <Id>sample string 1</Id>
    <Price xmlns:d3p1="http://schemas.datacontract.org/2004/07/ExternalAPI.Domain.Models.Customer.v1">
      <d3p1:UnitCode>sample string 1</d3p1:UnitCode>
      <d3p1:Value>2</d3p1:Value>
    </Price>
    <ProductId>sample string 2</ProductId>
    <Quantity>3</Quantity>
    <QuantityBreaks xmlns:d3p1="http://schemas.datacontract.org/2004/07/ExternalAPI.Domain.Models.Customer.v1">
      <d3p1:QuantityBreak>
        <d3p1:Price>
          <d3p1:UnitCode>sample string 1</d3p1:UnitCode>
          <d3p1:Value>2</d3p1:Value>
        </d3p1:Price>
        <d3p1:Quantity>1</d3p1:Quantity>
        <d3p1:RoundedPrice>
          <d3p1:UnitCode>sample string 1</d3p1:UnitCode>
          <d3p1:Value>2</d3p1:Value>
        </d3p1:RoundedPrice>
        <d3p1:Type>sample string 3</d3p1:Type>
        <d3p1:UnitOfMeasure>sample string 2</d3p1:UnitOfMeasure>
      </d3p1:QuantityBreak>
      <d3p1:QuantityBreak>
        <d3p1:Price>
          <d3p1:UnitCode>sample string 1</d3p1:UnitCode>
          <d3p1:Value>2</d3p1:Value>
        </d3p1:Price>
        <d3p1:Quantity>1</d3p1:Quantity>
        <d3p1:RoundedPrice>
          <d3p1:UnitCode>sample string 1</d3p1:UnitCode>
          <d3p1:Value>2</d3p1:Value>
        </d3p1:RoundedPrice>
        <d3p1:Type>sample string 3</d3p1:Type>
        <d3p1:UnitOfMeasure>sample string 2</d3p1:UnitOfMeasure>
      </d3p1:QuantityBreak>
    </QuantityBreaks>
    <RequestedUnitOfMeasure>sample string 4</RequestedUnitOfMeasure>
    <RoundedCustomerPrice xmlns:d3p1="http://schemas.datacontract.org/2004/07/ExternalAPI.Domain.Models.Customer.v1">
      <d3p1:UnitCode>sample string 1</d3p1:UnitCode>
      <d3p1:Value>2</d3p1:Value>
    </RoundedCustomerPrice>
    <RoundedPrice xmlns:d3p1="http://schemas.datacontract.org/2004/07/ExternalAPI.Domain.Models.Customer.v1">
      <d3p1:UnitCode>sample string 1</d3p1:UnitCode>
      <d3p1:Value>2</d3p1:Value>
    </RoundedPrice>
    <UnitOfMeasure xmlns:d3p1="http://schemas.datacontract.org/2004/07/ExternalAPI.Domain.Models.Generic">
      <d3p1:BaseQuantity>2</d3p1:BaseQuantity>
      <d3p1:IsPricingOnly>true</d3p1:IsPricingOnly>
      <d3p1:UnitCode>sample string 1</d3p1:UnitCode>
    </UnitOfMeasure>
  </CustomerPricingResult>
</ArrayOfCustomerPricingResult>