Logistics API: Stored Value Manifests

Logistics API: Stored Value Manifests

Resource

https://api.warehousefs.com/public/v1/stored-value-manifests/{shipvineIdentifier}

The stored value manifests resource allows the merchant to view which values have been assigned by Shipvine to stored value cards such as gift cards or gift certificates.

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.

Example Request URL

https://api.warehousefs.com/public/v1/stored-value-manifests/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 <StoredValueManifest /> 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"?>
<StoredValueManifest xmlns="urn:WarehouseFS-1.0">
  <FulfillmentRequest>
    <MerchantIdentifier>Test</MerchantIdentifier>
    <WfsIdentifier>2-13-319-68634-558-5</WfsIdentifier>
  </FulfillmentRequest>
  <Lines> <!-- (1) -->
    <Line>
      <Item>
        <MerchantIdentifier>STANDARD GIFT CARD</MerchantIdentifier> <!-- (2) -->
      </Item>
      <Value>
        <Amount>25.0000</Amount> <!-- (3) -->
        <Currency>USD</Currency>
      </Value>
      <Code>GIFT79876LG</Code> <!-- (4) -->
    </Line>
    <Line>
      <Item>
        <MerchantIdentifier>STANDARD GIFT CARD</MerchantIdentifier>
      </Item>
      <Value>
        <Amount>25.0000</Amount>
        <Currency>USD</Currency>
      </Value>
      <Code>GIFT79877LG</Code>
    </Line>
    <Line>
      <Item>
        <MerchantIdentifier>STANDARD GIFT CARD</MerchantIdentifier>
      </Item>
      <Value>
        <Amount>50.0000</Amount>
        <Currency>USD</Currency>
      </Value>
      <Code>GIFT82454DF</Code>
    </Line>
  </Lines>
</StoredValueManifest>
  1. If the fulfillment request contains more than one gift card (either two separate lines of gift cards of separate values, or multiple quantities of a gift card of a single value), then you'll see multiple <Line /> elements in the response. For example, if the fulfillment request contains 2 x $50 gift card in one line and 1 x $100 gift card in another line, then the <StoredValueManifest /> will have three <Line /> elements in the response.
  2. If you offer different kinds of gift cards, such as a blue gift card and a green gift card, you can distinguish the kind of gift card with the merchant identifier field.
  3. The value assigned to the gift card, which corresponds to the <StoredValue /> element in the original API submission.
  4. The barcode that was scanned on the gift card.
    • Related Articles

    • 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 ...
    • 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 ...