WMS API - Vendor Integration
Flaviar Inc.
API Specification
URL
Data Format
By default, all the data as part of request and response will be received and sent in Json format.
Security
The API will be secured over HTTPS protocol.
Authentication
Users have to pass the auth token, provided by Flaviar, in the request header to access all the other protected resources.
headers: [
TOKEN: "<vendors_token>",
]
Limit
Be nice. If you're sending too many requests too quickly, we'll send back a 429 error code (TooManyRequests). You are limited to 200 reqs / minute, per account.
Response
General API response statuses are managed with standard HTTP response codes with additional data in the response body.
Response codes:
200 OK - successful call
400 Bad request - malformed request or payload / processing error
401 Unauthorized - the request is unauthorized (invalid token)
404 Not found - the requested entity does not exist
429 Too many requests
Standard error response format - HTTP status code: 400
{
errors: [
{
status: "400",
detail: "Error message"
code: "12"
}
]
}
Processing steps
Here are suggested processing steps that you should consider in this API flow:
retrieveShipments method: overview/preview of currently assigned parcels (to decide whether to accept or reject assigned shipments)
getShipment method: get detailed information of a specific parcel that will be used to create an order in the destination ERP/POS
acceptShipment method: acceptance confirmation (parcel has been pulled into the ERP/POS). Note: you should always call first 'getShipment' before acceptShipment, to check if parcel is still ‘assigned’ status
once parcel is accepted, the parcel status in WMS is changed into 'processing'. Important: in this stage Flaviar could still cancel the parcel OR change a shipping address
shipShipment method: confirming that parcel has been sent, by providing the shipping information (tracking number, carrier...etc.).
Shipping information must be submitted before carrier pick up!
Important: before confirming shipping information, you must first call either:getShipment endpoint, to check whether the single parcel is still ‘processing’ status, OR
getCancelledShipments endpoint (when you’re working with big batches of orders), that provides you the list of all cancelled parcels, from the date you need to provide as an input parameter
API Method Details
Retrieve shipments
Method: GET /api/vendor/retrieveShipments
Description:
Retrieve all new shipments that are assigned to the Vendor. A packing slip in PDF format is reachable on the URL below for each shipment - Packing slip URL: https://wms.flaviar.com/api/utils/generatePDF.php?token=[Vendor’sToken]&shipment_id=[WMS shipment ID]
Optional POST parameters (JSON):
offset: INT (start row from)
limit: INT (size of a resultset; max 500 at one request)
Response:
Success (200):
{
shipments: [
{
id: “<WMS shipment id>”,
status: “<assigned | processing | sent | failed | returned | deleted>”,
timestamp_created: “<datetime: YYYY-MM-DD HH:mm:ss>”,
total: “<Vendor’s earning, in local Currency>”,
currency: “<Order’s currency>”,
internal_notes: “<Flaviar comments / message to Vendor>”,
gift_message: “<Message for the recipient>”,
billing_name: “<Message for the recipient>”,
shop: “<Shop name, where the order came from>”,
customer: {
id: “<internal customer ID>”,
billing_address: {
name: “<name and surname of the receiver>”,
company: “<name of company receiving the shipment>”,
address1: “<length 50>”,
address2: “”,
zip: “<destination ZIP code>”,
city: “<destination city>”,
county: “<destination county>”,
county_iso: “<destination county ISO>”,
state: “<state abbreviation of destination>”,
country: “<destination country ISO>”,
phone: “<phone number of the receiver>”,
},
shipping_address: {
... same as ‘billing_address’
},
},
items: {
[
sku: “<Vendor’s SKU>”,
upc: “<Vendor’s UPC>”,
product_id: “<WMS product ID>”,
title: “<name of the product>”,
qty: “<ordered quantity>”,
unitPrice: “<Vendor’s price per unit, in USD>”,
options: {
[
name: “<volume / abv / engraving_text>”,
value: “<ie: 750ml>”
],
...,
}
],
...,
},
shipping_data: {
provider: “<BOXCHECK | WSE | ...etc.>”,
carrier: “<NULL/empty | FEDEX | UPS | ...etc.>”,
service: “<TWO_DAY | NEXT_DAY | ...etc.>”,
},
},
]
}
Fieldset:
id INT
status VARCHAR
timestamp_created DATETIME
total DECIMAL,2
currency VARCHAR
internal_notes VARCHAR
gift_message VARCHAR
billing_name VARCHAR
shop VARCHAR
customer ARRAY
customer->id INT
customer->billing_address ARRAY
customer->shipping_address ARRAY
name VARCHAR
company VARCHAR
address1 VARCHAR
address2 VARCHAR
zip VARCHAR
city VARCHAR
county VARCHAR
county_iso VARCHAR
state VARCHAR
country VARCHAR
phone VARCHAR
items ARRAY
sku VARCHAR
upc VARCHAR
product_id INT
title VARCHAR
qty INT
unitPrice DECIMAL,2
options ARRAY volume | abv | engraving_text (key => value)
shipping_data ARRAY
provider VARCHAR
carrier VARCHAR
service VARCHAR
Accept / Confirm Shipments
Method: POST /api/vendor/acceptShipments
Description:
From the retrieved shipments list Vendor needs to confirm acceptance by providing WMS shipment ID and Vendor’s reference (string). WMS will respond with a list of successfully accepted shipments. Accepted shipments go into the ‘processing’ status within WMS.
Request:
{
shipments: [
{
id: “<WMS Shipment ID>”,
reference_id: “<Vendor’s shipment/reference>”
},
...
]
}
Response:
Success (200):
{
shipments: [
{
reference_id: “<Vendor’s shipment/reference> [VARCHAR]”
},
...
]
}
Fieldset:
id INT Required
reference_id VARCHAR Required Vendor’s internal identifier (can be same as id)
Cancel Shipments
Method: POST /api/vendor/cancelShipments
Description:
Shipment cancellation process for provided shipment IDs. Only shipments which haven’t been reported yet can be canceled. WMS will respond with a list of shipments which have been cancelled successfully. Canceled shipments go into the ‘failed’ status within WMS.
If the shipment cancellation reason is Out-Of-Stock, Vendor has to send an array of shipment product IDs, which aren’t in stock anymore, otherwise ‘oos_products’ attribute can be empty.
Request:
{
shipments: [
{
id: “<WMS Shipment ID>”,
reference_id: “<Vendor’s shipment/reference>”,
comments: “<Vendor’s comments / reason for cancelation>”,
oos_products: { // OPTIONAL array
[
<WMS product IDs from the shipment, if products aren’t in stock anymore>
],
}
},
...
]
}
Response:
Success (200):
{
shipments: [
{
reference_id: “<Vendor’s shipment/reference>”
},
...
]
}
Fieldset:
id INT Required
reference_id VARCHAR Required
comments VARCHAR Required
oos_products ARRAY Optional Array of WMS product IDs
Ship Shipments
Method: POST /api/vendor/shipShipments
Description:
Shipment fulfillment process for provided shipment IDs. Only shipments which haven’t been shipped yet can be processed as ‘shipped’. WMS will respond with a list of shipments which have been shipped successfully. Provided shipments go into the ‘sent’ status within WMS.
In this step Vendor has to send a few required data: carrier, tracking number and shipping cost.
Request:
{
shipments: [
{
id: “<WMS Shipment ID>”,
reference_id: “<Vendor’s shipment/reference>”,
carrier: “<Fedex / Ups / UsPS / DHL / Gso ...etc. >”,
tracking_number: “<carrier’s tracking number / barcode>”,
shipping_cost: “<carrier’s shipping cost>”,
weight: “<shipment weight in LBS>”,
invoice_no: “<Vendor’s Invoice reference>”,
},
...
]
}
Response:
Success (200):
{
shipments: [
{
reference_id: “<Vendor’s shipment/reference>”
},
...
]
}
Fieldset:
id INT Required
reference_id VARCHAR Required
carrier VARCHAR Required
tracking_number VARCHAR Required
shipping_cost DECIMAL,2 Required
weight DECIMAL,2 Optional
invoice_no VARCHAR Optional
Return Shipments
Method: POST /api/vendor/returnShipments
Description:
Shipment return process process for provided shipment IDs. Only for shipments which have already been processed as ‘shipped’ and being reported (Vendor’s financial report). WMS will respond with a list of shipments for which the return process has been successfully completed..
In this step Vendor have to send few required data on which it will define what kind of return want to execute:
BOTTLE_CLEAR_ALL: reset all costs to Flaviar (items + shipping)
BOTTLE_HALF: split shipping costs to both parties (Flaviar : Vendor)
BOTTLE_DOUBLE: double shipping costs to Flaviar
BOX_CLEAR_ALL (for tasting box only): reset all costs to Flaviar (items + shipping)
BOX_RETURN (for tasting box only): reset item costs for Flaviar, double shipping costs to Flaviar, add extra $1 to Vendor due to packaging service, put items back on Vendor’s stock
BOX_DAMAGE (for tasting box only): reset shipping costs to Flaviar
REVERT: shipment will be reverted back to the ‘processing’ step (only if it’s not reported yet)
Provided shipments goes into the ‘returned’ status within WMS.
Request:
{
shipments: [
{
id: “<WMS Shipment ID>”,
reference_id: “<Vendor’s shipment/reference>”,
costs_calculation: “<bottle_clear_all | bottle_half | bottle_double...etc.>”,
comments: “<Vendor’s comments / reason for return>”
},
...
]
}
Response:
Success (200):
{
shipments: [
{
reference_id: “<Vendor’s shipment/reference>”
},
...
]
}
Fieldset:
id INT Required
reference_id VARCHAR Required
costs_calculation VARCHAR Required
comments VARCHAR Optional
Get shipment, by ID
Method: GET /api/vendor/getShipment/[WMS_shipment_ID]
Description:
Retrieve a particular shipment by WMS shipment ID, including the invoice manifest.
Response:
Success (200):
{
shipments: [
{
id: “<WMS shipment id>”,
reference_id: “<Vendor’s shipment/reference>”,
status: “<assigned | processing | sent | failed | returned | deleted>”,
timestamp_created: “<datetime: YYYY-MM-DD HH:mm:ss>”,
timestamp_sent: “<datetime: YYYY-MM-DD HH:mm:ss>”,
timestamp_returned: “<datetime: YYYY-MM-DD HH:mm:ss>”,
timestamp_reported: “<datetime: YYYY-MM-DD HH:mm:ss>”,
carrier: “<shipment carrier>”,
tracking_number: “”,
invoice_no: “<Vendor’s internal invoice reference>”,
total: “<Vendor’s ITEMS earning, in local currency>”,
currency: “<Order’s currency>”,
shipping_costs: “<Vendor’s Costs for shipping, in local currency>”,
internal_notes: “<Flaviar comments / message to Vendor>”,
gift_message: “<Message for the recipient>”,
billing_name: “<Message for the recipient>”,
shop: “<Shop name, where the order came from>”,
customer: {
id: “<internal customer ID>”,
billing_address: {
name: “<name and surname of the receiver>”,
company: “<name of company receiving the shipment>”,
address1: “<length 50>”,
address2: “<length 50>”,
full_address: “<full length>”,
zip: “<destination ZIP code>”,
city: “<destination city>”,
county: “<destination county>”,
county_iso: “<destination county_iso>”,
state: “<state abbreviation of destination>”,
country: “<destination country>”,
phone: “<phone number of the receiver>”,
},
shipping_address: {
... same as ‘billing_address’
},
},
items: {
[
sku: “<Vendor’s SKU>”,
upc: “<Vendor’s UPC>”,
product_id: “<WMS product ID>”,
title: “<name of the product>”,
qty: “<ordered quantity>”,
unitPrice: “<Vendor’s price per unit, in USD>”,
options: {
[
name: “<volume / abv / engraving_text>”,
value: “<ie: 750ml>”
],
...,
}
],
...,
shipping_data: {
provider: “<BOXCHECK | WSE | ...etc.>”,
carrier: “<NULL/empty | FEDEX | UPS | ...etc.>”,
service: “<TWO_DAY | NEXT_DAY | ...etc.>”,
},
invoice: {
pdf_url: “<WMS URL to the pdf file>”,
data: {
shipment_id: “<WMS shipment id>”,
date_sent: “<date: YYYY-MM-DD>”,
shipping_address: {
name: “<name and surname of the receiver>”,
company: “<name of company receiving the shipment>”,
address1: “<length 50>”,
address2: “<length 50>”,
full_address: “<full length>”,
zip: “<destination ZIP code>”,
city: “<destination city>”,
county: “<destination county>”,
county_iso: “<destination county_iso>”,
state: “<state abbreviation of destination>”,
country: “<destination country>”,
phone: “<phone number of the receiver>”,
},
items: {
[
sku: “<Vendor’s SKU>”,
upc: “<Vendor’s UPC>”,
product_id: “<WMS product ID>”,
title: “<name of the product>”,
price_net: “<NET price for unit (before discount)>”,
price_gross: “<GROSS price for unit (before discount)>”,
discount_percentage: “”,
discount_value: “discount value for one unit”,
tax_rate: “<tax rate in percentage>”,
qty: “<ordered quantity>”,
total_net: “<NET total incl. discount>”,
total_gross: “<GROSS total incl. discount>”
],
...,
},
subtotal_net: “<NET subtotal incl. discount>”,
shipping_net: “<Shipping NET value>”,
shipping_tax_value: “<Shipping Tax value>”,
shipping_gross: “<Shipping GROSS value, paid by Customer>”,
tax_rate: “<Shipment’s tax rate in percentage>”,
tax_value: “<Shipment’s overall tax value (items + shipping)>”,
grand_total: “<Incl.tax>”,
currency: “”
},
},
},
]
}
Fieldset:
id INT
status VARCHAR
timestamp_created DATETIME
timestamp_sent DATETIME
timestamp_returned DATETIME
timestamp_reported DATETIME
carrier VARCHAR
tracking_number VARCHAR
invoice_no VARCHAR
total DECIMAL,2
currency VARCHAR
shipping_costs DECIMAL,2
internal_notes VARCHAR
gift_message VARCHAR
billing_name VARCHAR
shop VARCHAR
customer ARRAY
customer->id INT
customer->billing_address ARRAY
customer->shipping_address ARRAY
name VARCHAR
company VARCHAR
address1 VARCHAR
address2 VARCHAR
zip VARCHAR
city VARCHAR
county VARCHAR
county_iso VARCHAR
state VARCHAR
country VARCHAR
phone VARCHAR
items ARRAY
sku VARCHAR
upc VARCHAR
product_id INT
title VARCHAR
qty INT
unitPrice DECIMAL,2
options ARRAY volume | abv | engraving_text (key => value)
shipping_data ARRAY
provider VARCHAR
carrier VARCHAR
service VARCHAR
invoice ARRAY
invoice->pdf_url VARCHAR
invoice->data ARRAY
shipment_id INT
date_sent DATE
shipping_address ARRAY (see customer->shipping_addres)
items ARRAY
sku VARCHAR
upc VARCHAR
product_id INT
title VARCHAR
price_net DECIMAL,2
price_gross DECIMAL,2
discount_percentage DECIMAL,2
discount_value DECIMAL,2
tax_rate DECIMAL,2
qty INT
total_net DECIMAL,2
total_gross DECIMAL,2
subtotal_net DECIMAL,2
shipping_net DECIMAL,2
shipping_tax_value DECIMAL,2
shipping_gross DECIMAL,2
tax_rate DECIMAL,2
tax_value DECIMAL,2
grand_total DECIMAL,2
currency VARCHAR
Update Tracking Number
Method: POST /api/vendor/updateTrackingNumber
Description:
Update tracking number and optionally carrier for provided shipments. Only shipments which have been shipped (have status ‘sent’) but not yet delivered can be processed. WMS will respond with a list of shipments which have been updated successfully. A shipment’s carrier status is set to ‘shipped’ (as default initial status) if the carrier is changed.
Required data: id, carrier, tracking_number
Optional data: carrier_status (ignored if carrier changes)
Request:
{
shipments: [
{
id: <WMS Shipment ID>,
reference_id: <Vendor’s shipment/reference>,
tracking_number: “<new tracking number / barcode>”,
carrier: “<Fedex / Ups / UsPS / DHL / Gso ...etc.>”,
carrier_status: “<carrier’s initial tracking status>”,
}
]
}
Response:
Success (200):
{
shipments: [
{
id: <WMS Shipment ID>,
reference_id: “<Vendor’s shipment/reference>”
}
]
}
Fieldset:
id INT
tracking_number VARCHAR
carrier VARCHAR
carrier_status VARCHAR
Retrieve Canceled shipments
Method: GET /api/vendor/getCancelledShipments
Description:
Retrieve a list of all cancelled shipments (status ‘failed’ OR ‘deleted’) that have been assigned to the Vendor. Status FAILED means the Vendor has cancelled the shipment, status DELETED means the Flaviar’s CX team has cancelled the shipment. The list is ordered by timestamp_created DESC
Optional POST parameters (JSON):
date_from: DATE (filter the list by date cancelled FROM the specific date)
offset: INT (start row from)
limit: INT (size of a resultset; max 500 at one request)
Response:
Success (200):
{
shipments: [
{
id: “<WMS shipment id>”,
status: “<assigned | processing | sent | failed | returned | deleted>”,
timestamp_created: “<datetime: YYYY-MM-DD HH:mm:ss>”,
timestamp_cancelled: “<datetime: YYYY-MM-DD HH:mm:ss>”,
total: “<Vendor’s earning, in local Currency>”,
currency: “<Order’s currency>”,
internal_notes: “<Flaviar comments / message to Vendor>”,
gift_message: “<Message for the recipient>”,
billing_name: “<Message for the recipient>”,
shop: “<Shop name, where the order came from>”,
customer: {
id: “<internal customer ID>”,
billing_address: {
name: “<name and surname of the receiver>”,
company: “<name of company receiving the shipment>”,
address1: “<length 50>”,
address2: “”,
zip: “<destination ZIP code>”,
city: “<destination city>”,
county: “<destination county>”,
county_iso: “<destination county_iso>”,
state: “<state abbreviation of destination>”,
country: “<destination country>”,
phone: “<phone number of the receiver>”,
},
shipping_address: {
... same as ‘billing_address’
},
},
items: {
[
sku: “<Vendor’s SKU>”,
upc: “<Vendor’s UPC>”,
product_id: “<WMS product ID>”,
title: “<name of the product>”,
qty: “<ordered quantity>”,
unitPrice: “<Vendor’s price per unit, in USD>”,
options: {
[
name: “<volume / abv / engraving_text>”,
value: “<ie: 750ml>”
],
...,
}
],
...,
},
},
]
}
Fieldset:
id INT
status VARCHAR
timestamp_created DATETIME
timestamp_cancelled DATETIME
total DECIMAL,2
currency VARCHAR
internal_notes VARCHAR
gift_message VARCHAR
billing_name VARCHAR
shop VARCHAR
customer ARRAY
customer->id INT
customer->billing_address ARRAY
customer->shipping_address ARRAY
name VARCHAR
company VARCHAR
address1 VARCHAR
address2 VARCHAR
zip VARCHAR
city VARCHAR
county VARCHAR
county_iso VARCHAR
state VARCHAR
country VARCHAR
phone VARCHAR
items ARRAY
sku VARCHAR
upc VARCHAR
product_id INT
title VARCHAR
qty INT
unitPrice DECIMAL,2
options ARRAY volume | abv | engraving_text (key => value)
Retrieve Sent shipments
Method: GET /api/vendor/getSentShipments
Description:
Retrieve a list of all sent shipments (status ‘sent’) that have been assigned to the Vendor. The list is ordered by timestamp_sent DESC
Optional POST parameters (JSON):
date_from: DATE (filter the list by date sent FROM the specific date)
offset: INT (start row from)
limit: INT (size of a resultset; max 500 at one request)
Response:
Success (200):
{
shipments: [
{
id: “<WMS shipment id>”,
status: “sent”,
timestamp_created: “<datetime: YYYY-MM-DD HH:mm:ss>”,
timestamp_cancelled: “<datetime: YYYY-MM-DD HH:mm:ss>”,
total: “<Vendor’s earning, in USD>”,
internal_notes: “<Flaviar comments / message to Vendor>”,
gift_message: “<Message for the recipient>”,
billing_name: “<Message for the recipient>”,
shop: “<Shop name, where the order came from>”,
customer: {
id: “<internal customer ID>”,
billing_address: {
name: “<name and surname of the receiver>”,
company: “<name of company receiving the shipment>”,
address1: “<length 50>”,
address2: “”,
zip: “<destination ZIP code>”,
city: “<destination city>”,
county: “<destination county>”,
county_iso: “<destination county_iso>”,
state: “<state abbreviation of destination>”,
country: “<destination country>”,
phone: “<phone number of the receiver>”,
},
shipping_address: {
... same as ‘billing_address’
},
},
items: {
[
sku: “<Vendor’s SKU>”,
upc: “<Vendor’s UPC>”,
product_id: “<WMS product ID>”,
title: “<name of the product>”,
qty: “<ordered quantity>”,
unitPrice: “<Vendor’s price per unit, in USD>”,
options: {
[
name: “<volume / abv / engraving_text>”,
value: “<ie: 750ml>”
],
...,
}
],
...,
},
},
]
}
Fieldset:
id INT
status VARCHAR
timestamp_created DATETIME
timestamp_cancelled DATETIME
total DECIMAL,2
internal_notes VARCHAR
gift_message VARCHAR
billing_name VARCHAR
shop VARCHAR
customer ARRAY
customer->id INT
customer->billing_address ARRAY
customer->shipping_address ARRAY
name VARCHAR
company VARCHAR
address1 VARCHAR
address2 VARCHAR
zip VARCHAR
city VARCHAR
county VARCHAR
county_iso VARCHAR
state VARCHAR
country VARCHAR
phone VARCHAR
items ARRAY
sku VARCHAR
upc VARCHAR
product_id INT
title VARCHAR
qty INT
unitPrice DECIMAL,2
options ARRAY volume | abv | engraving_text (key => value)
Retrieve Stripe Payouts
Method: GET /api/vendor/getStripePayouts
Description:
Retrieve a list of recent payouts that have been made by Stripe. Default response is a list of last 10 payouts, but endpoint allows you to paginate further by using ‘next_page’ parameter (sending a query param ‘?from=[payout_id]’)
Examples:
/api/vendor/getStripePayouts
/api/vendor/getStripePayouts?from=po_xxxxxxxxxxx
Response:
Success (200):
{
data: [
{
id: “<Stripe Payout/PO ID>”,
description: “<Stripe PO Description>”,
date_arrival: “<date format: YYYY-MM-DD>”,
amount: “<Stripe PO Amount - decimal>”,
currency: “<Stripe PO Currency (USD, EUR, GBP..)>”,
status: “<Stripe PO Status (paid, pending, in_transit, canceled, failed)>”,
},
...
]
}
Fieldset:
id VARCHAR
description VARCHAR
date_arrival DATETIME
amount DECIMAL,2
currency VARCHAR
status VARCHAR
Retrieve Stripe Reconciliation Report
Method: GET /api/vendor/getStripeReconciliationReport/[stripe_payout_id]
Description:
This endpoint doesn’t return an actual Stripe Reconciliation Report but it triggers a request for report generation, based on a requested Stripe Payout ID, which could take some time. Once a report is generated, it’ll be sent to your webhook URL.
Webhook URL and token (or other credentials) must be provided to Flaviar Team
Response:
Success (200):
{
success: 1,
file_id: “<Stripe Reconciliation Report File ID>”,
}
Fieldset:
success INT
file_id VARCHAR
Webhook Payload (JSON):
Payload is JSON formatted and contains default fields defined by Stripe.
It can also be customized that will fit your needs and your accounting system in case of direct integration.
{
data: [
{
automatic_payout_id: “<Stripe Payout/PO ID>”,
charge_created_utc: “<Stripe Charge timestamp: YYYY-MM-DD HH:MM:SS>”,
gross: “<Stripe Charge GROSS Amount>”,
net: “<Stripe Charge NET Amount>”,
fee: “<Stripe Processing Fee>”,
currency: “<Stripe Charge Currency (USD, EUR, GBP..)>”,
reporting_category: “charge”,
customer_facing_amount: “<Amount as seen by the Customer>”,
customer_facing_currency: “<Currency as seen by the Customer (USD, etc.)>”,
charge_id: “<Stripe Payment/PY ID>”,
},
...
]
}
Webhook Fieldset:
automatic_payout_id VARCHAR
charge_created_utc DATETIME
gross DECIMAL,2
net DECIMAL,2
fee DECIMAL,2
currency VARCHAR
reporting_category VARCHAR
customer_facing_amount DECIMAL,2
customer_facing_currency VARCHAR
charge_id VARCHAR
Mark shipments as ‘ready for pickup’
Method: POST /api/vendor/shipmentsReadyForPickup
Description:
This process handles the fulfillment of shipments designated for 'in-store pickup,' identified by their provided IDs. Only shipments that have not yet been marked as shipped can be transitioned to the ‘ready for pickup’ status. The WMS will return a list of shipments that have been successfully marked as 'ready for pickup.' During this process, the provided shipments will remain in the ‘processing’ status within the WMS, and a customer email notification will be automatically sent confirming the shipments are ready for pickup.
Request:
{
shipments: [
{
id: “<WMS Shipment ID>”,
reference_id: “<Vendor’s shipment/reference>”,
},
...
]
}
Response:
Success (200):
{
shipments: [
{
reference_id: “<Vendor’s shipment/reference>”
},
...
]
}
Fieldset:
id INT Required
reference_id VARCHAR Required
Mark shipments as ‘picked up’
Method: POST /api/vendor/shipmentsPickedUp
Description:
This process handles the fulfillment of shipments designated for 'in-store pickup,' identified by their provided IDs. Only shipments that have not yet been marked as shipped can be transitioned to the ‘picked up’ status. The WMS will return a list of shipments that have been successfully marked as 'picked up.' During this process, the provided shipments will transition to the ‘sent’ status within the WMS, and a customer email notification will be automatically sent confirming the shipments were delivered.
Request:
{
shipments: [
{
id: “<WMS Shipment ID>”,
reference_id: “<Vendor’s shipment/reference>”,
},
...
]
}
Response:
Success (200):
{
shipments: [
{
reference_id: “<Vendor’s shipment/reference>”
},
...
]
}
Fieldset:
id INT Required
reference_id VARCHAR Required
