164 lines
5.7 KiB
TypeScript
164 lines
5.7 KiB
TypeScript
/**
|
|
* @schema AdminUpdateFulfillmentSetServiceZones
|
|
* type: object
|
|
* description: The service zone's details.
|
|
* properties:
|
|
* name:
|
|
* type: string
|
|
* title: name
|
|
* description: The service zone's name.
|
|
* geo_zones:
|
|
* type: array
|
|
* description: The service zone's associated geo zones.
|
|
* items:
|
|
* oneOf:
|
|
* - type: object
|
|
* description: A country geo zone.
|
|
* required:
|
|
* - type
|
|
* - metadata
|
|
* - country_code
|
|
* properties:
|
|
* type:
|
|
* type: string
|
|
* title: type
|
|
* description: The geo zone's type.
|
|
* default: country
|
|
* metadata:
|
|
* type: object
|
|
* description: The geo zone's metadata.
|
|
* externalDocs:
|
|
* url: https://docs.medusajs.com/api/admin#manage-metadata
|
|
* description: Learn how to manage metadata
|
|
* country_code:
|
|
* type: string
|
|
* title: country_code
|
|
* description: The geo zone's country code.
|
|
* id:
|
|
* type: string
|
|
* title: id
|
|
* description: The ID of an existing geo zone.
|
|
* - type: object
|
|
* description: A province geo zone.
|
|
* required:
|
|
* - type
|
|
* - metadata
|
|
* - country_code
|
|
* - province_code
|
|
* properties:
|
|
* type:
|
|
* type: string
|
|
* title: type
|
|
* description: The geo zone's type.
|
|
* default: province
|
|
* metadata:
|
|
* type: object
|
|
* description: The geo zone's metadata.
|
|
* externalDocs:
|
|
* url: https://docs.medusajs.com/api/admin#manage-metadata
|
|
* description: Learn how to manage metadata
|
|
* country_code:
|
|
* type: string
|
|
* title: country_code
|
|
* description: The geo zone's country code.
|
|
* province_code:
|
|
* type: string
|
|
* title: province_code
|
|
* description: The geo zone's ISO 3166-2 province code. Must be lower-case.
|
|
* example: us-ca
|
|
* externalDocs:
|
|
* url: https://en.wikipedia.org/wiki/ISO_3166-2
|
|
* description: Learn more about ISO 3166-2
|
|
* id:
|
|
* type: string
|
|
* title: id
|
|
* description: The ID of an existing geo zone.
|
|
* - type: object
|
|
* description: A city geo zone
|
|
* required:
|
|
* - type
|
|
* - metadata
|
|
* - city
|
|
* - country_code
|
|
* - province_code
|
|
* properties:
|
|
* type:
|
|
* type: string
|
|
* title: type
|
|
* description: The geo zone's type.
|
|
* default: city
|
|
* metadata:
|
|
* type: object
|
|
* description: The geo zone's metadata.
|
|
* externalDocs:
|
|
* url: https://docs.medusajs.com/api/admin#manage-metadata
|
|
* description: Learn how to manage metadata
|
|
* city:
|
|
* type: string
|
|
* title: city
|
|
* description: The geo zone's city.
|
|
* country_code:
|
|
* type: string
|
|
* title: country_code
|
|
* description: The geo zone's country code.
|
|
* province_code:
|
|
* type: string
|
|
* title: province_code
|
|
* description: The geo zone's ISO 3166-2 province code. Must be lower-case.
|
|
* example: us-ca
|
|
* externalDocs:
|
|
* url: https://en.wikipedia.org/wiki/ISO_3166-2
|
|
* description: Learn more about ISO 3166-2
|
|
* id:
|
|
* type: string
|
|
* title: id
|
|
* description: The ID of an existing geo zone.
|
|
* - type: object
|
|
* description: A ZIP geo zone.
|
|
* required:
|
|
* - type
|
|
* - metadata
|
|
* - city
|
|
* - country_code
|
|
* - province_code
|
|
* - postal_expression
|
|
* properties:
|
|
* type:
|
|
* type: string
|
|
* title: type
|
|
* description: The geo zone's type.
|
|
* default: zip
|
|
* metadata:
|
|
* type: object
|
|
* description: The geo zone's metadata.
|
|
* externalDocs:
|
|
* url: https://docs.medusajs.com/api/admin#manage-metadata
|
|
* description: Learn how to manage metadata
|
|
* city:
|
|
* type: string
|
|
* title: city
|
|
* description: The geo zone's city.
|
|
* country_code:
|
|
* type: string
|
|
* title: country_code
|
|
* description: The geo zone's country code.
|
|
* province_code:
|
|
* type: string
|
|
* title: province_code
|
|
* description: The geo zone's ISO 3166-2 province code. Must be lower-case.
|
|
* example: us-ca
|
|
* externalDocs:
|
|
* url: https://en.wikipedia.org/wiki/ISO_3166-2
|
|
* description: Learn more about ISO 3166-2
|
|
* postal_expression:
|
|
* type: object
|
|
* description: The geo zone's postal expression or ZIP code.
|
|
* id:
|
|
* type: string
|
|
* title: id
|
|
* description: The ID of an existing geo zone.
|
|
* x-schemaName: AdminUpdateFulfillmentSetServiceZones
|
|
*
|
|
*/
|
|
|