title: Shipping Profile
description: >-
  A Shipping Profile has a set of defined Shipping Options that can be used to
  fulfill a given set of Products. For example, gift cards are shipped
  differently than physical products, so a shipping profile with the type
  `gift_card` groups together the shipping options that can only be used for
  gift cards.
type: object
required:
  - created_at
  - deleted_at
  - id
  - metadata
  - name
  - type
  - updated_at
properties:
  id:
    description: The shipping profile's ID
    type: string
    example: sp_01G1G5V239ENSZ5MV4JAR737BM
  name:
    description: >-
      The name given to the Shipping profile - this may be displayed to the
      Customer.
    type: string
    example: Default Shipping Profile
  type:
    description: >-
      The type of the Shipping Profile, may be `default`, `gift_card` or
      `custom`.
    type: string
    enum:
      - default
      - gift_card
      - custom
    example: default
  products:
    description: >-
      The details of the products that the Shipping Profile defines Shipping
      Options for. Available if the relation `products` is expanded.
    type: array
    x-expandable: products
    items:
      type: object
  shipping_options:
    description: >-
      The details of the shipping options that can be used to create shipping
      methods for the Products in the Shipping Profile.
    type: array
    x-expandable: shipping_options
    items:
      type: object
  created_at:
    description: The date with timezone at which the resource was created.
    type: string
    format: date-time
  updated_at:
    description: The date with timezone at which the resource was updated.
    type: string
    format: date-time
  deleted_at:
    description: The date with timezone at which the resource was deleted.
    nullable: true
    type: string
    format: date-time
  metadata:
    description: An optional key-value map with additional details
    nullable: true
    type: object
    example:
      car: white
    externalDocs:
      description: Learn about the metadata attribute, and how to delete and update it.
      url: >-
        https://docs.medusajs.com/development/entities/overview#metadata-attribute