Skip to main content
GET
/
subscriptions
/
cp
/
api
/
orders
/
{orderId}
/
live-status
Get the live fulfillment status for an order
curl --request GET \
  --url https://www.myshop.com/apps/subscriptions/cp/api/orders/{orderId}/live-status
import requests

url = "https://www.myshop.com/apps/subscriptions/cp/api/orders/{orderId}/live-status"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://www.myshop.com/apps/subscriptions/cp/api/orders/{orderId}/live-status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
const url = 'https://www.myshop.com/apps/subscriptions/cp/api/orders/{orderId}/live-status';
const options = {method: 'GET'};

fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://www.myshop.com/apps/subscriptions/cp/api/orders/{orderId}/live-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://www.myshop.com/apps/subscriptions/cp/api/orders/{orderId}/live-status"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
require 'uri'
require 'net/http'

url = URI("https://www.myshop.com/apps/subscriptions/cp/api/orders/{orderId}/live-status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "currencyCode": "<string>",
  "currentSubtotalPrice": "<string>",
  "currentTotalPrice": "<string>",
  "events": [
    {
      "appTitle": "<string>",
      "attributeToApp": true,
      "attributeToUser": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "message": "<string>"
    }
  ],
  "eventsEndCursor": "<string>",
  "eventsHasNextPage": true,
  "graphOrderId": "<string>",
  "lineItems": [
    {
      "currentQuantity": 123,
      "imageUrl": "<string>",
      "originalPrice": "<string>",
      "presentmentOriginalPrice": "<string>",
      "presentmentPrice": "<string>",
      "price": "<string>",
      "productId": "<string>",
      "quantity": 123,
      "title": "<string>",
      "variantId": "<string>",
      "variantTitle": "<string>"
    }
  ],
  "orderCancelledAt": "2023-11-07T05:31:56Z",
  "orderClosed": true,
  "orderClosedAt": "2023-11-07T05:31:56Z",
  "orderConfirmed": true,
  "orderCreatedAt": "2023-11-07T05:31:56Z",
  "orderId": 123,
  "orderName": "<string>",
  "orderProcessedAt": "2023-11-07T05:31:56Z",
  "presentmentCurrencyCode": "<string>",
  "presentmentCurrentSubtotalPrice": "<string>",
  "presentmentCurrentTotalPrice": "<string>",
  "presentmentSubtotalPrice": "<string>",
  "presentmentTotalDiscount": "<string>",
  "presentmentTotalPrice": "<string>",
  "presentmentTotalReceived": "<string>",
  "presentmentTotalRefunded": "<string>",
  "presentmentTotalShipping": "<string>",
  "presentmentTotalTax": "<string>",
  "shippingAddress": {
    "address1": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "country": "<string>",
    "firstName": "<string>",
    "formatted": [
      "<string>"
    ],
    "lastName": "<string>",
    "province": "<string>",
    "zip": "<string>"
  },
  "shippingMethod": "<string>",
  "subtotalPrice": "<string>",
  "totalDiscount": "<string>",
  "totalPrice": "<string>",
  "totalReceived": "<string>",
  "totalRefunded": "<string>",
  "totalShipping": "<string>",
  "totalTax": "<string>"
}

Path Parameters

orderId
integer<int64>
required

Response

200 - */*

OK

currencyCode
string
currentSubtotalPrice
string
currentTotalPrice
string
events
object[]
eventsEndCursor
string
eventsHasNextPage
boolean
graphOrderId
string
lineItems
object[]
orderCancelReason
enum<string>
Available options:
CUSTOMER,
DECLINED,
FRAUD,
INVENTORY,
STAFF,
OTHER,
$UNKNOWN
orderCancelledAt
string<date-time>
orderClosed
boolean
orderClosedAt
string<date-time>
orderConfirmed
boolean
orderCreatedAt
string<date-time>
orderDisplayFinancialStatus
enum<string>
Available options:
PENDING,
AUTHORIZED,
PARTIALLY_PAID,
PARTIALLY_REFUNDED,
VOIDED,
PAID,
REFUNDED,
EXPIRED,
$UNKNOWN
orderDisplayFulfillmentStatus
enum<string>
Available options:
UNFULFILLED,
PARTIALLY_FULFILLED,
FULFILLED,
RESTOCKED,
PENDING_FULFILLMENT,
OPEN,
IN_PROGRESS,
ON_HOLD,
SCHEDULED,
REQUEST_DECLINED,
$UNKNOWN
orderId
integer<int64>
orderName
string
orderProcessedAt
string<date-time>
presentmentCurrencyCode
string
presentmentCurrentSubtotalPrice
string
presentmentCurrentTotalPrice
string
presentmentSubtotalPrice
string
presentmentTotalDiscount
string
presentmentTotalPrice
string
presentmentTotalReceived
string
presentmentTotalRefunded
string
presentmentTotalShipping
string
presentmentTotalTax
string
shippingAddress
object
shippingMethod
string
subtotalPrice
string
totalDiscount
string
totalPrice
string
totalReceived
string
totalRefunded
string
totalShipping
string
totalTax
string