package protobuffet.example.shipping.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Shipment management service. This is a service created for the purpose of demonstration.

• rpc GetQuote (GetQuoteRequest, GetQuoteResponse)

  shipping.proto:11

  Fetch a quote (cost) for a proposed shipment.

  message GetQuoteRequest

  shipping.proto:17

  Request to fetch a quote for a proposed shipment/order.

  • optional Address address = 1

    Address for proposed order.

  • repeated carts.v1.CartItem items = 2

    Items within proposed order.

  message GetQuoteResponse

  shipping.proto:25

  Response for a proposed shipment quote.

  • optional common.types.v1.Money cost_usd = 1

    Shipment quote. See implementation docs for unique responses.

• rpc ShipOrder (ShipOrderRequest, ShipOrderResponse)

  shipping.proto:13

  Trigger a new order to be shipped.

  message ShipOrderRequest

  shipping.proto:31

  Request to trigger a new order to be shipped.

  • optional Address address = 1

    Address order should be shipped to.

  • repeated carts.v1.CartItem items = 2

    Items the proposed order contains.

  message ShipOrderResponse

  shipping.proto:39

  Response for a successfully created order.

  • string tracking_id = 1

    Tracking ID for the created order.

Represents an Address that we ship to.

Used in: checkout.v1.OrderResult, checkout.v1.PlaceOrderRequest, GetQuoteRequest, ShipOrderRequest

• string street_address = 1

  Address Line 1. If a unit number is present, it should prefix the street number eg. 613-54 Albert St.

• string city = 2

  City the address is within. See implementation docs for expected formatting.

• string state = 3

  State the address is within. See implementation docs for expected formatting.

• string country = 4

  Country the address is within. See implementation docs for expected formatting.

• string zip_code = 5

  Postal area the address is within. See implementation docs for expected formatting.