/fulfillment

POST /fulfillment

Create a fulfillment for a fulfillment order.

Request:

• fulfillment

  • fulfillment_order_id (UUID) - The ID of the Fulfillment Order you are fulfilling

  • line_items - (array) optional - it left blank, all line items will be fulfilled

    • id (string) - The Purple Dot ID of the line item

    • quantity(number) - the quantity of that line item that are being fulfilled

  • notify_customer (boolean) - Whether the customer is notified. If true, then a notification is sent when the fulfillment is created. The default value is false

  • tracking_info

    • number (string) - The tracking number of the fulfillment

    • company (string) - The name of the tracking company

    • url (string) - The URL to track the fulfillment

Example payload:

{
  "fulfillment": {
    "fulfillment_order_id": "00000000-00000000-00000000-00000000",
    "line_items": [
      {
        "id": "00000000-00000000-00000000-00000000",
        "quantity": 5
      }
    ],
    "notify_customer": true,
    "tracking_info": {
      "number": "1234567890",
      "company": "UPS",
      "url": "https://www.myshipping.com/track/?tracknumbers=1234567890"
    }
  }
}