s1 API Host

<back to all web services

GetProductBackordersRequest

The following routes are available for this service:
GET,OPTIONS/api/products/{id}/backordersGets information about the available backorders for a given productThis requests information about delivery time and quantity from other suppliers. This is only valid for products which have canBackorder set to true.
Parameters:
NameParameterData TypeRequiredDescription
IdpathstringYesThe id of the product (9 numbers long)
QuantityqueryintNoThe quantity for the product that needs to be backordered. Default is 1, If GHS has 2 in stock and the user needs 5, backorder should be 3.

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetProductBackordersRequest HTTP/1.1 
Host: s1-api-tst.fource.nl 
Content-Type: application/xml
Content-Length: length

<GetProductBackordersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Products">
  <Id>String</Id>
  <Quantity>0</Quantity>
</GetProductBackordersRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProductBackordersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Products">
  <Backorders i:nil="true" />
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <UrgentMessages xmlns:d2p1="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.UrgentMessages" i:nil="true" />
</ProductBackordersResponse>