API Documentation

vBETA

Authorization

Information

Type: Basic
User: Store's API user
Password: Store's API key
Header format: Authorization: Basic Encoded + base64 encoded user:password

Premiumprint\Api\Beta\Controllers\Controller

Shipping

/api/beta/shipping/rates
Calculate shipping rates

Returns a JSON representation of the calculated shipping rates for the given items and shipping info

Request (application/json)
{
    "shipping": {
        "country": 8
    },
    "items": [
        {
            "quantity": 1,
            "variant_id": 5
        }
    ]
}
Response 200 (application/json)
{
    "data": [
        {
            "code": "BASIC",
            "name": "BASIC",
            "price": "3.00",
            "price_details": {
                "currency": "EUR",
                "formatted": "3.00 \u20ac",
                "in_subunit": 300
            }
        },
        {
            "code": "DHL",
            "name": "DHL",
            "price": "1.00",
            "price_details": {
                "currency": "EUR",
                "formatted": "1.00 \u20ac",
                "in_subunit": 100
            }
        },
        {
            "code": "GEL",
            "name": "GEL",
            "price": "3.01",
            "price_details": {
                "currency": "EUR",
                "formatted": "3.01 \u20ac",
                "in_subunit": 301
            }
        },
        {
            "code": "GLS",
            "name": "GLS",
            "price": "9.51",
            "price_details": {
                "currency": "EUR",
                "formatted": "9.51 \u20ac",
                "in_subunit": 951
            }
        },
        {
            "code": "UPS",
            "name": "UPS",
            "price": "3.01",
            "price_details": {
                "currency": "EUR",
                "formatted": "3.01 \u20ac",
                "in_subunit": 301
            }
        }
    ]
}

Orders

/api/beta/orders
Show a list of all orders

Get a JSON representation of all orders

Response 200 (application/json)
{
    "data": [
        {
            "id": "PPO00000008T",
            "external_id": "TEST2",
            "is_test": true,
            "shipping_method": {
                "code": "DHL",
                "name": "DHL"
            },
            "status": "CANCELLED",
            "status_label": "Cancelled (TEST)",
            "created_at": {
                "date": "2017-08-09 09:09:42.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "updated_at": {
                "date": "2017-08-09 09:39:11.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "invoice": {
                "id": "PPI00000008T",
                "status": "CANCELLED",
                "status_label": "Cancelled",
                "download_url": "http:\/\/premium.app\/invoices\/8\/download\/d08dba6f39553e8e7f06c29eeb5c0256",
                "total_amount": "47.62",
                "total_amount_details": {
                    "currency": "EUR",
                    "formatted": "47.62 \u20ac",
                    "in_subunit": 4762
                },
                "paid_amount": "47.62",
                "paid_amount_details": {
                    "currency": "EUR",
                    "formatted": "47.62 \u20ac",
                    "in_subunit": 4762
                },
                "unpaid_amount": "0.00",
                "unpaid_amount_details": {
                    "currency": "EUR",
                    "formatted": "0.00 \u20ac",
                    "in_subunit": 0
                }
            },
            "shipments": [],
            "items": [
                {
                    "id": 10,
                    "external_id": null,
                    "variant_id": 5,
                    "name": "Mug",
                    "quantity": 2,
                    "price": "9.31",
                    "price_details": {
                        "currency": "EUR",
                        "formatted": "9.31 \u20ac",
                        "in_subunit": 931
                    },
                    "file": "http:\/\/placehold.it\/5000x3000",
                    "options": [],
                    "retail_price": null,
                    "retail_price_details": null
                },
                {
                    "id": 11,
                    "external_id": null,
                    "variant_id": 6,
                    "name": "Blanket",
                    "quantity": 1,
                    "price": "3.00",
                    "price_details": {
                        "currency": "EUR",
                        "formatted": "3.00 \u20ac",
                        "in_subunit": 300
                    },
                    "file": "http:\/\/placehold.it\/5000x3000",
                    "options": [],
                    "retail_price": null,
                    "retail_price_details": null
                }
            ],
            "totals": {
                "subtotal_amount": "21.62",
                "subtotal_amount_details": {
                    "currency": "EUR",
                    "formatted": "21.62 \u20ac",
                    "in_subunit": 2162
                },
                "shipping_amount": "26.00",
                "shipping_amount_details": {
                    "currency": "EUR",
                    "formatted": "26.00 \u20ac",
                    "in_subunit": 2600
                },
                "total_amount": "47.62",
                "total_amount_details": {
                    "currency": "EUR",
                    "formatted": "47.62 \u20ac",
                    "in_subunit": 4762
                }
            },
            "retail_costs": []
        }
    ],
    "meta": {
        "pagination": {
            "total": 8,
            "count": 8,
            "per_page": 10,
            "current_page": 1,
            "total_pages": 1,
            "links": []
        }
    }
}
/api/beta/orders/{order}
Show an order

Get a JSON representation of the given order

