type: object
description: The filfillment's details.
x-schemaName: AdminCreateFulfillment
required:
  - data
  - order_id
  - metadata
  - items
  - location_id
  - provider_id
  - delivery_address
  - labels
properties:
  location_id:
    type: string
    title: location_id
    description: The ID of the location the items are fulfilled from.
  provider_id:
    type: string
    title: provider_id
    description: The ID of the provider handling this fulfillment.
  delivery_address:
    type: object
    description: The address to deliver the items to.
    properties:
      first_name:
        type: string
        title: first_name
        description: The customer's first name.
      last_name:
        type: string
        title: last_name
        description: The customer's last name.
      phone:
        type: string
        title: phone
        description: The customer's phone.
      company:
        type: string
        title: company
        description: The delivery address's company.
      address_1:
        type: string
        title: address_1
        description: The delivery address's first line.
      address_2:
        type: string
        title: address_2
        description: The delivery address's second line.
      city:
        type: string
        title: city
        description: The delivery address's city.
      country_code:
        type: string
        title: country_code
        description: The delivery address's country code.
      province:
        type: string
        title: province
        description: The delivery address's province.
      postal_code:
        type: string
        title: postal_code
        description: The delivery address's postal code.
      metadata:
        type: object
        description: The delivery address's metadata, used to store custom key-value pairs.
  items:
    type: array
    description: The items to fulfill.
    items:
      type: object
      description: An item to fulfill.
      required:
        - title
        - quantity
        - sku
        - barcode
      properties:
        title:
          type: string
          title: title
          description: The item's title.
        sku:
          type: string
          title: sku
          description: The item's SKU.
        quantity:
          type: number
          title: quantity
          description: The quantity to fulfill of the item.
        barcode:
          type: string
          title: barcode
          description: The item's barcode.
        line_item_id:
          type: string
          title: line_item_id
          description: The ID of the associated line item.
        inventory_item_id:
          type: string
          title: inventory_item_id
          description: The ID of the inventory item associated with the underlying variant.
  labels:
    type: array
    description: The labels for the fulfillment's shipments.
    items:
      type: object
      description: A shipment's label.
      required:
        - tracking_number
        - tracking_url
        - label_url
      properties:
        tracking_number:
          type: string
          title: tracking_number
          description: The label's tracking number.
        tracking_url:
          type: string
          title: tracking_url
          description: The label's tracking URL.
        label_url:
          type: string
          title: label_url
          description: The label's URL.
  order_id:
    type: string
    title: order_id
    description: The ID of the order this fulfillment is created for.
  shipping_option_id:
    type: string
    title: shipping_option_id
    description: The ID of the shipping option used in the order.
  data:
    type: object
    description: Any data useful for the fulfillment provider to handle the fulfillment.
    externalDocs:
      url: >-
        https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property
      description: Learn more about the data property.
  packed_at:
    type: string
    title: packed_at
    description: The date and time the fulfillment was packed.
    format: date-time
  shipped_at:
    type: string
    title: shipped_at
    description: The date and time the fulfillment was shipped.
    format: date-time
  delivered_at:
    type: string
    title: delivered_at
    description: The date and time the fulfillment was delivered.
    format: date-time
  canceled_at:
    type: string
    title: canceled_at
    description: The date and time the fulfillment was canceled.
    format: date-time
  metadata:
    type: object
    description: The fulfillment's metadata, used to store custom key-value pairs.