Shippings API Reference

The Shippings API manages Shopier Contracted Shipping labels, barcode tracking codes, and carrier dispatches.

Methods

• client.Shippings.List(ctx, opts) -> (*PageResponse[Shipping], error)
• client.Shippings.All(ctx, opts) -> iter.Seq2[Shipping, error]
• client.Shippings.Get(ctx, code) -> (*Shipping, error)
• client.Shippings.Create(ctx, req) -> (*Shipping, error)
• client.Shippings.Delete(ctx, code) -> error

---

1. Generate Contracted Shipping Code

shipping, err := client.Shippings.Create(ctx, &shopier.ShippingCreateRequest{
	OrderID: "ord_123456",
	Company: "yurtici", // yurtici, mng, ptt, aras, surat, ups, etc.
})
if err != nil {
	log.Fatal(err)
}

fmt.Printf("Shipping Code: %s (Company: %s)\n", shipping.Code, shipping.Company)

2. Get Shipping Status

ship, err := client.Shippings.Get(ctx, "SHP-987654")
if err != nil {
	log.Fatal(err)
}

fmt.Printf("Status: %s | Tracking Number: %s (URL: %s)\n",
	ship.Status, ship.TrackingNumber, ship.TrackingURL)

---

Data Models & Types

Shipping

Represents a Shopier contracted shipping barcode label and tracking record.

Field	Type	JSON Tag	Description
OrderID	string	orderId	Associated Shopier order ID
Code	string	code	Unique contracted shipping code / barcode number
Company	string	company	Carrier slug ("yurtici", "mng", "ptt", "aras", "surat", "ups")
Status	string	status	Cargo status ("created", "inTransit", "delivered", "cancelled")
Method	string	method	Shipping method
Type	string	type	Shipment category
TrackingNumber	string	trackingNumber	Carrier-assigned live tracking number
TrackingURL	string	trackingUrl	Public carrier tracking page URL
Cost	string	cost	Incurred shipping charge
Currency	string	currency	Currency code ("TRY")
DateCreated	string	dateCreated	Code generation timestamp
DateDispatched	string	dateDispatched	Carrier intake timestamp

---

ShippingCreateRequest

Field	Type	JSON Tag	Required	Description
OrderID	string	orderId	Yes	Order ID for which to generate the shipping code
Company	string	company	Yes	Carrier name ("yurtici", "mng", "ptt", "aras", "surat", "ups")