Logistics API: Outbound Shipments

Logistics API: Outbound Shipments

Resource

https://api.warehousefs.com/public/v1/outbound-shipments

The outbound shipments resource represents a "collection" of all of the outbound shipments recorded in the Shipvine Logistics system. Merchants can extract information about their outbound shipments by sending GET requests to this resource.

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.
created-since No

A date and time, universal coordinated time (UTC). If specified, only outbound shipments that have been created at Shipvine Logistics since the specified date and time will be returned in the response. If not specified, the first few hundred outbound shipments associated with the merchant's account will be returned.

The date and time should be in a format that is readily parsable. The canonical date and time format is ISO 8601 format. For example, 1994-11-05T13:15:30Z.

For most integrations, the typical behavior is to leave out the created-since parameter on the first request, and then send the parameter on each subsequent request. Doing this keeps transfer times between the Shipvine Logistics API and the merchant's e-commerce server low by only sending the outbound shipments that have been created since the last request.

We recommend "backdating" the created-since parameter by a few minutes in case the time on your e-commerce server drifts from the time on the Shipvine Logistics API server. An integration should gracefully handle the scenario where the same outbound shipment is encountered multiple times.

Example Request Query String

https://api.warehousefs.com/public/v1/outbound-shipments?merchant-code=CONTOSO

Example Request Query String

https://api.warehousefs.com/public/v1/outbound-shipments?merchant-code=CONTOSO&created-since=2009-10-15T04:45:00Z

Entity Body

No entity body may be specified in the request.

Response

If successful, the API will return 200 OK as well as a <OutboundShipments/> element in the entity body. See the XML schema for details about that element.

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"?>
<OutboundShipments xmlns="urn:WarehouseFS-1.0">
  <OutboundShipment>
    <FulfillmentRequest> <!-- (1) -->
      <MerchantIdentifier>100000099</MerchantIdentifier>
      <WfsIdentifier>2-09-288-99999-012-3</WfsIdentifier>
    </FulfillmentRequest>
    <IdentificationNo>LN999999999US</IdentificationNo> <!-- (2) -->
    <CarrierMethod> <!-- (3) -->
      <Code>FirstClassMailInternational</Code>
      <Name>USPS First Class Mail International</Name>
    </CarrierMethod>
    <PackagingType>
      <Code>BAG</Code>
      <Name>Polyamide Bag</Name>
    </PackagingType>
    <ShippedAtUtc>2009-10-15T13:54:13</ShippedAtUtc>
    <Cost> <!-- (4) -->
      <Amount>5.6400</Amount>
      <Currency>USD</Currency>
    </Cost>
    <Weight>
      <Magnitude>0.35</Magnitude>
      <Unit>Pounds</Unit>
    </Weight>
    <MerchantPrepaid>True</MerchantPrepaid> <!-- (5) -->
    <Lines> <!-- (6) -->
      <Line>
        <Item>
          <MerchantIdentifier>6161115-Black-Small</MerchantIdentifier>
        </Item>
        <Quantity>1</Quantity>
      </Line>
    </Lines>
  </OutboundShipment>
  <OutboundShipment>
    <FulfillmentRequest>
      <MerchantIdentifier>100000888</MerchantIdentifier>
      <WfsIdentifier>2-09-288-47940-888-1</WfsIdentifier>
    </FulfillmentRequest>
    <IdentificationNo>9101148999600291296735</IdentificationNo>
    <CarrierMethod>
      <Code>PriorityMail</Code>
      <Name>USPS Priority Mail</Name>
    </CarrierMethod>
    <PackagingType>
      <Code>BAG</Code>
      <Name>Polyamide Bag</Name>
    </PackagingType>
    <ShippedAtUtc>2009-10-15T13:23:56</ShippedAtUtc>
    <Cost>
      <Amount>4.8000</Amount>
      <Currency>USD</Currency>
    </Cost>
    <Weight>
      <Magnitude>0.95</Magnitude>
      <Unit>Pounds</Unit>
    </Weight>
    <MerchantPrepaid>True</MerchantPrepaid>
    <Lines>
      <Line>
        <Item>
          <MerchantIdentifier>6219523-Glacier Grey-Small</MerchantIdentifier>
        </Item>
        <Quantity>2</Quantity>
      </Line>
      <Line>
        <Item>
          <MerchantIdentifier>6219422-Limelight-Small</MerchantIdentifier>
        </Item>
        <Quantity>2</Quantity>
      </Line>
    </Lines>
  </OutboundShipment>
</OutboundShipments>
  1. The <FulfillmentRequest /> element describes the fulfillment request that the outbound shipment is associated with. Most merchants look at the <MerchantIdentifier /> element to determine which order to mark as shipped in their own e-commerce systems.
  2. The tracking number or identification number for the parcel. For international air mail shipments, this value may be a customs declaration number instead of a true tracking number.
  3. The carrier method describes how the parcel physically shipped. In this example, the merchant originally specified INTL-DEFERRED and Shipvine Logistics shipped the parcel via USPS First Class Mail International.
  4. The estimated final cost of the shipment. This value may be adjusted in a later billing cycle for exceptional circumstances.
  5. Some Shipvine Logistics merchants pay for USPS postage directly. In such cases, Shipvine has no need to bill the merchant for the shipping cost because the merchant already paid for the postage. If this value is false, then the merchant can expect to see this shipping charge on its next bill.
  6. The <Lines /> element describes exactly which items were shipped in the outbound shipment. For retail orders, there is usually only one outbound shipment, so all of the items in the original fulfillment request are repeated here. Larger orders may be split into multiple boxes, however, and would generate multiple outbound shipments. A merchant could inspect this element to determine which items a customer should expect to receive in which box.
    • Related Articles

    • Logistics API: Inbound Shipments

      Resource #1 https://api.warehousefs.com/public/v1/inbound-shipments/{merchantCode} This version of the inbound shipments resource allows the merchant to query for a listing of inbound shipments that may have been recently completed. GET Request URL ...
    • 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 ...
    • Logistics API: Overview

      Shipvine provides a simple, free, open, public API that allows software developers to write custom integration solutions. (Before you go down this road, though, we recommend checking to see if we've already built an integration for your platform!) ...
    • Logistics API: Item Groups

      Resource https://api.warehousefs.com/public/v1/item-groups/{merchantCode}/{merchantIdentifier} The item groups resource allows the merchant to programmatically enter catalog information into the Shipvine Logistics system. In Shipvine's vocabulary, an ...
    • Logistics API: Tracked Returns

      Resource https://api.warehousefs.com/public/v1/tracked-returns/{merchantCode}/{merchantIdentifier} The tracked returns resource allows the merchant to provide advance notification about returns that are being mailed to Shipvine. POST Request URL ...