Type Alias Order

Type declaration

• _links: {
      order_confirmation: HateoasLink;
      order_invoices: HateoasLink;
      order_items: HateoasLink;
      self: HateoasLink;
      shipments: HateoasLink;
  }

  HATEOAS links

  • order_confirmation: HateoasLink

    Link to the order confirmation

  • order_invoices: HateoasLink

    Link to the order invoice

  • order_items: HateoasLink

    Link to all order items associated with the order

  • self: HateoasLink

    Link to the order details

  • shipments: HateoasLink

    Link to the shipments associated with the order

• costs: Costs

• created_at: string

  Time when the order was created

• Optionalcustomization?: CustomizationReadonly

• external_id: string | null

  Order ID from the external system

• id: number

  Order ID

• order_items: (CatalogItemSummary | WarehouseItemSummary)[]

  Simplified order item list. For a full list of all items use the Get Order Items endpoint.

• recipient: AddressReadonly

  The recipient data.

• retail_costs: RetailCosts

• shipping: string

  Shipping method. Defaults to 'STANDARD'

• status: string

  Order status:
  draft - order is not submitted for fulfillment
  failed - order was submitted for fulfillment but was not accepted because of an error (problem with address, printfiles, charging, etc.)
  pending - order has been submitted for fulfillment
  canceled - order is canceled
  onhold - order has encountered a problem during the fulfillment that needs to be resolved together with the Printful customer service
  inprocess - order is being fulfilled and is no longer cancellable
  partial - order is partially fulfilled (some items are shipped already, the rest will follow)
  fulfilled - all items are shipped

• store_id: number

  Store ID

• updated_at: string

  Time when the order was updated