Response 200 (application/json)
{
    "data": {
        "id": "PPO00000008T",
        "external_id": "TEST2",
        "is_test": true,
        "shipping_method": {
            "code": "DHL",
            "name": "DHL"
        },
        "status": "ACCEPTED",
        "status_label": "Accepted (TEST)",
        "created_at": {
            "date": "2017-08-09 09:09:42.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "updated_at": {
            "date": "2017-08-09 09:09:43.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "invoice": {
            "id": "PPI00000008T",
            "status": "PAID",
            "status_label": "Paid",
            "download_url": "http:\/\/premium.app\/invoices\/8\/download\/d08dba6f39553e8e7f06c29eeb5c0256",
            "total_amount": "47.62",
            "total_amount_details": {
                "currency": "EUR",
                "formatted": "47.62 \u20ac",
                "in_subunit": 4762
            },
            "paid_amount": "47.62",
            "paid_amount_details": {
                "currency": "EUR",
                "formatted": "47.62 \u20ac",
                "in_subunit": 4762
            },
            "unpaid_amount": "0.00",
            "unpaid_amount_details": {
                "currency": "EUR",
                "formatted": "0.00 \u20ac",
                "in_subunit": 0
            }
        },
        "shipments": [],
        "items": [
            {
                "id": 10,
                "external_id": null,
                "variant_id": 5,
                "name": "Mug",
                "quantity": 2,
                "price": "9.31",
                "price_details": {
                    "currency": "EUR",
                    "formatted": "9.31 \u20ac",
                    "in_subunit": 931
                },
                "file": "http:\/\/placehold.it\/5000x3000",
                "options": [],
                "retail_price": null,
                "retail_price_details": null
            },
            {
                "id": 11,
                "external_id": null,
                "variant_id": 6,
                "name": "Blanket",
                "quantity": 1,
                "price": "3.00",
                "price_details": {
                    "currency": "EUR",
                    "formatted": "3.00 \u20ac",
                    "in_subunit": 300
                },
                "file": "http:\/\/placehold.it\/5000x3000",
                "options": [],
                "retail_price": null,
                "retail_price_details": null
            }
        ],
        "totals": {
            "subtotal_amount": "21.62",
            "subtotal_amount_details": {
                "currency": "EUR",
                "formatted": "21.62 \u20ac",
                "in_subunit": 2162
            },
            "shipping_amount": "26.00",
            "shipping_amount_details": {
                "currency": "EUR",
                "formatted": "26.00 \u20ac",
                "in_subunit": 2600
            },
            "total_amount": "47.62",
            "total_amount_details": {
                "currency": "EUR",
                "formatted": "47.62 \u20ac",
                "in_subunit": 4762
            }
        },
        "retail_costs": []
    }
}
/api/beta/orders
Create an order

Creates an order and returns the JSON representation of it (if country has regions, pass "region_id" as well)

Request (application/json)
{
    "billing": {
        "email": "john.doe@example.com",
        "firstname": "John",
        "lastname": "Doe",
        "company": "John Doe Company LTD",
        "vat": "VAT123456789",
        "street_primary": "JohnDoe Street 15",
        "street_secondary": "Apt 18",
        "city": "Cologne",
        "postcode": "90987",
        "country_code": "DE",
        "country_id": 8,
        "telephone": "+111222333444"
    },
    "shipping": {
        "email": "john.doe@example.com",
        "firstname": "John",
        "lastname": "Doe",
        "company": "John Doe Company LTD",
        "vat": "VAT123456789",
        "street_primary": "JohnDoe Street 15",
        "street_secondary": "Apt 18",
        "city": "Cologne",
        "postcode": "90987",
        "country_code": "DE",
        "country_id": 8,
        "telephone": "+111222333444"
    },
    "items": [
        {
            "quantity": 2,
            "variant_id": 5,
            "customs_value": 8.99,
            "file": "http:\/\/placehold.it\/5000x3000",
            "options": {
                "2": 6,
                "1": 1
            }
        },
        {
            "quantity": 1,
            "variant_id": 6,
            "file": "http:\/\/placehold.it\/5000x3000",
            "options": []
        }
    ],
    "shipping_method": "dhl",
    "external_id": "TEST2",
    "is_test": true
}
Response 200 (application/json)
{
    "data": {
        "id": "PPO00000008T",
        "external_id": "TEST2",
        "is_test": true,
        "shipping_method": {
            "code": "DHL",
            "name": "DHL"
        },
        "status": "ACCEPTED",
        "status_label": "Accepted (TEST)",
        "created_at": {
            "date": "2017-08-09 09:09:42.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "updated_at": {
            "date": "2017-08-09 09:09:43.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "invoice": {
            "id": "PPI00000008T",
            "status": "PAID",
            "status_label": "Paid",
            "download_url": "http:\/\/premium.app\/invoices\/8\/download\/d08dba6f39553e8e7f06c29eeb5c0256",
            "total_amount": "47.62",
            "total_amount_details": {
                "currency": "EUR",
                "formatted": "47.62 \u20ac",
                "in_subunit": 4762
            },
            "paid_amount": "47.62",
            "paid_amount_details": {
                "currency": "EUR",
                "formatted": "47.62 \u20ac",
                "in_subunit": 4762
            },
            "unpaid_amount": "0.00",
            "unpaid_amount_details": {
                "currency": "EUR",
                "formatted": "0.00 \u20ac",
                "in_subunit": 0
            }
        },
        "shipments": [],
        "items": [
            {
                "id": 10,
                "external_id": null,
                "variant_id": 5,
                "name": "Mug",
                "quantity": 2,
                "price": "9.31",
                "price_details": {
                    "currency": "EUR",
                    "formatted": "9.31 \u20ac",
                    "in_subunit": 931
                },
                "file": "http:\/\/placehold.it\/5000x3000",
                "options": [],
                "retail_price": null,
                "retail_price_details": null
            },
            {
                "id": 11,
                "external_id": null,
                "variant_id": 6,
                "name": "Blanket",
                "quantity": 1,
                "price": "3.00",
                "price_details": {
                    "currency": "EUR",
                    "formatted": "3.00 \u20ac",
                    "in_subunit": 300
                },
                "file": "http:\/\/placehold.it\/5000x3000",
                "options": [],
                "retail_price": null,
                "retail_price_details": null
            }
        ],
        "totals": {
            "subtotal_amount": "21.62",
            "subtotal_amount_details": {
                "currency": "EUR",
                "formatted": "21.62 \u20ac",
                "in_subunit": 2162
            },
            "shipping_amount": "26.00",
            "shipping_amount_details": {
                "currency": "EUR",
                "formatted": "26.00 \u20ac",
                "in_subunit": 2600
            },
            "total_amount": "47.62",
            "total_amount_details": {
                "currency": "EUR",
                "formatted": "47.62 \u20ac",
                "in_subunit": 4762
            }
        },
        "retail_costs": []
    }
}
/api/beta/orders/{order}
Cancel an order

