Label Search

GET{{api_url}}/shop/amazontoday/order/label/search?amazon_today_order_id=111-1111111-111111

This call gets a label for an Amazon Today order. One of the following three query params are required:

  • amazon_today_order_id
  • amazon_today_shipment_id
  • infiplex_order_id

If no matching order is found, nothing will be returned

If package_id is sent, then only the matching info will be returned, otherwise all packages for the order will be returned

Authorization

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

Query Parameters

KeyValueDescription
amazon_today_shipment_id optionalGets an Amazon Today Label by Amazon Today Shipment ID
infiplex_order_id optionalGets an Amazon Today Label by InfiPlex Order ID
amazon_today_order_id111-1111111-111111Gets an Amazon Today Label by Amazon Today Order ID
package_id optionalThis is the package ID in your system that was used to generate the label. This is not required

Example Request

curl --location --request GET '{{api_url}}/shop/amazontoday/order/label/search?amazon_today_order_id=111-1111111-111111' \
--header 'Authorization: Bearer {{auth_token}}'

Example Responses

Label Search

Request

curl --location --request GET 'https://example.com/api/admin/shop/amazontoday/order/label/search?amazon_today_order_id=111-1111111-1110650' \
--header 'Authorization: Bearer YOUR_API_KEY'

Response

[
    {
        "shop_order_ship_trackingid": "1557",
        "sost_orderid": "103210",
        "external_order_num": "111-1111111-1110650",
        "date_created": "2023-07-31 15:54:33",
        "tracking_num": "Track112233",
        "carrier_name": "Amazon",
        "carrier_method": "AMZL_US_SP_PICKUP",
        "label_img": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAywAAATCAQMAAABlqfCiAAAAIGNIUk0AAHomAACAhAAA.....",
        "package_items": [
            {
                "shop_order_ship_tracking_itemid": "2014",
                "sosti_trackingid": "1557",
                "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"
            }
        ]
    }
]