Type Alias OrderSummary

OrderSummary: {
    _links?: {
        order_items?: HateoasLink;
        self?: HateoasLink;
        shipments?: HateoasLink;
    };
    costs?: Costs;
    created_at?: string;
    external_id?: string | null;
    id?: number;
    order_items?: (CatalogItemSummary | WarehouseItemSummary)[];
    recipient?: Address;
    retail_costs?: RetailCosts;
    shipping?: string;
    status?: string;
    store_id?: number;
    updated_at?: string;
}

Order summary

Type declaration

  • Optional_links?: {
        order_items?: HateoasLink;
        self?: HateoasLink;
        shipments?: HateoasLink;
    }

    HATEOAS links

    • Optionalorder_items?: HateoasLink

      Link to all order items associated with the order

    • Optionalself?: HateoasLink

      Link to the order details

    • Optionalshipments?: HateoasLink

      Link to the shipments associated with the order

  • Optionalcosts?: Costs
  • Optionalcreated_at?: string

    Time when the order was created

  • Optionalexternal_id?: string | null

    Order ID from the external system

  • Optionalid?: number

    Order ID

  • Optionalorder_items?: (CatalogItemSummary | WarehouseItemSummary)[]

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

  • Optionalrecipient?: Address

    The recipient data.

  • Optionalretail_costs?: RetailCosts
  • Optionalshipping?: string

    Shipping method. Defaults to 'STANDARD'

  • Optionalstatus?: 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

  • Optionalstore_id?: number

    Store ID

  • Optionalupdated_at?: string

    Time when the order was updated

Settings

Member Visibility