Cancels an order and returns a JSON representation of the given order

Response 200 (application/json)
{
    "data": {
        "id": "PPO00000008T",
        "external_id": "TEST2",
        "is_test": true,
        "shipping_method": {
            "code": "DHL",
            "name": "DHL"
        },
        "status": "CANCELLED",
        "status_label": "Cancelled (TEST)",
        "created_at": {
            "date": "2017-08-09 09:09:42.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "updated_at": {
            "date": "2017-08-09 09:39:11.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "invoice": {
            "id": "PPI00000008T",
            "status": "CANCELLED",
            "status_label": "Cancelled",
            "download_url": "http:\/\/premium.app\/invoices\/8\/download\/d08dba6f39553e8e7f06c29eeb5c0256",
            "total_amount": "47.62",
            "total_amount_details": {
                "currency": "EUR",
                "formatted": "47.62 \u20ac",
                "in_subunit": 4762
            },
            "paid_amount": "47.62",
            "paid_amount_details": {
                "currency": "EUR",
                "formatted": "47.62 \u20ac",
                "in_subunit": 4762
            },
            "unpaid_amount": "0.00",
            "unpaid_amount_details": {
                "currency": "EUR",
                "formatted": "0.00 \u20ac",
                "in_subunit": 0
            }
        },
        "shipments": [],
        "items": [
            {
                "id": 10,
                "external_id": null,
                "variant_id": 5,
                "name": "Mug",
                "quantity": 2,
                "price": "9.31",
                "price_details": {
                    "currency": "EUR",
                    "formatted": "9.31 \u20ac",
                    "in_subunit": 931
                },
                "file": "http:\/\/placehold.it\/5000x3000",
                "options": [],
                "retail_price": null,
                "retail_price_details": null
            },
            {
                "id": 11,
                "external_id": null,
                "variant_id": 6,
                "name": "Blanket",
                "quantity": 1,
                "price": "3.00",
                "price_details": {
                    "currency": "EUR",
                    "formatted": "3.00 \u20ac",
                    "in_subunit": 300
                },
                "file": "http:\/\/placehold.it\/5000x3000",
                "options": [],
                "retail_price": null,
                "retail_price_details": null
            }
        ],
        "totals": {
            "subtotal_amount": "21.62",
            "subtotal_amount_details": {
                "currency": "EUR",
                "formatted": "21.62 \u20ac",
                "in_subunit": 2162
            },
            "shipping_amount": "26.00",
            "shipping_amount_details": {
                "currency": "EUR",
                "formatted": "26.00 \u20ac",
                "in_subunit": 2600
            },
            "total_amount": "47.62",
            "total_amount_details": {
                "currency": "EUR",
                "formatted": "47.62 \u20ac",
                "in_subunit": 4762
            }
        },
        "retail_costs": []
    }
}

Products

/api/beta/products
Show products

Get a JSON representation of all products

Response 200 (application/json)
{
    "data": [
        {
            "id": 3,
            "name": "Leonardo da vinci",
            "variants": 2,
            "dpi": 300,
            "type": "PRINT"
        },
        {
            "id": 4,
            "name": "Callendar",
            "variants": 1,
            "dpi": 300,
            "type": "PRINT"
        }
    ]
}
/api/beta/products/{product}
Show product's variants

Get a JSON representation of all of product's variants

