Skip to main content
POST
/
admin
/
orders
/
{id}
/
fulfillments
/
{fulfillment_id}
/
shipments
JS SDK
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.order.createShipment(
  "order_123",
  "ful_123",
  {
    items: [
      {
        id: "fulit_123",
        quantity: 1
      }
    ]
  }
)
.then(({ order }) => {
  console.log(order)
})
{ "order": { "payment_collections": [ { "id": "<string>", "currency_code": "<string>", "amount": 123, "status": "canceled", "payment_providers": [ { "id": "<string>", "is_enabled": true } ], "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": {}, "payment_sessions": [ { "id": "<string>", "amount": 123, "currency_code": "usd", "provider_id": "<string>", "data": {}, "status": "authorized", "context": { "customer": { "id": "cus_123" } }, "authorized_at": "2023-11-07T05:31:56Z", "payment_collection": {}, "payment": { "id": "<string>", "amount": 123, "currency_code": "<string>", "provider_id": "<string>", "authorized_amount": 123, "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", "payment": {}, "created_by": "<string>" } ], "refunds": [ { "id": "<string>", "amount": 123, "created_at": "2023-11-07T05:31:56Z", "payment": {}, "refund_reason_id": "<string>", "note": "<string>", "created_by": "<string>", "refund_reason": { "id": "<string>", "label": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "code": "<string>", "description": "<string>", "metadata": {} } } ], "payment_collection": {}, "payment_session": {} } } ], "payments": [ { "id": "<string>", "amount": 123, "currency_code": "<string>", "provider_id": "<string>", "authorized_amount": 123, "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", "payment": {}, "created_by": "<string>" } ], "refunds": [ { "id": "<string>", "amount": 123, "created_at": "2023-11-07T05:31:56Z", "payment": { "id": "<string>", "amount": 123, "currency_code": "<string>", "provider_id": "<string>", "authorized_amount": 123, "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", "payment": {}, "created_by": "<string>" } ], "refunds": [ { "id": "<string>", "amount": 123, "created_at": "2023-11-07T05:31:56Z", "payment": {}, "refund_reason_id": "<string>", "note": "<string>", "created_by": "<string>", "refund_reason": { "id": "<string>", "label": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "code": "<string>", "description": "<string>", "metadata": {} } } ], "payment_collection": {}, "payment_session": {} }, "refund_reason_id": "<string>", "note": "<string>", "created_by": "<string>", "refund_reason": { "id": "<string>", "label": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "code": "<string>", "description": "<string>", "metadata": {} } } ], "payment_collection": {}, "payment_session": { "id": "<string>", "amount": 123, "currency_code": "usd", "provider_id": "<string>", "data": {}, "status": "authorized", "context": { "customer": { "id": "cus_123" } }, "authorized_at": "2023-11-07T05:31:56Z", "payment_collection": {}, "payment": { "id": "<string>", "amount": 123, "currency_code": "<string>", "provider_id": "<string>", "authorized_amount": 123, "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", "payment": {}, "created_by": "<string>" } ], "refunds": [ { "id": "<string>", "amount": 123, "created_at": "2023-11-07T05:31:56Z", "payment": {}, "refund_reason_id": "<string>", "note": "<string>", "created_by": "<string>", "refund_reason": { "id": "<string>", "label": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "code": "<string>", "description": "<string>", "metadata": {} } } ], "payment_collection": {}, "payment_session": {} } } } ] } ], "id": "<string>", "version": 123, "region_id": "<string>", "customer_id": "<string>", "sales_channel_id": "<string>", "email": "jsmith@example.com", "currency_code": "<string>", "items": [ { "id": "<string>", "title": "<string>", "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": { "Color": "Blue" }, "requires_shipping": true, "is_discountable": true, "is_tax_inclusive": true, "unit_price": 123, "quantity": 123, "detail": {}, "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>", "variant": { "prices": [ { "id": "<string>", "title": "<string>", "currency_code": "usd", "amount": 123, "raw_amount": {}, "min_quantity": 123, "max_quantity": 123, "price_set_id": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ], "id": "<string>", "title": "<string>", "sku": "<string>", "barcode": "<string>", "ean": "<string>", "upc": "<string>", "allow_backorder": true, "manage_inventory": true, "hs_code": "<string>", "origin_country": "<string>", "mid_code": "<string>", "material": "<string>", "weight": 123, "length": 123, "height": 123, "width": 123, "options": [ { "id": "<string>", "value": "<string>", "option": { "id": "<string>", "title": "<string>", "product": {}, "product_id": "<string>", "values": [ {} ], "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" }, "option_id": "<string>", "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ], "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z", "images": [ { "id": "<string>", "url": "<string>", "rank": 123, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z", "metadata": {} } ], "thumbnail": "<string>", "inventory_quantity": 123, "variant_rank": 123, "product": {}, "product_id": "<string>", "calculated_price": { "id": "<string>", "calculated_amount": 123, "original_amount": 123, "currency_code": "usd", "original_amount_with_tax": 123, "original_amount_without_tax": 123, "is_calculated_price_price_list": true, "is_calculated_price_tax_inclusive": true, "calculated_amount_with_tax": 123, "calculated_amount_without_tax": 123, "is_original_price_price_list": true, "is_original_price_tax_inclusive": true, "calculated_price": {}, "original_price": {} }, "metadata": {}, "inventory_items": [ { "id": "<string>", "variant_id": "<string>", "inventory_item_id": "<string>", "variant": {}, "inventory": { "id": "<string>", "requires_shipping": true, "sku": "<string>", "origin_country": "<string>", "hs_code": "<string>", "mid_code": "<string>", "material": "<string>", "weight": 123, "length": 123, "height": 123, "width": 123, "title": "<string>", "description": "<string>", "thumbnail": "<string>", "metadata": {}, "location_levels": [ { "id": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z", "inventory_item_id": "<string>", "location_id": "<string>", "stocked_quantity": 123, "reserved_quantity": 123, "incoming_quantity": 123, "metadata": {}, "available_quantity": 123, "inventory_item": {} } ] }, "required_quantity": 123 } ], "translations": [ { "id": "<string>", "reference_id": "prod_123", "reference": "product", "locale_code": "fr-FR", "translations": { "title": "Chaussures", "description": "Des chaussures élégantes." }, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ] }, "product": { "variants": [ { "prices": [ { "id": "<string>", "title": "<string>", "currency_code": "usd", "amount": 123, "raw_amount": {}, "min_quantity": 123, "max_quantity": 123, "price_set_id": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ], "id": "<string>", "title": "<string>", "sku": "<string>", "barcode": "<string>", "ean": "<string>", "upc": "<string>", "allow_backorder": true, "manage_inventory": true, "hs_code": "<string>", "origin_country": "<string>", "mid_code": "<string>", "material": "<string>", "weight": 123, "length": 123, "height": 123, "width": 123, "options": [ { "id": "<string>", "value": "<string>", "option": { "id": "<string>", "title": "<string>", "product": {}, "product_id": "<string>", "values": [ {} ], "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" }, "option_id": "<string>", "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ], "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z", "images": [ { "id": "<string>", "url": "<string>", "rank": 123, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z", "metadata": {} } ], "thumbnail": "<string>", "inventory_quantity": 123, "variant_rank": 123, "product": {}, "product_id": "<string>", "calculated_price": { "id": "<string>", "calculated_amount": 123, "original_amount": 123, "currency_code": "usd", "original_amount_with_tax": 123, "original_amount_without_tax": 123, "is_calculated_price_price_list": true, "is_calculated_price_tax_inclusive": true, "calculated_amount_with_tax": 123, "calculated_amount_without_tax": 123, "is_original_price_price_list": true, "is_original_price_tax_inclusive": true, "calculated_price": {}, "original_price": {} }, "metadata": {}, "inventory_items": [ { "id": "<string>", "variant_id": "<string>", "inventory_item_id": "<string>", "variant": {}, "inventory": { "id": "<string>", "requires_shipping": true, "sku": "<string>", "origin_country": "<string>", "hs_code": "<string>", "mid_code": "<string>", "material": "<string>", "weight": 123, "length": 123, "height": 123, "width": 123, "title": "<string>", "description": "<string>", "thumbnail": "<string>", "metadata": {}, "location_levels": [ { "id": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z", "inventory_item_id": "<string>", "location_id": "<string>", "stocked_quantity": 123, "reserved_quantity": 123, "incoming_quantity": 123, "metadata": {}, "available_quantity": 123, "inventory_item": {} } ] }, "required_quantity": 123 } ], "translations": [ { "id": "<string>", "reference_id": "prod_123", "reference": "product", "locale_code": "fr-FR", "translations": { "title": "Chaussures", "description": "Des chaussures élégantes." }, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ] } ], "type": { "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": {}, "translations": [ { "id": "<string>", "reference_id": "prod_123", "reference": "product", "locale_code": "fr-FR", "translations": { "title": "Chaussures", "description": "Des chaussures élégantes." }, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ] }, "length": 123, "title": "<string>", "status": "draft", "options": [ { "id": "<string>", "title": "<string>", "product": {}, "product_id": "<string>", "values": [ {} ], "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>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "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>", "type_id": "<string>", "images": [ { "id": "<string>", "url": "<string>", "rank": 123, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z", "metadata": {}, "product": {}, "variants": [ {} ] } ], "discountable": true, "external_id": "<string>", "deleted_at": "2023-11-07T05:31:56Z", "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", "metadata": {}, "products": [ { "variants": [ {} ], "length": 123, "title": "<string>", "status": "draft", "options": [ { "id": "<string>", "title": "<string>", "product": {}, "product_id": "<string>", "values": [ { "id": "<string>", "value": "<string>", "option": {}, "option_id": "<string>", "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ], "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>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "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>", "type_id": "<string>", "images": [ { "id": "<string>", "url": "<string>", "rank": 123, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z", "metadata": {} } ], "discountable": true, "external_id": "<string>", "deleted_at": "2023-11-07T05:31:56Z", "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", "metadata": {}, "products": [ {} ] }, "categories": [ { "category_children": [ { "category_children": [ {} ], "parent_category": {}, "name": "<string>", "description": "<string>", "id": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "handle": "<string>", "deleted_at": "2023-11-07T05:31:56Z", "is_active": true, "is_internal": true, "rank": 123, "parent_category_id": "<string>", "products": [ {} ], "metadata": {} } ], "parent_category": { "category_children": [ {} ], "parent_category": {}, "name": "<string>", "description": "<string>", "id": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "handle": "<string>", "deleted_at": "2023-11-07T05:31:56Z", "is_active": true, "is_internal": true, "rank": 123, "parent_category_id": "<string>", "products": [ {} ], "metadata": {} }, "name": "<string>", "description": "<string>", "id": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "handle": "<string>", "deleted_at": "2023-11-07T05:31:56Z", "is_active": true, "is_internal": true, "rank": 123, "parent_category_id": "<string>", "products": [ {} ], "metadata": {} } ], "type": { "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": {} }, "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": {} } ], "metadata": {} } ], "translations": [ { "id": "<string>", "reference_id": "prod_123", "reference": "product", "locale_code": "fr-FR", "translations": { "title": "Chaussures", "description": "Des chaussures élégantes." }, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ] }, "categories": [ { "category_children": [ {} ], "parent_category": {}, "name": "<string>", "description": "<string>", "id": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "handle": "<string>", "deleted_at": "2023-11-07T05:31:56Z", "is_active": true, "is_internal": true, "rank": 123, "parent_category_id": "<string>", "products": [ {} ], "metadata": {} } ], "sales_channels": [ { "id": "<string>", "name": "<string>", "description": "<string>", "is_disabled": true, "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ], "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": {}, "translations": [ { "id": "<string>", "reference_id": "prod_123", "reference": "product", "locale_code": "fr-FR", "translations": { "title": "Chaussures", "description": "Des chaussures élégantes." }, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ] } ], "metadata": {}, "shipping_profile": { "id": "<string>", "name": "<string>", "type": "<string>", "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" }, "translations": [ { "id": "<string>", "reference_id": "prod_123", "reference": "product", "locale_code": "fr-FR", "translations": { "title": "Chaussures", "description": "Des chaussures élégantes." }, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ] }, "compare_at_unit_price": 123, "tax_lines": [ { "item": {}, "item_id": "<string>", "total": 123, "subtotal": 123, "id": "<string>", "code": "<string>", "rate": 123, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "description": "<string>", "tax_rate_id": "<string>", "provider_id": "<string>" } ], "adjustments": [ { "item": {}, "item_id": "<string>", "id": "<string>", "amount": 123, "order_id": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "code": "<string>", "description": "<string>", "promotion_id": "<string>", "provider_id": "<string>" } ] } ], "shipping_methods": [ { "id": "<string>", "order_id": "<string>", "name": "<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", "description": "<string>", "tax_lines": [ { "shipping_method": {}, "shipping_method_id": "<string>", "total": 123, "subtotal": 123, "id": "<string>", "code": "<string>", "rate": 123, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "description": "<string>", "tax_rate_id": "<string>", "provider_id": "<string>" } ], "adjustments": [ { "shipping_method": {}, "shipping_method_id": "<string>", "id": "<string>", "amount": 123, "order_id": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "code": "<string>", "description": "<string>", "promotion_id": "<string>", "provider_id": "<string>" } ], "detail": { "id": "<string>", "shipping_method_id": "<string>", "shipping_method": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "claim_id": "<string>", "exchange_id": "<string>", "return_id": "<string>" } } ], "payment_status": "canceled", "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 }, "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, "status": "<string>", "credit_line_total": 123, "item_discount_total": 123, "shipping_discount_total": 123, "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 } ], "sales_channel": { "id": "<string>", "name": "<string>", "description": "<string>", "is_disabled": true, "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" }, "customer": { "id": "<string>", "has_account": true, "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": "us", "province": "us-ca", "postal_code": "<string>", "phone": "<string>", "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z" } ], "groups": [ { "id": "<string>", "name": "<string>", "customers": [ {} ], "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z" } ], "phone": "<string>", "metadata": {}, "created_by": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" }, "shipping_address": { "id": "<string>", "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "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>" }, "billing_address": { "id": "<string>", "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "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>" }, "display_id": 123, "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" } ], "metadata": {}, "region": { "id": "<string>", "name": "<string>", "currency_code": "usd", "automatic_taxes": true, "countries": [ { "id": "<string>", "iso_2": "us", "iso_3": "usa", "num_code": 840, "name": "<string>", "display_name": "<string>" } ], "payment_providers": [ { "id": "<string>", "is_enabled": true } ], "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z" }, "credit_lines": [ { "id": "<string>", "order_id": "<string>", "order": {}, "reference": "<string>", "reference_id": "<string>", "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "amount": 123 } ], "custom_display_id": "<string>" } }

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The order's ID.

​
fulfillment_id
string
required

The fulfillment'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.

Body

application/json

The shipment's details.

​
items
object[]
required

The items to create shipment for.

​
metadata
object
required

The shipment's metadata. Can hold custom key-value pairs.

​
labels
object[]

The labels to create for the shipment.

​
no_notification
boolean

Whether to send the customer a notification about the created shipment.

​
additional_data
object

Pass additional custom data to the API route. This data is passed to the underlying workflow under the additional_data parameter.

Response

OK

An order's details.

​
order
object
required

The order's details.