API Reference

The supplier shipment object

Attributes

id

The id of the supplier shipment. This is different from order ids.

create_date

UTC timestamp when the shipment was created in ISO format.

carrier

The shipping carrier to be used

incoterm

Specifies who is responsible for paying for and managing the shipment, insurance and customs clearance etc.

number

The unique number of the supplier shipment in Fulfil. This is different from order number.

reference

Optional field that may contain the BOL, container number, or additional information on the specific inbound shipment

supplier

The supplier shipping the item

 "supplier": {
     "name": "Bruce Wayne"
 }

planned_date

The date on which the shipment is expected to be received.

{
  "carrier_code": "ups"
}

service_code

The shipping service to be used

{
  "service_code": "ground"
}

tracking_number

Tracking number/BOL for the supplier shipment

write_date

UTC timestamp when the record was last updated. Could be null (if not updated)

transportation_mode

Ground/Parcel, Ocean or Air

Line Item Attributes

"lines": [
              {
                "id": 123456,
                "product": {
                    "id": 1234,
                    "code": "SKU",
                    "upc": 123456789012,
                    "name": "Apple iPad",
                    "hs_code": "1234.56"
                },
                "quantity": 1,
                "unit": "u",
                "order_line": {
                    "id": 123,
                    "unit_price": {
                        "__class__": "Decimal",
                        "decimal": "1.23"
                    }
                },
                "order": {
                    "id": 1234,
                    "number": "SO12345",
                    "reference": "PO89897",
                    "currency": "USD"
                }
          }
     ]

id

The id of the line item (stock move)

product.id

ID of the product. This is required to mark shipment as done.

product.code

SKU of the product

product.upc (optional)

UPC of the product

product.name

Variant name of the product

quantity

The quantity to ship. This could be a floating point if the UOM is weight, length or volume

uom

The unit of measure

Purchase order attributes

"purchase_orders": [
                {
                    "description": null,
                    "id": 805,
                    "number": "PO675",
                    "purchase_date": {
                        "__class__": "date",
                        "iso_string": "2021-06-30"
                    },
                    "reference": null
                }
            ]

purchase_orders.id

The id of the purchase order where this shipment line was created

purchase_orders.description

Description on purchase order

purchase_orders.number

The number of the purchase order where this shipment line was created

purchase_orders.purchase_date

The date when the purchase order was made in Fulfil

purchase_orders.reference

The reference of the order where this shipment line was created. Reference is usually a remote channel order number or customer PO number. This is an optional value

ASN acknowledgements

Inbound shipments could change between the first time the PO was accepted and the time of shipment. This is quite normal for shipments with long lead times (eg. China) where the contents and quantity may be changed by the merchant while waiting for items to be on the boat.

So, we recommend refreshing the ASNs periodically (every day) to both look for new ASNs and to see if there are updates to existing ASNs.