Logistics API: Fulfillment Requests

Logistics API: Fulfillment Requests

Resource #1

https://api.warehousefs.com/public/v1/fulfillment-requests

The fulfillment requests resource allows the merchant to search for the Shipvine identifier assigned to requests for a given merchant identifier.

GET

Request

Query Parameters

The method supports the following query parameters:

Parameter Required? Description
merchant-code Yes The unique merchant code assigned to the merchant's account.
merchant-identifier Yes

The merchant identifier (usually the merchant order number) to search for.

Example Request URL

https://api.warehousefs.com/public/v1/fulfillment-requests?merchant-code=CONTOSO&merchant-identifier=R430463184

Entity Body

No entity body may be included in the request.

Response

If successful, the API will return 200 OK as well as a <FulfillmentRequests /> element in the entity body.

If any error occurs, the HTTP status code will not be 200 OK. An <Errors /> element may be present in the entity body.

Example Response Entity Body

<?xml version="1.0" encoding="utf-8"?>
<FulfillmentRequests>
  <FulfillmentRequest> <!-- (1) -->
    <MerchantIdentifier>R430463184</MerchantIdentifier>
    <ShipvineIdentifier>2-13-137-76804-694-1</ShipvineIdentifier>
  </FulfillmentRequest>
</FulfillmentRequests>
  1. A merchant identifier may match multiple fulfillment requests. You may receive multiple matches in the response.

Resource #2

https://api.warehousefs.com/public/v1/fulfillment-requests/{shipvineIdentifier}

The fulfillment request resource allows the merchant to view detailed information about a specific fulfillment request.

GET

Request

URL Template

The {shipvineIdentifier} field in the URL template should be replaced with the Shipvine identifier for the fulfillment request. You can obtain this identifier by inspecting the /OutboundShipments/OutboundShipment/FulfillmentRequest/WfsIdentifier element of the Outbound Shipment resource or by calling the the version of the Fulfillment Requests resource defined above (passing in a merchant-code and merchant-identifier in the query string).

Example Request URL

https://api.warehousefs.com/public/v1/fulfillment-requests/2-13-319-68634-558-5

Query Parameters

No query parameters may be included in the request.

Entity Body

No entity body may be included in the request.

Response

If successful, the API will return 200 OK as well as a <FulfillmentRequest/> element in the entity body.

If any error occurs, the HTTP status code will not be 200 OK. An <Errors /> element may be present in the entity body.

Example Response Entity Body