Response 200 (application/json)
{
    "data": [
        {
            "id": 6,
            "name": "Blanket",
            "printfile": {
                "format_width": 200,
                "format_height": 511
            },
            "attributes": {
                "152": {
                    "name": "Broken",
                    "code": "152",
                    "value": "101"
                }
            },
            "price": "3.00",
            "price_details": {
                "currency": "EUR",
                "formatted": "3.00 \u20ac",
                "in_subunit": 300
            },
            "shipping_countries": [
                8,
                660,
                20,
                16,
                4,
                12,
                24,
                36,
                44
            ],
            "options": []
        },
        {
            "id": 5,
            "name": "Mug",
            "printfile": {
                "format_width": 300,
                "format_height": 200
            },
            "attributes": [],
            "price": "9.31",
            "price_details": {
                "currency": "EUR",
                "formatted": "9.31 \u20ac",
                "in_subunit": 931
            },
            "shipping_countries": [
                8,
                660,
                20,
                16,
                4,
                12,
                24,
                36,
                44
            ],
            "options": {
                "1": {
                    "name": "Border",
                    "description": null,
                    "is_required": false,
                    "values": [
                        {
                            "id": 4,
                            "name": "White",
                            "price": "10.00",
                            "price_details": {
                                "currency": "EUR",
                                "formatted": "10.00 \u20ac",
                                "in_subunit": 1000
                            }
                        }
                    ]
                }
            }
        }
    ]
}

Countries

/api/beta/countries
Get list of countries with name and country_code

Get a JSON representation of all countries

