Get Order

Endpoint: https://api.youcan.shop/orders/{id}

Method: GET

Required Scopes

• read-orders

Subresources

To include a sub-resource, add GET param include. https://api.youcan.shop/orders/{id}?include=<SUBRESOURCE>

Available subresources

• customer
• variants
• payment
• shipping
• discount
• coupon
• comments
• refunds
• referenced_order

Response

[200]

{
  "id": "72aa7882-3898-49a8-87a2-506af3dd7320",
  "ref": "021",
  "vat": 0,
  "total": 40,
  "currency": "MAD",
  "customer_currency": {
    "name": "Moroccan Dirham",
    "code": "MAD",
    "symbol": "د.م"
  },
  "customer_currency_rate": 1,
  "notes": null,
  "status": 1,
  "status_new": "Open",
  "tags": [],
  "extra_fields": null,
  "custom_fields": null,
  "is_refunded_by_platform": false,
  "platform_fee": 0,
  "status_object": {
    "slug": "open",
    "name": "Open",
    "color": "#8A9CA0FF"
  },
  "payment_status": 4,
  "confirmation_status": "pending",
  "shipping_status": "unfulfilled",
  "payment_status_new": "Pending",
  "created_at": "2021-03-17T09:42:07+00:00",
  "updated_at": "2021-03-17T10:40:42+00:00",
  "links": {
    "show": "https://api.youcan.shop/orders/72aa7882-3898-49a8-87a2-506af3dd7320"
  },
  "payment": {
    "status_text": "pending",
    "status": 5,
    "status_object": {
      "slug": "pending",
      "name": "Pending",
      "color": "#F5A623FF"
    },
    "gateway_type": 1,
    "gateway_type_text": "Cash on Delivery",
    "created_at": "2021-03-17 09:42",
    "updated_at": "2021-03-17 09:42",
    "address": []
  },
  "shipping": {
    "status_text": "unfulfilled",
    "status": 2,
    "price": 0,
    "is_free": true,
    "tracking_number": "",
    "status_object": {
      "slug": "unfulfilled",
      "name": "Unfulfilled",
      "color": "#8A9CA0FF"
    },
    "created_at": "2021-03-17 09:42",
    "updated_at": "2021-03-17 10:40",
    "address": []
  },
  "refunds": [],
  "variants": [
    {
      "id": "44c0317d-2771-48cc-9b4b-1f04fbd80033",
      "price": 40,
      "quantity": 1,
      "created_at": 1615974127,
      "updated_at": 1615977641,
      "extra_fields": [],
      "variant": {
        "id": "8a3a5a98-05a5-49c0-bff2-ef4f00d495e8",
        "variations": {
          "default": "default"
        },
        "options": ["default"],
        "values": ["default"],
        "price": 40,
        "compare_at_price": 60,
        "weight": 0,
        "sku": "",
        "barcode": "",
        "inventory": 5,
        "is_selected": false,
        "is_default": false,
        "image": {
          "name": null,
          "url": null
        },
        "created_at": "2021-02-26T15:30:02+00:00",
        "updated_at": "2021-02-26T15:30:02+00:00",
        "product": {
          "id": "d974bd63-6bad-41bf-9e5a-2bb53502d6db",
          "name": "Third product",
          "slug": "product-3",
          "public_url": null,
          "thumbnail": "http://cdn.youcan.shop/stores/default/products/MVyZpEEENXKTjbDIEbCBinIiwl2iXmtP4vpHtNHd_md.png",
          "description": "<p>The third product</p>",
          "price": 40,
          "compare_at_price": 60,
          "cost_price": null,
          "visibility": true,
          "has_variants": false,
          "variants_count": 1,
          "variant_options": [],
          "inventory": 5,
          "track_inventory": false,
          "meta": {
            "title": "Third product",
            "description": "The third product",
            "images": [
              {
                "path": "stores/default/products/MVyZpEEENXKTjbDIEbCBinIiwl2iXmtP4vpHtNHd.png",
                "link": "http://cdn.youcan.shop/stores/default/products/MVyZpEEENXKTjbDIEbCBinIiwl2iXmtP4vpHtNHd.png"
              }
            ]
          },
          "advanced_options": {
            "enabled": false,
            "related_products": []
          },
          "created_at": "2021-02-26T15:30:02+00:00",
          "updated_at": "2021-03-17T09:42:35+00:00",
          "deleted_at": false,
          "images": [
            {
              "id": "c21dc84a-c84f-4073-b272-689b5f070cff",
              "name": "stores/default/products/MVyZpEEENXKTjbDIEbCBinIiwl2iXmtP4vpHtNHd.png",
              "type": 1,
              "url": "http://cdn.youcan.shop/stores/default/products/MVyZpEEENXKTjbDIEbCBinIiwl2iXmtP4vpHtNHd.png",
              "order": 0,
              "variations": {
                "original": "http://cdn.youcan.shop/stores/default/products/MVyZpEEENXKTjbDIEbCBinIiwl2iXmtP4vpHtNHd.png",
                "sm": "http://cdn.youcan.shop/stores/default/products/MVyZpEEENXKTjbDIEbCBinIiwl2iXmtP4vpHtNHd_sm.png",
                "md": "http://cdn.youcan.shop/stores/default/products/MVyZpEEENXKTjbDIEbCBinIiwl2iXmtP4vpHtNHd_md.png",
                "lg": "http://cdn.youcan.shop/stores/default/products/MVyZpEEENXKTjbDIEbCBinIiwl2iXmtP4vpHtNHd_lg.png"
              }
            }
          ]
        }
      }
    }
  ]
}