--- title: "Show Session" method: GET path: "/sessions/{session_id}" tags: ["Sessions"] --- # Show Session `GET /sessions/{session_id}` ## Request - Base URL: `https://api.liftforward.com` - URL: `https://api.liftforward.com/sessions/{session_id}` - Auth: API key in header `Api-Key` Retrieve information about an existing Session. This feature is not supported for all programs. ## Path parameters - `session_id` string, required ## Response `200` success - SessionResponse: SessionResponse model - `session` MerchantApiEntitiesSessionAnonymousResponseEntity, required - `session_id` string: Unique identifier for this Session. - `status` string: Current status of the session (e.g., applying, checking_out, etc.) - `reservation_status` string: Current reservation status of the session (e.g., waiting, active, expired, etc.) - `credit_application_url` string: URL for the LiftForward hosted credit application. - `merchant_customer_id` string, required: Unique identifier for customer. Provided by the Merchant on create or generated by LiftForward. - `program_code` string, required: String provided by LiftForward to identify the Device as a Service Program. - `language` string: Preferred language for the customer experience. - `merchant_approval_url` string: URL on the merchant site the customer is redirected to after a customer's application is approved. - `merchant_decline_url` string: URL on the merchant site the customer is redirected to after a customer's application is declined. - `merchant_cancel_url` string: URL on the merchant site the customer is redirected to after a customer's cancels their application. - `merchant_pending_url` string: URL on the merchant site the customer is redirected to when a customer's application is pending. - `tracking_consents` MerchantApiEntitiesTrackingConsentEntity - `strictly_necessary` MerchantApiEntitiesTrackingConsentEntityConsentEntity - `granted` boolean, required: Whether consent has been granted. - `required` boolean: Whether consent is required. - `functional` MerchantApiEntitiesTrackingConsentEntityConsentEntity - `granted` boolean, required: Whether consent has been granted. - `required` boolean: Whether consent is required. - `performance_analytics` MerchantApiEntitiesTrackingConsentEntityConsentEntity - `granted` boolean, required: Whether consent has been granted. - `required` boolean: Whether consent is required. - `marketing_targeting` MerchantApiEntitiesTrackingConsentEntityConsentEntity - `granted` boolean, required: Whether consent has been granted. - `required` boolean: Whether consent is required. - `order` MerchantApiEntitiesSessionOrder - `merchant` MerchantApiEntitiesMerchantEntity - `source_channel_id` 'IN_STORE' | 'ONLINE_IN_STORE' | 'ONLINE_SHIP_TO_HOME': String identifying the sales channel the order originated from. ONLINE_SHIP_TO_HOME for typical ecommerce, ONLINE_IN_STORE for click and collect, IN_STORE for point of sale. - `store_id` string: String to identify merchant's store. - `employee_id` string: String to identify merchant's employee who assisted with sale. - `merchant_metadata` object: Arbitrary metadata for the session - `merchant_order_id` string: Unique identifier used by merchant for this order. Should be provided if possible. - `plan_code` string: String provided by LiftForward to identify the Device as a Service Plan. - `currency` string: ISO 4217 3 character currency code. - `shipping_fee` number, float: A flat shipping fee for the entire order, separate from individual item shipping fees - `shipping_address` MerchantApiEntitiesOrderAddress - `address_line_1` string, required: Street address - `address_line_2` string: Apt, Floor, Suite etc.. - `city` string, required: Address city. - `state_code` string, required: 2 letter US state code abbreviation. - `postal_code` string, required: Address zip code. Format NNNNN, NNNNNNNNN or NNNNN-NNNN in the US. - `country_code` string, required: 2 letter ISO-3166-1 country code. - `first_name` string, required: First name of customer. - `last_name` string, required: Last name of customer. - `merchant_items` MerchantApiEntitiesSessionOrderItemEntity[], required: Array of OrderItems describing the merchant items in this order. - `sku` string, required: Merchant defined SKU for this item. - `description` string: Short description or title of the product. - `merchant_order_item_id` string: Merchant provided identifier for this OrderItem. - `quantity` integer: Quantity of items purchased. Only available for some programs. Typically must be 1. - `unit_retail_price` number, float: Unit retail price for the item before any discount. Defaults to unit_sale_price. - `unit_sale_price` number, float: Unit price the item was sold for including any discount. - `unit_balloon_payment` number, float: Used with select device as a service programs. Amount of a balloon payment due at the end of upgrade period. - `unit_total_price` number, float: Total unit price for the item including any taxes and fees. - `shipping_fee` number, float: Shipping fee for this line item. - `sales_tax` number, float: Sales tax for this line item. - `sales_tax_rates` MerchantApiEntitiesSalesTaxRateEntity[]: Breakdown of sales tax rates for this line item. Only returned on plan_items. - `sales_tax_rate_code` 'VAT' | 'GST' | 'HST' | 'PST' | 'QST', required: The unique code for this sales tax rate - `rate` number, float, required: Tax rate in decimal - `amount` number, float, required: Tax amount in purchase currency - `misc_fees` number, float: Miscellaneous fees for this line item. - `apr` number, float: Annual Percentage Rate, expressed as a decimal, for this line item. - `installment_count` integer: Count of installments (aka payments) for this line item. - `unit_installment_payment` number, float: Amount of each payment customer will make per unit item. - `unit_total_interest` number, float: Total interest paid per unit item assuming all installments indicated by installment_count are made. - `parent_merchant_order_item_id` string: Merchant provided identifier for another OrderItem this order item belongs to. Typically used to link insurance products to their devices. - `image_url` string: Product image url. Should be using HTTPS always to avoid mixed content errors. - `description_list` string[]: Array of strings describing the product. Typically used the describe product features. - `approval` MerchantApiEntitiesApprovalEntity - `approval_token` string, required: Token which is used to create Orders and PaymentMethods. - `expires_at` string, required: When this approval will expire, in iso8601 format. - `status` string: The status of the approval. Possible values: [active, used, canceled, expired]. - `credit_amount` number, float: The amount of credit that has been approved. - `currency` string: The currency for credit_amount. - `order_id` string: Associated order id. - `payment_method_id` string: Associated payment method id. - `session_id` string: Associated Session id - `cart_id` string: Associated cart id - `offers` MerchantApiEntitiesOfferEntity[]: Array of Offers. - `offer_id` string: Unique id for offer. - `credit_amount` number, float: The credit limit for this offer. - `currency` string: ISO 4217 3 character currency code. - `apr` number, float: Annual Percentage Rate, expressed as a decimal, for this offer. - `installment_count` integer: Count of installments (aka payments) for this offer. ## Other responses - `400`: Invalid parameters - `401`: Unauthorized - `404`: Not Found - a session matching the provided parameters was not found - `405`: Not Allowed - `408`: Request Time Out - `500`: Internal Service Error - `503`: Service Unavailable --- [API](https://skmtc.dev/liftforward/apis/device-as-a-service-merchant-apis-lift-daas-service-producti.md) - [All operations](https://skmtc.dev/liftforward/apis/device-as-a-service-merchant-apis-lift-daas-service-producti/llms.txt) - [OpenAPI document](https://skmtc.dev/liftforward/apis/device-as-a-service-merchant-apis-lift-daas-service-producti/revisions/5a1383ffd271?raw)