<?xml version="1.0" encoding="utf-8"?>
<FulfillmentRequest>
  <Merchant>
    <Code>CONTOSO</Code>
  </Merchant>
  <MerchantIdentifier>100019099</MerchantIdentifier>
  <ShipvineIdentifier>2-13-319-68634-558-5</ShipvineIdentifier>
  <State>
    <Code>Shipped</Code>
    <Name>Shipped</Name>
  </State>
  <ReceivedAtUtc>2013-02-28T17:46:05Z</ReceivedAtUtc>
  <MerchantReturnProfile>DEFAULT</MerchantReturnProfile>
  <ShippingMethod>
    <Code>DOMESTIC-DEFERRED</Code>
    <Name>Domestic Deferred</Name>
  </ShippingMethod>
  <EmailAddress>mr1281@aol.com</EmailAddress>
  <Address type="Shipping" version="Cleansed">
    <Country>US</Country>
    <PersonalName>
      <First>John</First>
      <Middle />
      <Last>Public</Last>
    </PersonalName>
    <Company />
    <StreetLines>
      <StreetLine>7125 Test St Apt 304</StreetLine>
    </StreetLines>
    <CityOrTown>Testville</CityOrTown>
    <StateOrProvince>CA</StateOrProvince>
    <PostalCode>90046-4481</PostalCode>
    <Phone>+18045555555</Phone>
  </Address>
  <FormattedAddress type="Shipping" version="Cleansed"><![CDATA[John Public
7125 Test St Apt 304
Testville CA  90046-4481
United States
+1 804-555-5555]]></FormattedAddress>
  <Lines>
    <Line>
      <Item>
        <MerchantIdentifier>1511-SS13-HOPEFUL YELLOW-M</MerchantIdentifier>
        <VariationsSummary>Color: Hopeful Yellow; Size: M</VariationsSummary>
        <ItemGroup>
          <MerchantIdentifier>1511-SS13</MerchantIdentifier>
          <Name>Gradient Deep Vee Neck (SS13)</Name>
        </ItemGroup>
      </Item>
      <Quantity>1</Quantity>
      <UnitPrice>
        <Amount>36.00</Amount>
        <Currency>USD</Currency>
      </UnitPrice>
    </Line>
    <Line>
      <Item>
        <MerchantIdentifier>1726-SS13-BUFF BLUE-S</MerchantIdentifier>
        <VariationsSummary>Color: Buff Blue; Size: S</VariationsSummary>
        <ItemGroup>
          <MerchantIdentifier>1726-SS13</MerchantIdentifier>
          <Name>Pop Street Jock (SS13)</Name>
        </ItemGroup>
      </Item>
      <Quantity>1</Quantity>
      <UnitPrice>
        <Amount>17.00</Amount>
        <Currency>USD</Currency>
      </UnitPrice>
    </Line>
    <Line>
      <Item>
        <MerchantIdentifier>1713-SS13-HOPEFUL YELLOW-M</MerchantIdentifier>
        <VariationsSummary>Color: Hopeful Yellow; Size: M</VariationsSummary>
        <ItemGroup>
          <MerchantIdentifier>1713-SS13</MerchantIdentifier>
          <Name>Pop Lo No Show Profile Brief (SS13)</Name>
        </ItemGroup>
      </Item>
      <Quantity>1</Quantity>
      <UnitPrice>
        <Amount>20.00</Amount>
        <Currency>USD</Currency>
      </UnitPrice>
    </Line>
    <Line>
      <Item>
        <MerchantIdentifier>1513-SS13-HOPEFUL YELLOW-M</MerchantIdentifier>
        <VariationsSummary>Color: Hopeful Yellow; Size: M</VariationsSummary>
        <ItemGroup>
          <MerchantIdentifier>1513-SS13</MerchantIdentifier>
          <Name>Gradient Lo No Show Profile Brief (SS13)</Name>
        </ItemGroup>
      </Item>
      <Quantity>1</Quantity>
      <UnitPrice>
        <Amount>24.00</Amount>
        <Currency>USD</Currency>
      </UnitPrice>
    </Line>
    <Line>
      <Item>
        <MerchantIdentifier>1527-SS13-HOPEFUL YELLOW-M</MerchantIdentifier>
        <VariationsSummary>Color: Hopeful Yellow; Size: M</VariationsSummary>
        <ItemGroup>
          <MerchantIdentifier>1527-SS13</MerchantIdentifier>
          <Name>Gradient Square Neck Tank (SS13)</Name>
        </ItemGroup>
      </Item>
      <Quantity>1</Quantity>
      <UnitPrice>
        <Amount>28.00</Amount>
        <Currency>USD</Currency>
      </UnitPrice>
    </Line>
    <Line>
      <Item>
        <MerchantIdentifier>1511-SS13-BUFF BLUE-M</MerchantIdentifier>
        <VariationsSummary>Color: Buff Blue; Size: M</VariationsSummary>
        <ItemGroup>
          <MerchantIdentifier>1511-SS13</MerchantIdentifier>
          <Name>Gradient Deep Vee Neck (SS13)</Name>
        </ItemGroup>
      </Item>
      <Quantity>1</Quantity>
      <UnitPrice>
        <Amount>36.00</Amount>
        <Currency>USD</Currency>
      </UnitPrice>
    </Line>
  </Lines>
  <Subtotal>
    <Amount>161.00</Amount>
    <Currency>USD</Currency>
  </Subtotal>
  <Discount>
    <Amount>0.00</Amount>
    <Currency>USD</Currency>
  </Discount>
  <Tax>
    <Amount>0.00</Amount>
    <Currency>USD</Currency>
  </Tax>
  <Shipping>
    <Amount>0.00</Amount>
    <Currency>USD</Currency>
  </Shipping>
  <Total>
    <Amount>161.00</Amount>
    <Currency>USD</Currency>
  </Total>
  <OutboundShipments>
    <OutboundShipment>
      <IdentificationNo>599851915092302</IdentificationNo>
      <CarrierMethod>
        <Code>HomeDelivery</Code>
        <Name>FedEx Home Delivery</Name>
      </CarrierMethod>
      <PackagingType>
        <Code>BOX</Code>
        <Name>Plain Box</Name>
      </PackagingType>
      <ShippedAtUtc>2013-02-28T18:38:53</ShippedAtUtc>
      <Cost>
        <Amount>10.4800</Amount>
        <Currency>USD</Currency>
      </Cost>
      <Weight>
        <Magnitude>1.90</Magnitude>
        <Unit>Pounds</Unit>
      </Weight>
      <MerchantPrepaid>False</MerchantPrepaid>
      <Lines>
        <Line>
          <Item>
            <MerchantIdentifier>1511-SS13-HOPEFUL YELLOW-M</MerchantIdentifier>
            <VariationsSummary>Color: Hopeful Yellow; Size: M</VariationsSummary>
            <ItemGroup>
              <MerchantIdentifier>1511-SS13</MerchantIdentifier>
              <Name>Gradient Deep Vee Neck (SS13)</Name>
            </ItemGroup>
          </Item>
          <Quantity>1</Quantity>
        </Line>
        <Line>
          <Item>
            <MerchantIdentifier>1726-SS13-BUFF BLUE-S</MerchantIdentifier>
            <VariationsSummary>Color: Buff Blue; Size: S</VariationsSummary>
            <ItemGroup>
              <MerchantIdentifier>1726-SS13</MerchantIdentifier>
              <Name>Pop Street Jock (SS13)</Name>
            </ItemGroup>
          </Item>
          <Quantity>1</Quantity>
        </Line>
        <Line>
          <Item>
            <MerchantIdentifier>1713-SS13-HOPEFUL YELLOW-M</MerchantIdentifier>
            <VariationsSummary>Color: Hopeful Yellow; Size: M</VariationsSummary>
            <ItemGroup>
              <MerchantIdentifier>1713-SS13</MerchantIdentifier>
              <Name>Pop Lo No Show Profile Brief (SS13)</Name>
            </ItemGroup>
          </Item>
          <Quantity>1</Quantity>
        </Line>
        <Line>
          <Item>
            <MerchantIdentifier>1513-SS13-HOPEFUL YELLOW-M</MerchantIdentifier>
            <VariationsSummary>Color: Hopeful Yellow; Size: M</VariationsSummary>
            <ItemGroup>
              <MerchantIdentifier>1513-SS13</MerchantIdentifier>
              <Name>Gradient Lo No Show Profile Brief (SS13)</Name>
            </ItemGroup>
          </Item>
          <Quantity>1</Quantity>
        </Line>
        <Line>
          <Item>
            <MerchantIdentifier>1527-SS13-HOPEFUL YELLOW-M</MerchantIdentifier>
            <VariationsSummary>Color: Hopeful Yellow; Size: M</VariationsSummary>
            <ItemGroup>
              <MerchantIdentifier>1527-SS13</MerchantIdentifier>
              <Name>Gradient Square Neck Tank (SS13)</Name>
            </ItemGroup>
          </Item>
          <Quantity>1</Quantity>
        </Line>
        <Line>
          <Item>
            <MerchantIdentifier>1511-SS13-BUFF BLUE-M</MerchantIdentifier>
            <VariationsSummary>Color: Buff Blue; Size: M</VariationsSummary>
            <ItemGroup>
              <MerchantIdentifier>1511-SS13</MerchantIdentifier>
              <Name>Gradient Deep Vee Neck (SS13)</Name>
            </ItemGroup>
          </Item>
          <Quantity>1</Quantity>
        </Line>
      </Lines>
    </OutboundShipment>
  </OutboundShipments>
</FulfillmentRequest>