Etsy · JSON Structure

Open Api V3 Shop Receipt Shipment Structure

The record of one shipment event for a ShopReceipt. A receipt may have many ShopReceiptShipment records.

Type: object Properties: 4
MarketplaceEcommerceHandmadeListingsOrdersPaymentsReviewsShippingTaxonomyOAuth2

ShopReceiptShipment is a JSON Structure definition published by Etsy, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

receipt_shipping_id shipment_notification_timestamp carrier_name tracking_code

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/etsy/refs/heads/main/json-structure/open-api-v3-shop-receipt-shipment-structure.json",
  "name": "ShopReceiptShipment",
  "description": "The record of one shipment event for a ShopReceipt. A receipt may have many ShopReceiptShipment records.",
  "type": "object",
  "properties": {
    "receipt_shipping_id": {
      "type": "int64",
      "description": "The unique numeric ID of a Shop Receipt Shipment record.",
      "nullable": true,
      "minimum": 1,
      "example": 1
    },
    "shipment_notification_timestamp": {
      "type": "int32",
      "description": "The time at which Etsy notified the buyer of the shipment event, in epoch seconds.",
      "minimum": 946684800,
      "example": 1758153645
    },
    "carrier_name": {
      "type": "string",
      "description": "The name string for the carrier/company responsible for delivering the shipment.",
      "example": "usps"
    },
    "tracking_code": {
      "type": "string",
      "description": "The tracking code string provided by the carrier/company for the shipment.",
      "example": "1Z999AA10123456784"
    }
  }
}