Logistics API: Fulfillment Request Submission

Logistics API: Fulfillment Request Submission

Resource

https://api.warehousefs.com/public/v1/fulfillment-request-submissions

The fulfillment request submission resource allows merchants to send their orders to Shipvine Logistics. These submissions are queued up as API Submissions. Every few seconds, the system picks up an API Submission and attempts to validate it, running through a series of checks (such as cleansing the shipping address or verifying the units are in stock). If the request is not valid, then it is saved as a Candidate Request with a detailed description of what's wrong. The merchant can correct the errors directly within the Shipvine Logistics Web site. If the request is valid, then it is saved as a Fulfillment Request, which means it's in the queue to be picked, packed, and shipped.

POST

Request

Query Parameters

The POST verb on this resource does not accept any query parameters.

Entity Body

The entity body of the request should be the FulfillmentRequestSubmission element as defined in the XML schema. See the XML schema for element-specific documentation.

Example Entity Body

<?xml version="1.0"?>
<FulfillmentRequestSubmission xmlns="urn:WarehouseFS-1.0"> <!-- (1) -->
  <MerchantCode>CONTOSO</MerchantCode>
  <MerchantIdentifier>100000011</MerchantIdentifier>
  <Currency>USD</Currency>
  <EmailAddress>john.doe@example.com</EmailAddress>
  <Address type="Shipping">
    <Country>FR</Country>
    <PersonalName>
      <First>John</First>
      <Last>Doe</Last>
    </PersonalName>
    <StreetLines>
      <StreetLine>161 rue Fromage</StreetLine>
    </StreetLines>
    <CityOrTown>Paris</CityOrTown>
    <StateOrProvince /> <!-- (2) -->
    <PostalCode>31500</PostalCode>
    <Phone>+330561339336</Phone> <!-- (3) -->
  </Address>
  <Lines> <!-- (4) -->
    <Line>
      <Item>
        <MerchantIdentifier>6161115-Black-Small</MerchantIdentifier>
      </Item>
      <Quantity>1</Quantity> <!-- (5) -->
      <UnitPrice>
        <Amount>19.50</Amount> <!-- (6) -->
        <Currency>USD</Currency>
      </UnitPrice>
    </Line>
  </Lines>
  <ShippingMethod>INTL-DEFERRED</ShippingMethod>
  <Discount>
    <Amount>0.00</Amount>
    <Currency>USD</Currency>
  </Discount>
  <Tax>
    <Amount>0.00</Amount>
    <Currency>USD</Currency>
  </Tax>
  <Shipping>
    <Amount>5.78</Amount>
    <Currency>USD</Currency>
  </Shipping>
</FulfillmentRequestSubmission>
  1. Don't forget the namespace declaration. The Shipvine Logistics API server will reject the request if the namespace is not provided.
  2. For international addresses, not all parts of the <Address /> element will be used. However, the elements themselves are still required to be in the request; just pass an empty element or an empty string value if they do not apply.
  3. A phone number is required. Shipvine Logistics attempts to be lenient in the formatting requirements for phone numbers, however. The canonical format is E.164 format, such as "+18044333127" for Shipvine's phone number; however, variations including "(804) 433-3127" will be accepted.
  4. You repeat the <Line /> element for each unit item in the fulfillment request submission.
  5. The quantity must be greater than zero. If you're unable to ship something to a customer, don't tell Shipvine Logistics about it; just leave it out.
  6. This value is printed on the customer's receipt. It may also be used to determine the Shipvine Logistics fee for processing the fulfillment request. Because the value may be used in international customs paperwork, it's important to provide an accurate value here, even if only a packing slip is requested. Intentionally providing inaccurate values is grounds for termination of your Shipvine Logistics account.

Response

If the fulfillment request submission is successfully received, then Shipvine Logistics will respond with 200 OK and an empty 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.

    • 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 ...
    • What does the "Fulfillment Requests Queued Limit" metric on the Shipvine Logistics dashboard mean?

      The Shipvine Terms and Conditions state that the same-day shipping guarantee for low-volume fulfillment requests (orders) submitted by noon Eastern is suspended if you send us more than 4 times your daily average order volume. If you send more than ...
    • What is an API submission?

      When an integration like Shipvine Sync pulls an order from an e-commerce platform like Shopify, or when you integrate directly with the Shipvine Logistics API, it's saved in Shipvine Logistics as an API submission. It's queued up for validation, and ...
    • What is a fulfillment request?

      The main object of interest in the Shipvine Logistics system is the fulfillment request. The reason we use this term instead of something like "sales order" is because we encourage you to not treat our system as an order management system; instead, ...
    • 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!) ...