Skip to main content
GET
/
store
/
orders
/
{id}
JS SDK
import Medusa from "@medusajs/js-sdk"

let MEDUSA_BACKEND_URL = "http://localhost:9000"

if (process.env.NEXT_PUBLIC_MEDUSA_BACKEND_URL) {
  MEDUSA_BACKEND_URL = process.env.NEXT_PUBLIC_MEDUSA_BACKEND_URL
}

export const sdk = new Medusa({
  baseUrl: MEDUSA_BACKEND_URL,
  debug: process.env.NODE_ENV === "development",
  publishableKey: process.env.NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY,
})

sdk.store.order.retrieve("order_123")
.then(({ order }) => {
  console.log(order)
})
{
  "order": {
    "id": "<string>",
    "region_id": "<string>",
    "customer_id": "<string>",
    "sales_channel_id": "<string>",
    "email": "jsmith@example.com",
    "currency_code": "usd",
    "display_id": 123,
    "shipping_address": {
      "id": "<string>",
      "customer_id": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "phone": "<string>",
      "company": "<string>",
      "address_1": "<string>",
      "address_2": "<string>",
      "city": "<string>",
      "country_code": "us",
      "country": {
        "id": "<string>",
        "iso_2": "us",
        "iso_3": "usa",
        "num_code": 840,
        "name": "<string>",
        "display_name": "<string>"
      },
      "province": "us-ca",
      "postal_code": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "billing_address": {
      "id": "<string>",
      "customer_id": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "phone": "<string>",
      "company": "<string>",
      "address_1": "<string>",
      "address_2": "<string>",
      "city": "<string>",
      "country_code": "us",
      "country": {
        "id": "<string>",
        "iso_2": "us",
        "iso_3": "usa",
        "num_code": 840,
        "name": "<string>",
        "display_name": "<string>"
      },
      "province": "us-ca",
      "postal_code": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "items": [
      {
        "id": "<string>",
        "title": "<string>",
        "subtitle": "<string>",
        "thumbnail": "<string>",
        "variant": {
          "options": [
            {
              "id": "<any>",
              "value": "<any>",
              "option": "<any>",
              "option_id": "<any>",
              "metadata": "<any>",
              "created_at": "<any>",
              "updated_at": "<any>",
              "deleted_at": "<any>"
            }
          ],
          "product": {},
          "length": 123,
          "title": "<string>",
          "metadata": {},
          "id": "<string>",
          "width": 123,
          "weight": 123,
          "height": 123,
          "origin_country": "<string>",
          "hs_code": "<string>",
          "mid_code": "<string>",
          "material": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z",
          "product_id": "<string>",
          "sku": "<string>",
          "barcode": "<string>",
          "ean": "<string>",
          "upc": "<string>",
          "allow_backorder": true,
          "manage_inventory": true,
          "inventory_quantity": 123,
          "variant_rank": 123,
          "calculated_price": {
            "id": "<string>",
            "is_calculated_price_price_list": true,
            "is_calculated_price_tax_inclusive": true,
            "calculated_amount": 123,
            "calculated_amount_with_tax": 123,
            "calculated_amount_without_tax": 123,
            "is_original_price_price_list": true,
            "is_original_price_tax_inclusive": true,
            "original_amount": 123,
            "currency_code": "usd",
            "calculated_price": {},
            "original_price": {},
            "original_amount_with_tax": 123,
            "original_amount_without_tax": 123
          }
        },
        "variant_id": "<string>",
        "product": {
          "categories": [
            {}
          ],
          "type": {
            "id": "<string>",
            "metadata": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z",
            "value": "<string>"
          },
          "length": 123,
          "title": "<string>",
          "status": "draft",
          "options": [
            {
              "id": "<string>",
              "title": "<string>",
              "product": {},
              "product_id": "<string>",
              "values": [
                {
                  "id": "<any>",
                  "value": "<any>",
                  "option": "<any>",
                  "option_id": "<any>",
                  "metadata": "<any>",
                  "created_at": "<any>",
                  "updated_at": "<any>",
                  "deleted_at": "<any>"
                }
              ],
              "metadata": {},
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "deleted_at": "2023-11-07T05:31:56Z"
            }
          ],
          "description": "<string>",
          "id": "<string>",
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "variants": [
            {
              "options": [
                {
                  "id": "<any>",
                  "value": "<any>",
                  "option": "<any>",
                  "option_id": "<any>",
                  "metadata": "<any>",
                  "created_at": "<any>",
                  "updated_at": "<any>",
                  "deleted_at": "<any>"
                }
              ],
              "product": {},
              "length": 123,
              "title": "<string>",
              "metadata": {},
              "id": "<string>",
              "width": 123,
              "weight": 123,
              "height": 123,
              "origin_country": "<string>",
              "hs_code": "<string>",
              "mid_code": "<string>",
              "material": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "deleted_at": "2023-11-07T05:31:56Z",
              "product_id": "<string>",
              "sku": "<string>",
              "barcode": "<string>",
              "ean": "<string>",
              "upc": "<string>",
              "allow_backorder": true,
              "manage_inventory": true,
              "inventory_quantity": 123,
              "variant_rank": 123,
              "calculated_price": {
                "id": "<string>",
                "is_calculated_price_price_list": true,
                "is_calculated_price_tax_inclusive": true,
                "calculated_amount": 123,
                "calculated_amount_with_tax": 123,
                "calculated_amount_without_tax": 123,
                "is_original_price_price_list": true,
                "is_original_price_tax_inclusive": true,
                "original_amount": 123,
                "currency_code": "usd",
                "calculated_price": {},
                "original_price": {},
                "original_amount_with_tax": 123,
                "original_amount_without_tax": 123
              }
            }
          ],
          "handle": "<string>",
          "subtitle": "<string>",
          "is_giftcard": true,
          "thumbnail": "<string>",
          "width": 123,
          "weight": 123,
          "height": 123,
          "origin_country": "<string>",
          "hs_code": "<string>",
          "mid_code": "<string>",
          "material": "<string>",
          "collection": {
            "id": "<string>",
            "title": "<string>",
            "handle": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z",
            "products": [
              {}
            ],
            "metadata": {}
          },
          "collection_id": "<string>",
          "type_id": "<string>",
          "tags": [
            {
              "id": "<string>",
              "value": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "deleted_at": "2023-11-07T05:31:56Z",
              "metadata": {}
            }
          ],
          "images": [
            {
              "id": "<string>",
              "url": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "deleted_at": "2023-11-07T05:31:56Z",
              "metadata": {},
              "rank": 123
            }
          ],
          "discountable": true,
          "external_id": "<string>",
          "deleted_at": "2023-11-07T05:31:56Z"
        },
        "product_id": "<string>",
        "product_title": "<string>",
        "product_description": "<string>",
        "product_subtitle": "<string>",
        "product_type": "<string>",
        "product_collection": "<string>",
        "product_handle": "<string>",
        "variant_sku": "<string>",
        "variant_barcode": "<string>",
        "variant_title": "<string>",
        "variant_option_values": {
          "Color": "Blue"
        },
        "requires_shipping": true,
        "is_discountable": true,
        "is_tax_inclusive": true,
        "compare_at_unit_price": 123,
        "unit_price": 123,
        "quantity": 123,
        "tax_lines": [
          {
            "item": {
              "id": "<string>",
              "title": "<string>",
              "subtitle": "<string>",
              "thumbnail": "<string>",
              "variant": {
                "id": "<string>",
                "title": "<string>",
                "sku": "<string>",
                "barcode": "<string>",
                "ean": "<string>",
                "upc": "<string>",
                "allow_backorder": true,
                "manage_inventory": true,
                "inventory_quantity": 123,
                "hs_code": "<string>",
                "origin_country": "<string>",
                "mid_code": "<string>",
                "material": "<string>",
                "weight": 123,
                "length": 123,
                "height": 123,
                "width": 123,
                "variant_rank": 123,
                "options": [
                  {}
                ],
                "product": {},
                "product_id": "<string>",
                "calculated_price": {},
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z",
                "metadata": {}
              },
              "variant_id": "<string>",
              "product": {
                "id": "<string>",
                "title": "<string>",
                "handle": "<string>",
                "subtitle": "<string>",
                "description": "<string>",
                "is_giftcard": true,
                "status": "draft",
                "thumbnail": "<string>",
                "width": 123,
                "weight": 123,
                "length": 123,
                "height": 123,
                "origin_country": "<string>",
                "hs_code": "<string>",
                "mid_code": "<string>",
                "material": "<string>",
                "collection": {},
                "collection_id": "<string>",
                "categories": [
                  {}
                ],
                "type": {},
                "type_id": "<string>",
                "tags": [
                  {}
                ],
                "variants": [
                  {}
                ],
                "options": [
                  {}
                ],
                "images": [
                  {}
                ],
                "discountable": true,
                "external_id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z",
                "metadata": {}
              },
              "product_id": "<string>",
              "product_title": "<string>",
              "product_description": "<string>",
              "product_subtitle": "<string>",
              "product_type": "<string>",
              "product_collection": "<string>",
              "product_handle": "<string>",
              "variant_sku": "<string>",
              "variant_barcode": "<string>",
              "variant_title": "<string>",
              "variant_option_values": {},
              "requires_shipping": true,
              "is_discountable": true,
              "is_tax_inclusive": true,
              "compare_at_unit_price": 123,
              "unit_price": 123,
              "quantity": 123,
              "tax_lines": [
                {
                  "item": {},
                  "item_id": "<string>",
                  "total": 123,
                  "subtotal": 123,
                  "id": "<string>",
                  "description": "<string>",
                  "tax_rate_id": "<string>",
                  "code": "<string>",
                  "rate": 123,
                  "provider_id": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "updated_at": "2023-11-07T05:31:56Z"
                }
              ],
              "adjustments": [
                {
                  "item": {},
                  "item_id": "<string>",
                  "id": "<string>",
                  "code": "<string>",
                  "amount": 123,
                  "order_id": "<string>",
                  "description": "<string>",
                  "promotion_id": "<string>",
                  "provider_id": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "updated_at": "2023-11-07T05:31:56Z"
                }
              ],
              "detail": {
                "id": "<string>",
                "item_id": "<string>",
                "item": {},
                "quantity": 123,
                "fulfilled_quantity": 123,
                "delivered_quantity": 123,
                "shipped_quantity": 123,
                "return_requested_quantity": 123,
                "return_received_quantity": 123,
                "return_dismissed_quantity": 123,
                "written_off_quantity": 123,
                "metadata": {},
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z"
              },
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "metadata": {},
              "original_total": 123,
              "original_subtotal": 123,
              "original_tax_total": 123,
              "item_total": 123,
              "item_subtotal": 123,
              "item_tax_total": 123,
              "total": 123,
              "subtotal": 123,
              "tax_total": 123,
              "discount_total": 123,
              "discount_tax_total": 123,
              "refundable_total": 123,
              "refundable_total_per_unit": 123
            },
            "item_id": "<string>",
            "total": 123,
            "subtotal": 123,
            "id": "<string>",
            "description": "<string>",
            "tax_rate_id": "<string>",
            "code": "<string>",
            "rate": 123,
            "provider_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ],
        "adjustments": [
          {
            "item": {
              "id": "<string>",
              "title": "<string>",
              "subtitle": "<string>",
              "thumbnail": "<string>",
              "variant": {
                "id": "<string>",
                "title": "<string>",
                "sku": "<string>",
                "barcode": "<string>",
                "ean": "<string>",
                "upc": "<string>",
                "allow_backorder": true,
                "manage_inventory": true,
                "inventory_quantity": 123,
                "hs_code": "<string>",
                "origin_country": "<string>",
                "mid_code": "<string>",
                "material": "<string>",
                "weight": 123,
                "length": 123,
                "height": 123,
                "width": 123,
                "variant_rank": 123,
                "options": [
                  {}
                ],
                "product": {},
                "product_id": "<string>",
                "calculated_price": {},
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z",
                "metadata": {}
              },
              "variant_id": "<string>",
              "product": {
                "id": "<string>",
                "title": "<string>",
                "handle": "<string>",
                "subtitle": "<string>",
                "description": "<string>",
                "is_giftcard": true,
                "status": "draft",
                "thumbnail": "<string>",
                "width": 123,
                "weight": 123,
                "length": 123,
                "height": 123,
                "origin_country": "<string>",
                "hs_code": "<string>",
                "mid_code": "<string>",
                "material": "<string>",
                "collection": {},
                "collection_id": "<string>",
                "categories": [
                  {}
                ],
                "type": {},
                "type_id": "<string>",
                "tags": [
                  {}
                ],
                "variants": [
                  {}
                ],
                "options": [
                  {}
                ],
                "images": [
                  {}
                ],
                "discountable": true,
                "external_id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z",
                "deleted_at": "2023-11-07T05:31:56Z",
                "metadata": {}
              },
              "product_id": "<string>",
              "product_title": "<string>",
              "product_description": "<string>",
              "product_subtitle": "<string>",
              "product_type": "<string>",
              "product_collection": "<string>",
              "product_handle": "<string>",
              "variant_sku": "<string>",
              "variant_barcode": "<string>",
              "variant_title": "<string>",
              "variant_option_values": {},
              "requires_shipping": true,
              "is_discountable": true,
              "is_tax_inclusive": true,
              "compare_at_unit_price": 123,
              "unit_price": 123,
              "quantity": 123,
              "tax_lines": [
                {
                  "item": {},
                  "item_id": "<string>",
                  "total": 123,
                  "subtotal": 123,
                  "id": "<string>",
                  "description": "<string>",
                  "tax_rate_id": "<string>",
                  "code": "<string>",
                  "rate": 123,
                  "provider_id": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "updated_at": "2023-11-07T05:31:56Z"
                }
              ],
              "adjustments": [
                {
                  "item": {},
                  "item_id": "<string>",
                  "id": "<string>",
                  "code": "<string>",
                  "amount": 123,
                  "order_id": "<string>",
                  "description": "<string>",
                  "promotion_id": "<string>",
                  "provider_id": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "updated_at": "2023-11-07T05:31:56Z"
                }
              ],
              "detail": {
                "id": "<string>",
                "item_id": "<string>",
                "item": {},
                "quantity": 123,
                "fulfilled_quantity": 123,
                "delivered_quantity": 123,
                "shipped_quantity": 123,
                "return_requested_quantity": 123,
                "return_received_quantity": 123,
                "return_dismissed_quantity": 123,
                "written_off_quantity": 123,
                "metadata": {},
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z"
              },
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "metadata": {},
              "original_total": 123,
              "original_subtotal": 123,
              "original_tax_total": 123,
              "item_total": 123,
              "item_subtotal": 123,
              "item_tax_total": 123,
              "total": 123,
              "subtotal": 123,
              "tax_total": 123,
              "discount_total": 123,
              "discount_tax_total": 123,
              "refundable_total": 123,
              "refundable_total_per_unit": 123
            },
            "item_id": "<string>",
            "id": "<string>",
            "code": "<string>",
            "amount": 123,
            "order_id": "<string>",
            "description": "<string>",
            "promotion_id": "<string>",
            "provider_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ],
        "detail": {
          "id": "<string>",
          "item_id": "<string>",
          "item": {
            "variant": {
              "options": [
                {}
              ],
              "product": {},
              "length": 123,
              "title": "<string>",
              "id": "<string>",
              "metadata": {},
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "product_id": "<string>",
              "width": 123,
              "weight": 123,
              "height": 123,
              "origin_country": "<string>",
              "hs_code": "<string>",
              "mid_code": "<string>",
              "material": "<string>",
              "deleted_at": "2023-11-07T05:31:56Z",
              "sku": "<string>",
              "barcode": "<string>",
              "ean": "<string>",
              "upc": "<string>",
              "allow_backorder": true,
              "manage_inventory": true,
              "inventory_quantity": 123,
              "variant_rank": 123,
              "calculated_price": {}
            },
            "product": {
              "collection": {},
              "categories": [
                {}
              ],
              "variants": [
                {}
              ],
              "type": {},
              "tags": [
                {}
              ],
              "options": [
                {}
              ],
              "images": [
                {}
              ],
              "length": 123,
              "title": "<string>",
              "status": "draft",
              "description": "<string>",
              "id": "<string>",
              "metadata": {},
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "subtitle": "<string>",
              "thumbnail": "<string>",
              "handle": "<string>",
              "is_giftcard": true,
              "width": 123,
              "weight": 123,
              "height": 123,
              "origin_country": "<string>",
              "hs_code": "<string>",
              "mid_code": "<string>",
              "material": "<string>",
              "collection_id": "<string>",
              "type_id": "<string>",
              "discountable": true,
              "external_id": "<string>",
              "deleted_at": "2023-11-07T05:31:56Z"
            },
            "tax_lines": [
              {
                "item": {},
                "item_id": "<string>",
                "total": 123,
                "subtotal": 123,
                "id": "<string>",
                "description": "<string>",
                "tax_rate_id": "<string>",
                "code": "<string>",
                "rate": 123,
                "provider_id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z"
              }
            ],
            "adjustments": [
              {
                "item": {},
                "item_id": "<string>",
                "id": "<string>",
                "code": "<string>",
                "amount": 123,
                "order_id": "<string>",
                "description": "<string>",
                "promotion_id": "<string>",
                "provider_id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z"
              }
            ],
            "detail": {
              "id": "<string>",
              "item_id": "<string>",
              "item": {},
              "quantity": 123,
              "fulfilled_quantity": 123,
              "delivered_quantity": 123,
              "shipped_quantity": 123,
              "return_requested_quantity": 123,
              "return_received_quantity": 123,
              "return_dismissed_quantity": 123,
              "written_off_quantity": 123,
              "metadata": {},
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "title": "<string>",
            "id": "<string>",
            "metadata": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "item_total": 123,
            "item_subtotal": 123,
            "item_tax_total": 123,
            "original_total": 123,
            "original_subtotal": 123,
            "original_tax_total": 123,
            "total": 123,
            "subtotal": 123,
            "tax_total": 123,
            "discount_total": 123,
            "discount_tax_total": 123,
            "subtitle": "<string>",
            "thumbnail": "<string>",
            "variant_id": "<string>",
            "product_id": "<string>",
            "product_title": "<string>",
            "product_description": "<string>",
            "product_subtitle": "<string>",
            "product_type": "<string>",
            "product_collection": "<string>",
            "product_handle": "<string>",
            "variant_sku": "<string>",
            "variant_barcode": "<string>",
            "variant_title": "<string>",
            "variant_option_values": {},
            "requires_shipping": true,
            "is_discountable": true,
            "is_tax_inclusive": true,
            "compare_at_unit_price": 123,
            "unit_price": 123,
            "quantity": 123,
            "refundable_total": 123,
            "refundable_total_per_unit": 123
          },
          "quantity": 123,
          "fulfilled_quantity": 123,
          "delivered_quantity": 123,
          "shipped_quantity": 123,
          "return_requested_quantity": 123,
          "return_received_quantity": 123,
          "return_dismissed_quantity": 123,
          "written_off_quantity": 123,
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        },
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "metadata": {},
        "original_total": 123,
        "original_subtotal": 123,
        "original_tax_total": 123,
        "item_total": 123,
        "item_subtotal": 123,
        "item_tax_total": 123,
        "total": 123,
        "subtotal": 123,
        "tax_total": 123,
        "discount_total": 123,
        "discount_tax_total": 123,
        "refundable_total": 123,
        "refundable_total_per_unit": 123,
        "product_type_id": "<string>"
      }
    ],
    "shipping_methods": [
      {
        "id": "<string>",
        "order_id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "amount": 123,
        "is_tax_inclusive": true,
        "shipping_option_id": "<string>",
        "data": {},
        "metadata": {},
        "tax_lines": [
          {
            "shipping_method": {
              "id": "<string>",
              "order_id": "<string>",
              "name": "<string>",
              "description": "<string>",
              "amount": 123,
              "is_tax_inclusive": true,
              "shipping_option_id": "<string>",
              "data": {},
              "metadata": {},
              "tax_lines": [
                {
                  "shipping_method": {},
                  "shipping_method_id": "<string>",
                  "total": 123,
                  "subtotal": 123,
                  "id": "<string>",
                  "description": "<string>",
                  "tax_rate_id": "<string>",
                  "code": "<string>",
                  "rate": 123,
                  "provider_id": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "updated_at": "2023-11-07T05:31:56Z"
                }
              ],
              "adjustments": [
                {
                  "shipping_method": {},
                  "shipping_method_id": "<string>",
                  "id": "<string>",
                  "code": "<string>",
                  "amount": 123,
                  "order_id": "<string>",
                  "description": "<string>",
                  "promotion_id": "<string>",
                  "provider_id": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "updated_at": "2023-11-07T05:31:56Z"
                }
              ],
              "original_total": 123,
              "original_subtotal": 123,
              "original_tax_total": 123,
              "total": 123,
              "detail": {
                "id": "<string>",
                "shipping_method_id": "<string>",
                "shipping_method": {},
                "claim_id": "<string>",
                "exchange_id": "<string>",
                "return_id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z"
              },
              "subtotal": 123,
              "tax_total": 123,
              "discount_total": 123,
              "discount_tax_total": 123,
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "shipping_method_id": "<string>",
            "total": 123,
            "subtotal": 123,
            "id": "<string>",
            "description": "<string>",
            "tax_rate_id": "<string>",
            "code": "<string>",
            "rate": 123,
            "provider_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ],
        "adjustments": [
          {
            "shipping_method": {
              "id": "<string>",
              "order_id": "<string>",
              "name": "<string>",
              "description": "<string>",
              "amount": 123,
              "is_tax_inclusive": true,
              "shipping_option_id": "<string>",
              "data": {},
              "metadata": {},
              "tax_lines": [
                {
                  "shipping_method": {},
                  "shipping_method_id": "<string>",
                  "total": 123,
                  "subtotal": 123,
                  "id": "<string>",
                  "description": "<string>",
                  "tax_rate_id": "<string>",
                  "code": "<string>",
                  "rate": 123,
                  "provider_id": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "updated_at": "2023-11-07T05:31:56Z"
                }
              ],
              "adjustments": [
                {
                  "shipping_method": {},
                  "shipping_method_id": "<string>",
                  "id": "<string>",
                  "code": "<string>",
                  "amount": 123,
                  "order_id": "<string>",
                  "description": "<string>",
                  "promotion_id": "<string>",
                  "provider_id": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "updated_at": "2023-11-07T05:31:56Z"
                }
              ],
              "original_total": 123,
              "original_subtotal": 123,
              "original_tax_total": 123,
              "total": 123,
              "detail": {
                "id": "<string>",
                "shipping_method_id": "<string>",
                "shipping_method": {},
                "claim_id": "<string>",
                "exchange_id": "<string>",
                "return_id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z"
              },
              "subtotal": 123,
              "tax_total": 123,
              "discount_total": 123,
              "discount_tax_total": 123,
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "shipping_method_id": "<string>",
            "id": "<string>",
            "code": "<string>",
            "amount": 123,
            "order_id": "<string>",
            "description": "<string>",
            "promotion_id": "<string>",
            "provider_id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ],
        "original_total": 123,
        "original_subtotal": 123,
        "original_tax_total": 123,
        "total": 123,
        "subtotal": 123,
        "tax_total": 123,
        "discount_total": 123,
        "discount_tax_total": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "detail": {
          "id": "<string>",
          "shipping_method_id": "<string>",
          "shipping_method": {
            "tax_lines": [
              {
                "shipping_method": {},
                "shipping_method_id": "<string>",
                "total": 123,
                "subtotal": 123,
                "id": "<string>",
                "description": "<string>",
                "tax_rate_id": "<string>",
                "code": "<string>",
                "rate": 123,
                "provider_id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z"
              }
            ],
            "adjustments": [
              {
                "shipping_method": {},
                "shipping_method_id": "<string>",
                "id": "<string>",
                "code": "<string>",
                "amount": 123,
                "order_id": "<string>",
                "description": "<string>",
                "promotion_id": "<string>",
                "provider_id": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "updated_at": "2023-11-07T05:31:56Z"
              }
            ],
            "detail": {
              "id": "<string>",
              "shipping_method_id": "<string>",
              "shipping_method": {},
              "claim_id": "<string>",
              "exchange_id": "<string>",
              "return_id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z"
            },
            "id": "<string>",
            "order_id": "<string>",
            "name": "<string>",
            "description": "<string>",
            "amount": 123,
            "is_tax_inclusive": true,
            "shipping_option_id": "<string>",
            "data": {},
            "metadata": {},
            "original_total": 123,
            "original_subtotal": 123,
            "original_tax_total": 123,
            "total": 123,
            "subtotal": 123,
            "tax_total": 123,
            "discount_total": 123,
            "discount_tax_total": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          },
          "claim_id": "<string>",
          "exchange_id": "<string>",
          "return_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      }
    ],
    "payment_collections": [
      {
        "id": "<string>",
        "currency_code": "<string>",
        "amount": 123,
        "authorized_amount": 123,
        "captured_amount": 123,
        "refunded_amount": 123,
        "completed_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "metadata": {},
        "status": "canceled",
        "payment_providers": [
          {
            "id": "<string>"
          }
        ],
        "payment_sessions": [
          {
            "id": "<string>",
            "amount": 123,
            "currency_code": "usd",
            "provider_id": "<string>",
            "data": {},
            "context": {
              "customer": {
                "id": "cus_123"
              }
            },
            "status": "authorized",
            "authorized_at": "2023-11-07T05:31:56Z",
            "payment_collection": {},
            "payment": {
              "id": "<string>",
              "amount": 123,
              "authorized_amount": 123,
              "currency_code": "<string>",
              "provider_id": "<string>",
              "data": {},
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "captured_at": "2023-11-07T05:31:56Z",
              "canceled_at": "2023-11-07T05:31:56Z",
              "captured_amount": 123,
              "refunded_amount": 123,
              "captures": [
                {
                  "id": "<string>",
                  "amount": 123,
                  "created_at": "2023-11-07T05:31:56Z",
                  "created_by": "<string>",
                  "payment": {}
                }
              ],
              "refunds": [
                {
                  "id": "<string>",
                  "amount": 123,
                  "refund_reason_id": "<string>",
                  "note": "<string>",
                  "created_at": "2023-11-07T05:31:56Z",
                  "created_by": "<string>",
                  "payment": {},
                  "refund_reason": {}
                }
              ],
              "payment_collection": {},
              "payment_session": {}
            }
          }
        ],
        "payments": [
          {
            "id": "<string>",
            "amount": 123,
            "authorized_amount": 123,
            "currency_code": "<string>",
            "provider_id": "<string>",
            "data": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "captured_at": "2023-11-07T05:31:56Z",
            "canceled_at": "2023-11-07T05:31:56Z",
            "captured_amount": 123,
            "refunded_amount": 123,
            "captures": [
              {
                "id": "<string>",
                "amount": 123,
                "created_at": "2023-11-07T05:31:56Z",
                "created_by": "<string>",
                "payment": {}
              }
            ],
            "refunds": [
              {
                "id": "<string>",
                "amount": 123,
                "refund_reason_id": "<string>",
                "note": "<string>",
                "created_at": "2023-11-07T05:31:56Z",
                "created_by": "<string>",
                "payment": {},
                "refund_reason": {}
              }
            ],
            "payment_collection": {},
            "payment_session": {}
          }
        ]
      }
    ],
    "payment_status": "canceled",
    "fulfillments": [
      {
        "id": "<string>",
        "location_id": "<string>",
        "packed_at": "2023-11-07T05:31:56Z",
        "shipped_at": "2023-11-07T05:31:56Z",
        "delivered_at": "2023-11-07T05:31:56Z",
        "canceled_at": "2023-11-07T05:31:56Z",
        "data": {},
        "provider_id": "<string>",
        "shipping_option_id": "<string>",
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "requires_shipping": true
      }
    ],
    "fulfillment_status": "canceled",
    "summary": {
      "paid_total": 123,
      "refunded_total": 123,
      "pending_difference": 123,
      "current_order_total": 123,
      "original_order_total": 123,
      "transaction_total": 123,
      "accounting_total": 123
    },
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "original_item_total": 123,
    "original_item_subtotal": 123,
    "original_item_tax_total": 123,
    "item_total": 123,
    "item_subtotal": 123,
    "item_tax_total": 123,
    "original_total": 123,
    "original_subtotal": 123,
    "original_tax_total": 123,
    "total": 123,
    "subtotal": 123,
    "tax_total": 123,
    "discount_total": 123,
    "discount_tax_total": 123,
    "gift_card_total": 123,
    "gift_card_tax_total": 123,
    "shipping_total": 123,
    "shipping_subtotal": 123,
    "shipping_tax_total": 123,
    "original_shipping_total": 123,
    "original_shipping_subtotal": 123,
    "original_shipping_tax_total": 123,
    "customer": {
      "id": "<string>",
      "email": "jsmith@example.com",
      "default_billing_address_id": "<string>",
      "default_shipping_address_id": "<string>",
      "company_name": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "addresses": [
        {
          "id": "<string>",
          "address_name": "<string>",
          "is_default_shipping": true,
          "is_default_billing": true,
          "customer_id": "<string>",
          "company": "<string>",
          "first_name": "<string>",
          "last_name": "<string>",
          "address_1": "<string>",
          "address_2": "<string>",
          "city": "<string>",
          "country_code": "usd",
          "province": "us-ca",
          "postal_code": "<string>",
          "phone": "<string>",
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "phone": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    },
    "transactions": [
      {
        "id": "<string>",
        "order_id": "<string>",
        "amount": 123,
        "currency_code": "usd",
        "reference": "capture",
        "reference_id": "<string>",
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "status": "<string>",
    "credit_line_total": 123
  }
}

Headers

​
x-publishable-api-key
string
required

Publishable API Key created in the Medusa Admin.

Path Parameters

​
id
string
required

The order's ID.

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

Response

OK

The order's details.

​
order
object
required

The order's details.