Generate Label

PUT{{api_url}}/shop/amazontoday/order/label

This call generates a label for an Amazon Today order. One of the following three items are required in the request body:

  • amazon_today_order_id
  • amazon_today_shipment_id
  • infiplex_order_id

If no matching order is found, nothing will be generated

Package dimensions are optional (package_dimensions). If nothing is sent, a package size of 1x1x1 is used. All dimensions are in Inches

Package weight is also optional (package_weight). If nothing is sent, a package weight of 1 ounce is used. All weights are in ounces.

Authorization

Bearer token, sent in the Authorization header. Inherited from the collection.

Body

{
    "amazon_today_order_id": "111-1111111-1111112",
    "amazon_today_shipment_id": "",
    "infiplex_order_id": "",
    "package_id": "your_system_package_id334",
    "package_items": [
        {
            "sku": "YS-M524-YU8I",
            "quantity": 1
        }
    ],
    "package_dimensions": {
        "length": 5,
        "width": 5,
        "height": 5
    },
    "package_weight": 14
}

Example Request

curl --location --request PUT '{{api_url}}/shop/amazontoday/order/label' \
--header 'Authorization: Bearer {{auth_token}}' \
--data '{
    "amazon_today_order_id": "111-1111111-1111112",
    "amazon_today_shipment_id": "",
    "infiplex_order_id": "",
    "package_id": "your_system_package_id334",
    "package_items": [
        {
            "sku": "YS-M524-YU8I",
            "quantity": 1
        }
    ],
    "package_dimensions": {
        "length": 5,
        "width": 5,
        "height": 5
    },
    "package_weight": 14
}'

Example Responses

Generate Label

Request

curl --location --request PUT 'https://example.com/api/admin/shop/amazontoday/order/label' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--data '{
    "amazon_today_order_id": "111-1111111-1111112",
    "amazon_today_shipment_id": "",
    "infiplex_order_id": "",
    "package_id": "your_system_package_id",
    "package_items": [
        {
            "sku": "YS-M524-YU8I",
            "quantity": 1
        }
    ],
    "package_dimensions": {
        "length": 5,
        "width": 5,
        "height": 5
    },
    "package_weight": 14
}'

Response

[
    {
        "shop_order_ship_trackingid": "1570",
        "sost_orderid": "103210",
        "external_order_num": "Zaaabbb02",
        "date_created": "2023-08-30 21:32:17",
        "tracking_num": "Track0914",
        "carrier_name": "Amazon",
        "carrier_method": "AMZL_US_SP_PICKUP",
        "label_img": "data:image/png;base64, iAATCAQMAAABlqAATCAQMAAABlqywAAATCAQMAAABlqfCiAAAAIGNIUk",
        "package_items": [
            {
                "shop_order_ship_tracking_itemid": "2024",
                "sosti_trackingid": "1570",
                "sosti_itemid": "20524",
                "quantity_shipped": "1",
                "serial_number": null,
                "lot_number": null,
                "warehouse_identifier": null,
                "single_qty_weight_oz": "0.00",
                "ident_imei": null,
                "ident_eid": null,
                "ident_iccid": null,
                "ident_other": null,
                "product_name": "YS-M524-YU8I",
                "ship_weight": "0.00",
                "external_itemid": "1",
                "sku": "YS-M524-YU8I",
                "ship_length_inches": "0.00",
                "ship_width_inches": "0.00",
                "ship_height_inches": "0.00",
                "quantity": "1",
                "item_price": "23.99",
                "item_upc": null,
                "item_isbn": null,
                "item_asin": "B001KYQODW",
                "item_gtin": null,
                "item_ean": null,
                "item_additional_id": null,
                "item_cost": "0.00",
                "custom_data1": null,
                "custom_data2": null,
                "custom_data3": null,
                "created_from_line_modify": "0",
                "sku_custom_data": [
                    {
                        "shop_product_sku_custom_data_id": "183",
                        "shop_product_sku_custom_data_siteareaid": "16",
                        "sku": "YS-M524-YU8I",
                        "data_name": "sldpi_note_package_1",
                        "data_value": "YS-M524-YU8I package 1"
                    },
                    {
                        "shop_product_sku_custom_data_id": "184",
                        "shop_product_sku_custom_data_siteareaid": "16",
                        "sku": "YS-M524-YU8I",
                        "data_name": "sldpi_note_package_2",
                        "data_value": "YS-M524-YU8I package 2"
                    }
                ]
            }
        ]
    }
]