Order Item Calls

The calls on this page relate to products. Order items are ordered instances of products.

All calls that return custom field values (product metadata fields, order fields, user profile fields etc.) only return values stored in the Storefront database. Values dynamically retrieved from remote data sources (such as third party web services and APIs) are not returned.

GetOrderItem

This call returns information about a single order item.

Request

POST /roiwebinterface.asmx HTTP/1.1
Host: host
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetOrderItem xmlns="http://roidistribution.com/webapi">
      <orderItemId>string</orderItemId>
      <token>string</token>
    </GetOrderItem>
  </soap12:Body>
</soap12:Envelope>

<orderItemId> - the ID of the order item to view
<token> - the authorisation token to validate the API call

Response

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetOrderItemResponse xmlns="http://roidistribution.com/webapi">
      <GetOrderItemResult>
        <OrderItemId>string</OrderItemId>
        <ExternalId>string</ExternalId>
        <OrderId>string</OrderId>
        <ProductId>string</ProductId>
        <Description>string</Description>
        <Quantity>long</Quantity>
        <Price>
          <unit>eUnknown or ePound or eDollar or eEuro</unit>
          <amount>double</amount>
        </Price>
        <Status>Shipped or Unreviewed or PendingData or PendingPrep or Ready or Sent or Rendered or Failed or Packed or Printed or Rejected</Status>
        <CustomFormFillFields>
          <CustomField>
            <Name>string</Name>
            <Value>string</Value>
          </CustomField>
          <CustomField>
            <Name>string</Name>
            <Value>string</Value>
          </CustomField>
        </CustomFormFillFields>
        <CustomPrintingFields>
          <CustomField>
            <Name>string</Name>
            <Value>string</Value>
          </CustomField>
          <CustomField>
            <Name>string</Name>
            <Value>string</Value>
          </CustomField>
        </CustomPrintingFields>
      </GetOrderItemResult>
    </GetOrderItemResponse>
  </soap12:Body>
</soap12:Envelope>

<OrderItemId> - the ID of the order item
<ExternalId> - the ID of the order item visible on the deployment
<OrderId> - the ID of the order the item is part of
<ProductId> - the ID of the product the item is an instance of
<Description> - the description the user has givent to the order item
<Quantity> - the number of copies ordered
<Price> - the enumerated currency and amount of the order item’s cost
<Status> - the value of the enumerated OrderItemStatus for the item’s current production state
<CustomFormFillFields> - A list of custom field key-value pairs of the order item’s form filling fields
<CustomPrintingFields> - A list of custom field key-value pairs of the order item’s production fields

GetOrderItemList

This call returns information about multiple order items.

Request

POST /roiwebinterface.asmx HTTP/1.1
Host: host
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetOrderItemList xmlns="http://roidistribution.com/webapi">
      <orderItemIdList>
        <string>string</string>
        <string>string</string>
      </orderItemIdList>
      <token>string</token>
    </GetOrderItemList>
  </soap12:Body>
</soap12:Envelope>

<orderItemIdList> - an ID list of the order items to view
<token> - the authorisation token to validate the API call

Response

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetOrderItemListResponse xmlns="http://roidistribution.com/webapi">
      <GetOrderItemListResult>
        <OrderItem>
          <OrderItemId>string</OrderItemId>
          <ExternalId>string</ExternalId>
          <OrderId>string</OrderId>
          <ProductId>string</ProductId>
          <Description>string</Description>
          <Quantity>long</Quantity>
          <Price>
            <unit>eUnknown or ePound or eDollar or eEuro</unit>
            <amount>double</amount>
          </Price>
          <Status>Shipped or Unreviewed or PendingData or PendingPrep or Ready or Sent or Rendered or Failed or Packed or Printed or Rejected</Status>
          <CustomFormFillFields>
            <CustomField xsi:nil="true" />
            <CustomField xsi:nil="true" />
          </CustomFormFillFields>
          <CustomPrintingFields>
            <CustomField xsi:nil="true" />
            <CustomField xsi:nil="true" />
          </CustomPrintingFields>
        </OrderItem>
        <OrderItem>
          <OrderItemId>string</OrderItemId>
          <ExternalId>string</ExternalId>
          <OrderId>string</OrderId>
          <ProductId>string</ProductId>
          <Description>string</Description>
          <Quantity>long</Quantity>
          <Price>
            <unit>eUnknown or ePound or eDollar or eEuro</unit>
            <amount>double</amount>
          </Price>
          <Status>Shipped or Unreviewed or PendingData or PendingPrep or Ready or Sent or Rendered or Failed or Packed or Printed or Rejected</Status>
          <CustomFormFillFields>
            <CustomField xsi:nil="true" />
            <CustomField xsi:nil="true" />
          </CustomFormFillFields>
          <CustomPrintingFields>
            <CustomField xsi:nil="true" />
            <CustomField xsi:nil="true" />
          </CustomPrintingFields>
        </OrderItem>
      </GetOrderItemListResult>
    </GetOrderItemListResponse>
  </soap12:Body>
</soap12:Envelope>

<OrderItemId> - the ID of the order item
<ExternalId> - the ID of the order item visible on the deployment
<OrderId> - the ID of the order the item is part of
<ProductId> - the ID of the product the item is an instance of
<Description> - the description the user has givent to the order item
<Quantity> - the number of copies ordered
<Price> - the enumerated currency and amount of the order item’s cost
<Status> - the value of the enumerated OrderItemStatus for the item’s current production state
<CustomFormFillFields> - A list of custom field key-value pairs of the order item’s form filling fields
<CustomPrintingFields> - A list of custom field key-value pairs of the order item’s production fields

SetOrderItemStatus

This call updates an order item’s status. It is reccomend to only set the Shipped, Packed or Printed states to avoid triggering unintended workflows.

Request

POST /roiwebinterface.asmx HTTP/1.1
Host: host
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SetOrderItemStatus xmlns="http://roidistribution.com/webapi">
      <orderItemId>string</orderItemId>
      <orderItemStatus>Shipped or Unreviewed or PendingData or PendingPrep or Ready or Sent or Rendered or Failed or Packed or Printed or Rejected</orderItemStatus>
      <token>string</token>
    </SetOrderItemStatus>
  </soap12:Body>
</soap12:Envelope>

<orderItemId> - the ID of the order item
<orderItemStatus> - the value of the enumerated OrderItemStatus set the item’s production state to
<token> - the authorisation token to validate the API call

Response

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SetOrderItemStatusResponse xmlns="http://roidistribution.com/webapi" />
  </soap12:Body>
</soap12:Envelope>

The call returns an error if it fails to set the requested order item status

GetOrderItemOutputPath

This call returns information about multiple order items.

Request

POST /roiwebinterface.asmx HTTP/1.1
Host: host
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetOrderItemOutputPath xmlns="http://roidistribution.com/webapi">
      <orderItemId>string</orderItemId>
      <token>string</token>
    </GetOrderItemOutputPath>
  </soap12:Body>
</soap12:Envelope>

<orderItemId> - an ID of the order item
<token> - the authorisation token to validate the API call

Response

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetOrderItemOutputPathResponse xmlns="http://roidistribution.com/webapi">
      <GetOrderItemOutputPathResult>
        <string>string</string>
        <string>string</string>
      </GetOrderItemOutputPathResult>
    </GetOrderItemOutputPathResponse>
  </soap12:Body>
</soap12:Envelope>

<GetOrderItemOutputPathResult> - array of output paths