PODMaster API

With the POD Master API, you can do the following things related to your store order resources.

  1. Retrieves the list of your custom orders with
    GET https://podmaster.pro/api/podmaster/{{SHOP_ID}}/orders
  2. Retrieves information of specific order with
    GET https://podmaster.pro/api/podmaster/{{SHOP_ID}}/orders/{{ORDER_ID}}

Kindly note that for the authentication, you have to add the pod-api-key to your API request header. You can get your API Key in the App dashboard ->  Settings -> API.

 

1. GET https://podmaster.pro/api/podmaster/{{SHOP_ID}}/orders has a function to retrieves list of your custom orders.
{{SHOP_ID}} is your Shopify store account URL without .myshopify.com.

The parameters you can use for these endpoints are:

  • limit: by default 10 and maximum 100
  • page: by default 1
  • start_date
  • end_date

Kindly look at this sample below.

 

 

2. GET https://podmaster.pro/api/podmaster/{{SHOP_ID}}/orders/{{ORDER_ID}} has a function to retrieves information of specific order.

  • {{SHOP_ID}} is your Shopify store account URL without .myshopify.com.
  • {{ORDER_ID}} is the order id that has been generated from the first endpoint (above the order number)

Kindly look at this sample below.

 

Please find the following detailed API response:

{
    "id": "5583100281072",
    "order_number": "1004",
    "shop_id": "pod-master-demo",
    "total_price": "1540.00",
    "subtotal_price": "1400.00",
    "total_line_items_price": "1400.00",
    "created_at": "2024-03-21 22:18:30",
    "currency": "USD",
    "customer_detail": {
        "id": 7250434588912,
        "created_at": "2024-03-01T17:18:30-05:00",
        "updated_at": "2024-03-21T11:18:31-04:00",
        "state": "disabled",
        "note": null,
        "verified_email": true,
        "multipass_identifier": null,
        "tax_exempt": false,
        "email_marketing_consent": {
            "state": "not_subscribed",
            "opt_in_level": "single_opt_in",
            "consent_updated_at": null
        },
        "sms_marketing_consent": null,
        "tags": "",
        "currency": "USD",
        "accepts_marketing": false,
        "accepts_marketing_updated_at": null,
        "marketing_opt_in_level": "single_opt_in",
        "tax_exemptions": [],
        "admin_graphql_api_id": "gid://shopify/Customer/7250434588912",
        "default_address": {
            "id": 8868221976816,
            "customer_id": 7250434588912,
            "company": null,
            "province": "Jawa Tengah",
            "country": "Indonesia",
            "province_code": "JT",
            "country_code": "ID",
            "country_name": "Indonesia",
            "default": true
        }
    },
    "shipping_line_detail": [
        {
            "id": 4530349441264,
            "carrier_identifier": "650f1a14fa979ec5c74d063e968411d4",
            "code": "Standard",
            "discounted_price": "0.00",
            "discounted_price_set": {
                "shop_money": {
                    "amount": "0.00",
                    "currency_code": "USD"
                },
                "presentment_money": {
                    "amount": "0.00",
                    "currency_code": "USD"
                }
            },
            "phone": null,
            "price": "0.00",
            "price_set": {
                "shop_money": {
                    "amount": "0.00",
                    "currency_code": "USD"
                },
                "presentment_money": {
                    "amount": "0.00",
                    "currency_code": "USD"
                }
            },
            "requested_fulfillment_service_id": null,
            "source": "shopify",
            "title": "Standard",
            "tax_lines": [],
            "discount_allocations": []
        }
    ],
    "fulfillment_status": "unfulfilled",
    "financial_status": "paid",
    "printful_fulfillment_status": "unfulfilled",
    "has_printful": true,
    "line_item": [
        {
            "id": 13798368411888,
            "admin_graphql_api_id": "gid://shopify/LineItem/13798368411888",
            "attributed_staffs": [],
            "fulfillable_quantity": 1,
            "fulfillment_service": "manual",
            "fulfillment_status": null,
            "gift_card": false,
            "grams": 0,
            "name": "Enhanced Matte Paper Poster (in) 2 - 18″×24″",
            "price": "1400.00",
            "price_set": {
                "shop_money": {
                    "amount": "1400.00",
                    "currency_code": "USD"
                },
                "presentment_money": {
                    "amount": "1400.00",
                    "currency_code": "USD"
                }
            },
            "product_exists": true,
            "product_id": 8573875880176,
            "properties": [
                {
                    "name": "pcustomizer-id",
                    "value": "pc65fc4f844af2b"
                }
            ],
            "quantity": 1,
            "requires_shipping": true,
            "sku": "POD-354EB",
            "taxable": true,
            "title": "Enhanced Matte Paper Poster (in) 2",
            "total_discount": "0.00",
            "total_discount_set": {
                "shop_money": {
                    "amount": "0.00",
                    "currency_code": "USD"
                },
                "presentment_money": {
                    "amount": "0.00",
                    "currency_code": "USD"
                }
            },
            "variant_id": 45445905383664,
            "variant_inventory_management": null,
            "variant_title": "18″×24″",
            "vendor": "Printful",
            "tax_lines": [
                {
                    "channel_liable": false,
                    "price": "140.00",
                    "price_set": {
                        "shop_money": {
                            "amount": "140.00",
                            "currency_code": "USD"
                        },
                        "presentment_money": {
                            "amount": "140.00",
                            "currency_code": "USD"
                        }
                    },
                    "rate": 0.1,
                    "title": "VAT"
                }
            ],
            "duties": [],
            "discount_allocations": [],
            "pcustomizerId": "pc65fc4f844af2b",
            "productSource": "printful",
            "design": [
                {
                    "id": 81,
                    "customized_product_id": "8573875880176",
                    "customized_variant_id": "45146931724528",
                    "shop_id": "pod-master-demo",
                    "pcustomizer_id": "pc65fc4f844af2b",
                    "name": "default",
                    "canvas_to_print": "https://pcustomizer.us-southeast-1.linodeobjects.com/apps/pod-master-demo/order/printful/mockup/8573875880176/pc65fc4f844af2b/default.png",
                    "canvas_customized": "https://pcustomizer.us-southeast-1.linodeobjects.com/apps/pod-master-demo/order/printful/canvas/8573875880176/pc65fc4f844af2b/default.jpeg",
                    "product_source": "printful",
                    "created_at": "2024-03-22 05:17:26",
                    "canvas_filename": "default.jpeg",
                    "canvas_type": "default",
                    "canvas_width": 1500,
                    "canvas_height": 1500
                }
            ]
        }
    ]
}