Response 200 (application/json)
{
    "data": [
        {
            "name": "Afghanistan",
            "country_code": "004"
        },
        {
            "name": "Albania",
            "country_code": "008"
        },
        {
            "name": "Antarctica",
            "country_code": "010"
        },
        {
            "name": "Algeria",
            "country_code": "012"
        },
        {
            "name": "American Samoa",
            "country_code": "016"
        },
        {
            "name": "Andorra",
            "country_code": "020"
        },
        {
            "name": "Angola",
            "country_code": "024"
        },
        {
            "name": "Antigua and Barbuda",
            "country_code": "028"
        },
        {
            "name": "Azerbaijan",
            "country_code": "031"
        },
        {
            "name": "Argentina",
            "country_code": "032"
        },
        {
            "name": "Australia",
            "country_code": "036"
        },
        {
            "name": "Austria",
            "country_code": "040"
        },
        {
            "name": "Bahamas",
            "country_code": "044"
        },
        {
            "name": "Bahrain",
            "country_code": "048"
        },
        {
            "name": "Bangladesh",
            "country_code": "050"
        },
        {
            "name": "Armenia",
            "country_code": "051"
        },
        {
            "name": "Barbados",
            "country_code": "052"
        },
        {
            "name": "Belgium",
            "country_code": "056"
        },
        {
            "name": "Bermuda",
            "country_code": "060"
        },
        {
            "name": "Bhutan",
            "country_code": "064"
        },
        {
            "name": "Bolivia, Plurinational State of",
            "country_code": "068"
        },
        {
            "name": "Bosnia and Herzegovina",
            "country_code": "070"
        },
        {
            "name": "Botswana",
            "country_code": "072"
        },
        {
            "name": "Bouvet Island",
            "country_code": "074"
        },
        {
            "name": "Brazil",
            "country_code": "076"
        },
        {
            "name": "Belize",
            "country_code": "084"
        },
        {
            "name": "British Indian Ocean Territory",
            "country_code": "086"
        },
        {
            "name": "Solomon Islands",
            "country_code": "090"
        },
        {
            "name": "Virgin Islands, British",
            "country_code": "092"
        },
        {
            "name": "Brunei Darussalam",
            "country_code": "096"
        },
        {
            "name": "Bulgaria",
            "country_code": "100"
        },
        {
            "name": "Myanmar",
            "country_code": "104"
        },
        {
            "name": "Burundi",
            "country_code": "108"
        },
        {
            "name": "Belarus",
            "country_code": "112"
        },
        {
            "name": "Cambodia",
            "country_code": "116"
        },
        {
            "name": "Cameroon",
            "country_code": "120"
        },
        {
            "name": "Canada",
            "country_code": "124"
        },
        {
            "name": "Cape Verde",
            "country_code": "132"
        },
        {
            "name": "Cayman Islands",
            "country_code": "136"
        },
        {
            "name": "Central African Republic",
            "country_code": "140"
        },
        {
            "name": "Sri Lanka",
            "country_code": "144"
        },
        {
            "name": "Chad",
            "country_code": "148"
        },
        {
            "name": "Chile",
            "country_code": "152"
        },
        {
            "name": "China",
            "country_code": "156"
        },
        {
            "name": "Taiwan, Province of China",
            "country_code": "158"
        },
        {
            "name": "Christmas Island",
            "country_code": "162"
        },
        {
            "name": "Cocos (Keeling) Islands",
            "country_code": "166"
        },
        {
            "name": "Colombia",
            "country_code": "170"
        },
        {
            "name": "Comoros",
            "country_code": "174"
        },
        {
            "name": "Mayotte",
            "country_code": "175"
        },
        {
            "name": "Congo",
            "country_code": "178"
        },
        {
            "name": "Congo, the Democratic Republic of the",
            "country_code": "180"
        },
        {
            "name": "Cook Islands",
            "country_code": "184"
        },
        {
            "name": "Costa Rica",
            "country_code": "188"
        },
        {
            "name": "Croatia",
            "country_code": "191"
        },
        {
            "name": "Cuba",
            "country_code": "192"
        },
        {
            "name": "Cyprus",
            "country_code": "196"
        },
        {
            "name": "Czech Republic",
            "country_code": "203"
        },
        {
            "name": "Benin",
            "country_code": "204"
        },
        {
            "name": "Denmark",
            "country_code": "208"
        },
        {
            "name": "Dominica",
            "country_code": "212"
        },
        {
            "name": "Dominican Republic",
            "country_code": "214"
        },
        {
            "name": "Ecuador",
            "country_code": "218"
        },
        {
            "name": "El Salvador",
            "country_code": "222"
        },
        {
            "name": "Equatorial Guinea",
            "country_code": "226"
        },
        {
            "name": "Ethiopia",
            "country_code": "231"
        },
        {
            "name": "Eritrea",
            "country_code": "232"
        },
        {
            "name": "Estonia",
            "country_code": "233"
        },
        {
            "name": "Faroe Islands",
            "country_code": "234"
        },
        {
            "name": "Falkland Islands (Malvinas)",
            "country_code": "238"
        },
        {
            "name": "South Georgia and the South Sandwich Islands",
            "country_code": "239"
        },
        {
            "name": "Fiji",
            "country_code": "242"
        },
        {
            "name": "Finland",
            "country_code": "246"
        },
        {
            "name": "\u00c5land Islands",
            "country_code": "248"
        },
        {
            "name": "France",
            "country_code": "250"
        },
        {
            "name": "French Guiana",
            "country_code": "254"
        },
        {
            "name": "French Polynesia",
            "country_code": "258"
        },
        {
            "name": "French Southern Territories",
            "country_code": "260"
        },
        {
            "name": "Djibouti",
            "country_code": "262"
        },
        {
            "name": "Gabon",
            "country_code": "266"
        },
        {
            "name": "Georgia",
            "country_code": "268"
        },
        {
            "name": "Gambia",
            "country_code": "270"
        },
        {
            "name": "Palestinian Territory, Occupied",
            "country_code": "275"
        },
        {
            "name": "Germany",
            "country_code": "276"
        },
        {
            "name": "Ghana",
            "country_code": "288"
        },
        {
            "name": "Gibraltar",
            "country_code": "292"
        },
        {
            "name": "Kiribati",
            "country_code": "296"
        },
        {
            "name": "Greece",
            "country_code": "300"
        },
        {
            "name": "Greenland",
            "country_code": "304"
        },
        {
            "name": "Grenada",
            "country_code": "308"
        },
        {
            "name": "Guadeloupe",
            "country_code": "312"
        },
        {
            "name": "Guam",
            "country_code": "316"
        },
        {
            "name": "Guatemala",
            "country_code": "320"
        },
        {
            "name": "Guinea",
            "country_code": "324"
        },
        {
            "name": "Guyana",
            "country_code": "328"
        },
        {
            "name": "Haiti",
            "country_code": "332"
        },
        {
            "name": "Heard Island and McDonald Islands",
            "country_code": "334"
        },
        {
            "name": "Holy See (Vatican City State)",
            "country_code": "336"
        },
        {
            "name": "Honduras",
            "country_code": "340"
        },
        {
            "name": "Hong Kong",
            "country_code": "344"
        },
        {
            "name": "Hungary",
            "country_code": "348"
        },
        {
            "name": "Iceland",
            "country_code": "352"
        },
        {
            "name": "India",
            "country_code": "356"
        },
        {
            "name": "Indonesia",
            "country_code": "360"
        },
        {
            "name": "Iran, Islamic Republic of",
            "country_code": "364"
        },
        {
            "name": "Iraq",
            "country_code": "368"
        },
        {
            "name": "Ireland",
            "country_code": "372"
        },
        {
            "name": "Israel",
            "country_code": "376"
        },
        {
            "name": "Italy",
            "country_code": "380"
        },
        {
            "name": "C\u00f4te d'Ivoire",
            "country_code": "384"
        },
        {
            "name": "Jamaica",
            "country_code": "388"
        },
        {
            "name": "Japan",
            "country_code": "392"
        },
        {
            "name": "Kazakhstan",
            "country_code": "398"
        },
        {
            "name": "Jordan",
            "country_code": "400"
        },
        {
            "name": "Kenya",
            "country_code": "404"
        },
        {
            "name": "Korea, Democratic People's Republic of",
            "country_code": "408"
        },
        {
            "name": "Korea, Republic of",
            "country_code": "410"
        },
        {
            "name": "Kuwait",
            "country_code": "414"
        },
        {
            "name": "Kyrgyzstan",
            "country_code": "417"
        },
        {
            "name": "Lao People's Democratic Republic",
            "country_code": "418"
        },
        {
            "name": "Lebanon",
            "country_code": "422"
        },
        {
            "name": "Lesotho",
            "country_code": "426"
        },
        {
            "name": "Latvia",
            "country_code": "428"
        },
        {
            "name": "Liberia",
            "country_code": "430"
        },
        {
            "name": "Libya",
            "country_code": "434"
        },
        {
            "name": "Liechtenstein",
            "country_code": "438"
        },
        {
            "name": "Lithuania",
            "country_code": "440"
        },
        {
            "name": "Luxembourg",
            "country_code": "442"
        },
        {
            "name": "Macao",
            "country_code": "446"
        },
        {
            "name": "Madagascar",
            "country_code": "450"
        },
        {
            "name": "Malawi",
            "country_code": "454"
        },
        {
            "name": "Malaysia",
            "country_code": "458"
        },
        {
            "name": "Maldives",
            "country_code": "462"
        },
        {
            "name": "Mali",
            "country_code": "466"
        },
        {
            "name": "Malta",
            "country_code": "470"
        },
        {
            "name": "Martinique",
            "country_code": "474"
        },
        {
            "name": "Mauritania",
            "country_code": "478"
        },
        {
            "name": "Mauritius",
            "country_code": "480"
        },
        {
            "name": "Mexico",
            "country_code": "484"
        },
        {
            "name": "Monaco",
            "country_code": "492"
        },
        {
            "name": "Mongolia",
            "country_code": "496"
        },
        {
            "name": "Moldova, Republic of",
            "country_code": "498"
        },
        {
            "name": "Montenegro",
            "country_code": "499"
        },
        {
            "name": "Montserrat",
            "country_code": "500"
        },
        {
            "name": "Morocco",
            "country_code": "504"
        },
        {
            "name": "Mozambique",
            "country_code": "508"
        },
        {
            "name": "Oman",
            "country_code": "512"
        },
        {
            "name": "Namibia",
            "country_code": "516"
        },
        {
            "name": "Nauru",
            "country_code": "520"
        },
        {
            "name": "Nepal",
            "country_code": "524"
        },
        {
            "name": "Netherlands",
            "country_code": "528"
        },
        {
            "name": "Cura\u00e7ao",
            "country_code": "531"
        },
        {
            "name": "Aruba",
            "country_code": "533"
        },
        {
            "name": "Sint Maarten (Dutch part)",
            "country_code": "534"
        },
        {
            "name": "Bonaire, Sint Eustatius and Saba",
            "country_code": "535"
        },
        {
            "name": "New Caledonia",
            "country_code": "540"
        },
        {
            "name": "Vanuatu",
            "country_code": "548"
        },
        {
            "name": "New Zealand",
            "country_code": "554"
        },
        {
            "name": "Nicaragua",
            "country_code": "558"
        },
        {
            "name": "Niger",
            "country_code": "562"
        },
        {
            "name": "Nigeria",
            "country_code": "566"
        },
        {
            "name": "Niue",
            "country_code": "570"
        },
        {
            "name": "Norfolk Island",
            "country_code": "574"
        },
        {
            "name": "Norway",
            "country_code": "578"
        },
        {
            "name": "Northern Mariana Islands",
            "country_code": "580"
        },
        {
            "name": "United States Minor Outlying Islands",
            "country_code": "581"
        },
        {
            "name": "Micronesia, Federated States of",
            "country_code": "583"
        },
        {
            "name": "Marshall Islands",
            "country_code": "584"
        },
        {
            "name": "Palau",
            "country_code": "585"
        },
        {
            "name": "Pakistan",
            "country_code": "586"
        },
        {
            "name": "Panama",
            "country_code": "591"
        },
        {
            "name": "Papua New Guinea",
            "country_code": "598"
        },
        {
            "name": "Paraguay",
            "country_code": "600"
        },
        {
            "name": "Peru",
            "country_code": "604"
        },
        {
            "name": "Philippines",
            "country_code": "608"
        },
        {
            "name": "Pitcairn",
            "country_code": "612"
        },
        {
            "name": "Poland",
            "country_code": "616"
        },
        {
            "name": "Portugal",
            "country_code": "620"
        },
        {
            "name": "Guinea-Bissau",
            "country_code": "624"
        },
        {
            "name": "Timor-Leste",
            "country_code": "626"
        },
        {
            "name": "Puerto Rico",
            "country_code": "630"
        },
        {
            "name": "Qatar",
            "country_code": "634"
        },
        {
            "name": "R\u00e9union",
            "country_code": "638"
        },
        {
            "name": "Romania",
            "country_code": "642"
        },
        {
            "name": "Russian Federation",
            "country_code": "643"
        },
        {
            "name": "Rwanda",
            "country_code": "646"
        },
        {
            "name": "Saint Barth\u00e9lemy",
            "country_code": "652"
        },
        {
            "name": "Saint Helena, Ascension and Tristan da Cunha",
            "country_code": "654"
        },
        {
            "name": "Saint Kitts and Nevis",
            "country_code": "659"
        },
        {
            "name": "Anguilla",
            "country_code": "660"
        },
        {
            "name": "Saint Lucia",
            "country_code": "662"
        },
        {
            "name": "Saint Martin (French part)",
            "country_code": "663"
        },
        {
            "name": "Saint Pierre and Miquelon",
            "country_code": "666"
        },
        {
            "name": "Saint Vincent and the Grenadines",
            "country_code": "670"
        },
        {
            "name": "San Marino",
            "country_code": "674"
        },
        {
            "name": "Sao Tome and Principe",
            "country_code": "678"
        },
        {
            "name": "Saudi Arabia",
            "country_code": "682"
        },
        {
            "name": "Senegal",
            "country_code": "686"
        },
        {
            "name": "Serbia",
            "country_code": "688"
        },
        {
            "name": "Seychelles",
            "country_code": "690"
        },
        {
            "name": "Sierra Leone",
            "country_code": "694"
        },
        {
            "name": "Singapore",
            "country_code": "702"
        },
        {
            "name": "Slovakia",
            "country_code": "703"
        },
        {
            "name": "Viet Nam",
            "country_code": "704"
        },
        {
            "name": "Slovenia",
            "country_code": "705"
        },
        {
            "name": "Somalia",
            "country_code": "706"
        },
        {
            "name": "South Africa",
            "country_code": "710"
        },
        {
            "name": "Zimbabwe",
            "country_code": "716"
        },
        {
            "name": "Spain",
            "country_code": "724"
        },
        {
            "name": "South Sudan",
            "country_code": "728"
        },
        {
            "name": "Sudan",
            "country_code": "729"
        },
        {
            "name": "Western Sahara",
            "country_code": "732"
        },
        {
            "name": "Suriname",
            "country_code": "740"
        },
        {
            "name": "Svalbard and Jan Mayen",
            "country_code": "744"
        },
        {
            "name": "Swaziland",
            "country_code": "748"
        },
        {
            "name": "Sweden",
            "country_code": "752"
        },
        {
            "name": "Switzerland",
            "country_code": "756"
        },
        {
            "name": "Syrian Arab Republic",
            "country_code": "760"
        },
        {
            "name": "Tajikistan",
            "country_code": "762"
        },
        {
            "name": "Thailand",
            "country_code": "764"
        },
        {
            "name": "Togo",
            "country_code": "768"
        },
        {
            "name": "Tokelau",
            "country_code": "772"
        },
        {
            "name": "Tonga",
            "country_code": "776"
        },
        {
            "name": "Trinidad and Tobago",
            "country_code": "780"
        },
        {
            "name": "United Arab Emirates",
            "country_code": "784"
        },
        {
            "name": "Tunisia",
            "country_code": "788"
        },
        {
            "name": "Turkey",
            "country_code": "792"
        },
        {
            "name": "Turkmenistan",
            "country_code": "795"
        },
        {
            "name": "Turks and Caicos Islands",
            "country_code": "796"
        },
        {
            "name": "Tuvalu",
            "country_code": "798"
        },
        {
            "name": "Uganda",
            "country_code": "800"
        },
        {
            "name": "Ukraine",
            "country_code": "804"
        },
        {
            "name": "Macedonia, the former Yugoslav Republic of",
            "country_code": "807"
        },
        {
            "name": "Egypt",
            "country_code": "818"
        },
        {
            "name": "United Kingdom",
            "country_code": "826"
        },
        {
            "name": "Guernsey",
            "country_code": "831"
        },
        {
            "name": "Jersey",
            "country_code": "832"
        },
        {
            "name": "Isle of Man",
            "country_code": "833"
        },
        {
            "name": "Tanzania, United Republic of",
            "country_code": "834"
        },
        {
            "name": "United States",
            "country_code": "840"
        },
        {
            "name": "Virgin Islands, U.S.",
            "country_code": "850"
        },
        {
            "name": "Burkina Faso",
            "country_code": "854"
        },
        {
            "name": "Uruguay",
            "country_code": "858"
        },
        {
            "name": "Uzbekistan",
            "country_code": "860"
        },
        {
            "name": "Venezuela, Bolivarian Republic of",
            "country_code": "862"
        },
        {
            "name": "Wallis and Futuna",
            "country_code": "876"
        },
        {
            "name": "Samoa",
            "country_code": "882"
        },
        {
            "name": "Yemen",
            "country_code": "887"
        },
        {
            "name": "Zambia",
            "country_code": "894"
        }
    ]
}

