# ShippingOriginCreateDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Input for creating a ship-from origin.

## Fields
- `merchantId` (string(uuid)) required: The merchant that owns this origin. Required on create, and immutable afterwards: an update  that names a different merchant is refused rather than silently moving the origin. (nullable)
- `name` (string) required: Operator-facing name of the location, for example "Main warehouse". (nullable, max length 128)
- `address` ([Address](https://devportal.demo.winkpg.io/docs/api/models/Address.md)) required: The ship-from address. Required: an origin with no address is not somewhere a parcel can ship  from. US addresses carry State and Zip; every other country carries Province and Postal Code.
  Fields:
  - `id` (string(uuid)): Gets the unique identifier for the address. (read only)
  - `address1` (string): Gets or sets the first line of the address (e.g., street address). (nullable, max length 100)
  - `address2` (string): Gets or sets the second line of the address (e.g., apartment, suite, unit, building, floor, etc.). (nullable, max length 100)
  - `city` (string): Gets or sets the city of the address. (nullable, max length 100)
  - `state` (string): Gets or sets the state or region of the address. (nullable, max length 100)
  - `province` (string): Gets or sets the province of the address (if applicable). (nullable)
  - `zip` (string): Gets or sets the ZIP code of the address. Conditional: Conditional (see validator source). Pattern: ^\d{5}(-\d{4})?$. Conditional: When IsUsCountry(Country) is false. Max length: 20. (nullable)
  - `postalCode` (string): Gets or sets the postal code of the address. (nullable, max length 20)
  - `country` (string): Gets or sets the country of the address. Defaults to "USA". (nullable, max length 100)
  - `isMailing` (boolean): Gets or sets a value indicating whether this address is a mailing address.
  - `isDefault` (boolean): Gets or sets a value indicating whether this address is the default address.
- `phone` (string): An optional contact number for the location, which some carriers ask for when quoting. (nullable, max length 32)
- `isDefault` (boolean): Whether this is the merchant's default origin. A merchant's first origin is the default  whatever this says; setting it on another origin moves the flag there. It cannot be switched  off on the current default while the merchant has other origins.

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.