Schema Information ShipMonk
This subtopic provides a structured reference to assist you in working with Daton's ShipMonk connector and the associated fields and tables.
Schema Information ShipMonk
This subtopic provides a structured reference to assist you in working with Daton's ShipMonk connector and the associated fields and tables.
Tables/APIs
The following is the list of tables or APIs associated with the ShipMonk connector:
- Products
- Order List
- Return List
- Receivings List
- Warehouses
Products
This table contains information related to products in the ShipMonk platform. Each record corresponds to a unique product and contains various attributes such as SKU, name, inventory quantities (including on-hand, available, and quarantined across warehouses), physical details (weight, dimensions), HS codes, barcodes, and related metadata like product bundles, handling units, lot tracking, and stock-out projections
Source API: Retrieve List of Products
Schema: ShipMonkSchema
Order List
This table contains information related to orders in the ShipMonk platform. Each record corresponds to a unique order and contains various attributes such as order key, order number, associated store details, order timestamps, customer email, shipping from and to addresses, status indicators (order and processing), currency code, line items (with SKU, name, quantity, price, fulfillment details, etc.), required actions flags, package and tracking information, requested and actual shipping methods, shipment details, order size, serial numbers, gift and note fields, and order detail URL.
Source API: Retrieve List of Orders
Schema: ShipMonkSchema
Note: When no filters are applied, the List Orders endpoint returns up to the first 1,000,000 orders according to the specified sorting. If filters are applied, the endpoint returns a maximum of 10,000 orders.
Note: The ShipMonk Support Team has suggested an alternate solution to retrieve the latest order details using a webhook approach until the planned enhancement for Order List API endpoint is released in the upcoming quarter. In the meantime, you can use the “Webhook” connector in the Daton Portal to extract the most recent order and shipment details without any limitations.
Webhooks
Return List
This table contains information related to returns in the ShipMonk platform. Each record corresponds to a unique return and contains various attributes such as id, warehouse, order key, store id, RMA, tracking number, status, return reason, note, creation timestamp, update timestamp, receipt timestamp, items (with receiving details including scoped id, type, final disposition, lot information like lot number and expiration date, expected and received quantities, receipt timestamp, etc.; desired action; product details like id, SKU, name; expected and received quantities), custom data, and source.
Source API: Retrieve List of Returns
Schema: ShipMonkSchema
Receivings List
This table contains information related to receivings in the ShipMonk platform. Each record corresponds to a unique receiving and contains various attributes such as id, warehouse, receiving_key, asn, bol_number, supplier_name, handling_unit_type, handling_unit_quantity, estimated_delivery, description, status, created_at, updated_at, arrived_at, received_at, items (with receiving_details including line_key, lot with lot_number and expiration_date, expected_quantity, received_quantity, received_at; product with id, sku, name; expected_quantity, received_quantity), receiving_lines (with line_key, product with id, sku, name, expected_quantity, received_quantity, lot with lot_number and expiration_date), and custom_data.
Source API: Retrieve List of Receivings
Schema: ShipMonkSchema
Warehouses
This table contains information related to warehouses in the ShipMonk platform. Each record corresponds to a unique warehouse and contains various attributes such as id, identifier, name, timezone, warehouse_wms_type, enabled, address (with name, company, street1, street2, street3, city, state, postal_code, phone, residential, verified, country), created_at, and updated_at.
Source API: Retrieve List of Warehouses
Schema: ShipMonkSchema