Regions

/api/beta/regions/{country_code}
Get list of regions with name and country_code

Get a JSON representation of all regions

Response 200 (application/json)
{
    "data": [
        {
            "id": 1,
            "code": "AL",
            "name": "Alabama"
        },
        {
            "id": 2,
            "code": "AK",
            "name": "Alaska"
        },
        {
            "id": 3,
            "code": "AZ",
            "name": "Arizona"
        },
        {
            "id": 4,
            "code": "AR",
            "name": "Arkansas"
        },
        {
            "id": 5,
            "code": "CA",
            "name": "California"
        },
        {
            "id": 6,
            "code": "CO",
            "name": "Colorado"
        },
        {
            "id": 7,
            "code": "CT",
            "name": "Connecticut"
        },
        {
            "id": 8,
            "code": "DE",
            "name": "Delaware"
        },
        {
            "id": 9,
            "code": "DC",
            "name": "District of Columbia"
        },
        {
            "id": 10,
            "code": "FL",
            "name": "Florida"
        },
        {
            "id": 11,
            "code": "GA",
            "name": "Georgia"
        },
        {
            "id": 12,
            "code": "HI",
            "name": "Hawaii"
        },
        {
            "id": 13,
            "code": "ID",
            "name": "Idaho"
        },
        {
            "id": 14,
            "code": "IL",
            "name": "Illinois"
        },
        {
            "id": 15,
            "code": "IN",
            "name": "Indiana"
        },
        {
            "id": 16,
            "code": "IA",
            "name": "Iowa"
        },
        {
            "id": 17,
            "code": "KS",
            "name": "Kansas"
        },
        {
            "id": 18,
            "code": "KY",
            "name": "Kentucky"
        },
        {
            "id": 19,
            "code": "LA",
            "name": "Louisiana"
        },
        {
            "id": 20,
            "code": "ME",
            "name": "Maine"
        },
        {
            "id": 21,
            "code": "MD",
            "name": "Maryland"
        },
        {
            "id": 22,
            "code": "MA",
            "name": "Massachusetts"
        },
        {
            "id": 23,
            "code": "MI",
            "name": "Michigan"
        },
        {
            "id": 24,
            "code": "MN",
            "name": "Minnesota"
        },
        {
            "id": 25,
            "code": "MS",
            "name": "Mississippi"
        },
        {
            "id": 26,
            "code": "MO",
            "name": "Missouri"
        },
        {
            "id": 27,
            "code": "MT",
            "name": "Montana"
        },
        {
            "id": 28,
            "code": "NE",
            "name": "Nebraska"
        },
        {
            "id": 29,
            "code": "NV",
            "name": "Nevada"
        },
        {
            "id": 30,
            "code": "NH",
            "name": "New Hampshire"
        },
        {
            "id": 31,
            "code": "NJ",
            "name": "New Jersey"
        },
        {
            "id": 32,
            "code": "NM",
            "name": "New Mexico"
        },
        {
            "id": 33,
            "code": "NY",
            "name": "New York"
        },
        {
            "id": 34,
            "code": "NC",
            "name": "North Carolina"
        },
        {
            "id": 35,
            "code": "ND",
            "name": "North Dakota"
        },
        {
            "id": 36,
            "code": "OH",
            "name": "Ohio"
        },
        {
            "id": 37,
            "code": "OK",
            "name": "Oklahoma"
        },
        {
            "id": 38,
            "code": "OR",
            "name": "Oregon"
        },
        {
            "id": 39,
            "code": "PA",
            "name": "Pennsylvania"
        },
        {
            "id": 40,
            "code": "RI",
            "name": "Rhode Island"
        },
        {
            "id": 41,
            "code": "SC",
            "name": "South Carolina"
        },
        {
            "id": 42,
            "code": "SD",
            "name": "South Dakota"
        },
        {
            "id": 43,
            "code": "TN",
            "name": "Tennessee"
        },
        {
            "id": 44,
            "code": "TX",
            "name": "Texas"
        },
        {
            "id": 45,
            "code": "UT",
            "name": "Utah"
        },
        {
            "id": 46,
            "code": "VT",
            "name": "Vermont"
        },
        {
            "id": 47,
            "code": "VA",
            "name": "Virginia"
        },
        {
            "id": 48,
            "code": "WA",
            "name": "Washington"
        },
        {
            "id": 49,
            "code": "WV",
            "name": "West Virginia"
        },
        {
            "id": 50,
            "code": "WI",
            "name": "Wisconsin"
        },
        {
            "id": 51,
            "code": "WY",
            "name": "Wyoming"
        }
    ]
}

Shipment

When order will be fulfilled and shipped a notification to your email will be sent.
Additional you can specify store webhook URL in your store settings. The post to your webhook will made with following information

{
    "type": "shipment_sent",
    "created": "2017-01-01 12:00:00",
    "data": [
        "shipment": [
            "shipping_method": "BASIC",
            "tracking_number": "123456",
            "tracking_url": "http://example.com",
            "shipped_at": "2017-01-01 11:00:00",
            "items": [
                [
                    "item_id": 10,
                    "quantity": 1
                ],
                [
                    "item_id": 11,
                    "quantity": 2
                ]
            ]
        ],
        "order": [
            'id': 'PP10001111',
            'external_id': 'EX101999',
            'is_test': false,
            'shipping_method': ,
            'status': 'FULFILLED',
            'status_label': 'Fulfilled',
            'created_at': '2017-01-01 09:00:00',
            'updated_at': '2017-01-01 09:00:00',
            'invoice': [],
            'shipments': [],
            'items': [],
            'totals': [],
            'retail_costs': []
        ]
    ]
}