From c32bebe26860893ad9efbdf2a3d10061f3f96706 Mon Sep 17 00:00:00 2001 From: Christian <67261769+ChristianCasado@users.noreply.github.com> Date: Mon, 18 Dec 2023 17:25:38 +0100 Subject: [PATCH] Updated service point documentation & fixed taxes description (#20) * Updated service point documentation & fixed taxes description * changes requested --------- Co-authored-by: christian.casado --- openapi.yaml | 178 +++++++++++++++++++++++++++++++++++---------------- 1 file changed, 123 insertions(+), 55 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index fb54d4b..4ba2d54 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -5508,10 +5508,6 @@ components: readOnly: true allOf: - $ref: '#/components/schemas/carrier_code' - description: > - The [shipping - carrier](https://www.shipengine.com/docs/carriers/setup/) who will - ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. account_number: type: string readOnly: true @@ -5593,6 +5589,20 @@ components: description: > A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc. + lat: + format: double + type: number + example: 48.842608 + description: >- + The latitude of the point. Represented as signed degrees. Required + if long is provided. http://www.geomidpoint.com/latlon.html + long: + format: double + type: number + example: 0.032875 + description: >- + The longitude of the point. Represented as signed degrees. Required + if lat is provided. http://www.geomidpoint.com/latlon.html service: title: service type: object @@ -6977,10 +6987,10 @@ components: - business_service_center - station description: > - Determines how FedEx will pickup your packages + Tax identifier type for customs declaration - |Pickup Type |Description + |Type |Description |--------------------------|----------------------------------------- @@ -7614,11 +7624,6 @@ components: readOnly: true allOf: - $ref: '#/components/schemas/carrier_code' - description: > - The [shipping - carrier](https://www.shipengine.com/docs/carriers/setup/) who - will ship the package, such as `fedex`, `dhl_express`, - `stamps_com`, etc. tracking_status: readOnly: true allOf: @@ -11245,18 +11250,31 @@ components: properties: address_line1: type: string + example: 1999 Bishop Grandin Blvd. + description: > + The first line of the street address. For some addresses, this may + be the only line. Other addresses may require 2 or 3 lines. address_line2: type: string address_line3: type: string city_locality: type: string + example: Winnipeg + description: The name of the city or locality state_province: type: string + example: Manitoba + description: > + The state or province. For some countries (including the U.S.) only + abbreviations are allowed. Other countries allow the full name or + abbreviation. postal_code: - type: string + allOf: + - $ref: '#/components/schemas/postal_code' country_code: - type: string + allOf: + - $ref: '#/components/schemas/country_code' providers: type: array description: An array of shipping service providers and service codes @@ -11274,19 +11292,11 @@ components: example: chronoclassic description: Uniquely identifies a shipping service lat: - format: double - type: number - example: 48.874518928233094 - description: >- - The latitude of the point. Represented as signed degrees. Required - if long is provided. http://www.geomidpoint.com/latlon.html + allOf: + - $ref: '#/components/schemas/lat' long: - format: double - type: number - example: 2.3591775711639404 - description: >- - The longitude of the point. Represented as signed degrees. Required - if lat is provided. http://www.geomidpoint.com/latlon.html + allOf: + - $ref: '#/components/schemas/long' radius: format: int32 type: integer @@ -11303,21 +11313,19 @@ components: description: A list service points response body properties: lat: - format: double - type: number - example: 48.842608 + allOf: + - $ref: '#/components/schemas/lat' long: - format: double - type: number - example: 0.032875 + allOf: + - $ref: '#/components/schemas/long' service_points: type: array items: type: object properties: carrier_code: - type: string - example: chronopost + allOf: + - $ref: '#/components/schemas/carrier_code' service_codes: type: array items: @@ -11326,41 +11334,54 @@ components: service_point_id: type: string example: '614940' + description: A unique identifier for a carrier drop off point. company_name: type: string example: My fancy company name + description: > + If this is a business address, then the company name should be + specified here. Either `name` or the `company_name` field should + always be set. address_line1: type: string example: PLACE DU CANADA + description: > + The first line of the street address. city_locality: type: string example: TRUN + description: The name of the city or locality state_province: type: string example: TRUN + description: > + The state or province. For some countries (including the U.S.) only + abbreviations are allowed. Other countries allow the full name or + abbreviation. postal_code: - type: string - example: '61160' + allOf: + - $ref: '#/components/schemas/postal_code' country_code: - type: string - example: FR + allOf: + - $ref: '#/components/schemas/country_code' phone_number: type: string example: 555-555-5555 + description: Phone number associated lat: - format: double - type: number - example: 48.842608 + allOf: + - $ref: '#/components/schemas/lat' long: - format: double - type: number - example: 0.032875 + allOf: + - $ref: '#/components/schemas/long' distance_in_meters: format: double type: number example: 728.9959308847579 + description: Distance in meters hours_of_operation: type: object + description: Hours of operation properties: monday: type: array @@ -11370,9 +11391,11 @@ components: open: type: string example: '09:15' + description: Opening time close: type: string example: '12:00' + description: Closing time tuesday: type: array items: @@ -11381,9 +11404,11 @@ components: open: type: string example: '09:15' + description: Opening time close: type: string example: '12:00' + description: Closing time wednesday: type: array items: @@ -11395,6 +11420,7 @@ components: close: type: string example: '12:00' + description: Closing time thursday: type: array items: @@ -11403,9 +11429,11 @@ components: open: type: string example: '09:15' + description: Opening time close: type: string example: '12:00' + description: Closing time friday: type: array items: @@ -11414,9 +11442,11 @@ components: open: type: string example: '09:15' + description: Opening time close: type: string example: '12:00' + description: Closing time saturday: type: array items: @@ -11425,9 +11455,11 @@ components: open: type: string example: '09:15' + description: Opening time close: type: string example: '12:00' + description: Closing time sunday: type: array items: @@ -11436,11 +11468,14 @@ components: open: type: string example: '09:15' + description: Opening time close: type: string example: '12:00' + description: Closing time features: type: array + description: Service features items: type: string enum: @@ -11451,6 +11486,7 @@ components: - after_hours_dropbox type: type: string + description: Service point type default: pudo enum: - pudo @@ -11471,46 +11507,60 @@ components: type: object properties: carrier_code: - type: string - example: chronopost + allOf: + - $ref: '#/components/schemas/carrier_code' service_codes: type: array + example: [standard_delivery, return_return] + description: A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) service code. items: type: string service_point_id: type: string example: '614940' + description: A unique identifier for a carrier drop off point. company_name: type: string example: My fancy company name + description: > + If this is a business address, then the company name should be + specified here. Either `name` or the `company_name` field should + always be set. address_line1: type: string example: PLACE DU CANADA + description: > + The first line of the street address. city_locality: type: string example: TRUN + description: The name of the city or locality state_province: type: string example: TRUN + description: > + The state or province. For some countries (including the U.S.) only + abbreviations are allowed. Other countries allow the full name or + abbreviation. postal_code: - type: string - example: '61160' + allOf: + - $ref: '#/components/schemas/postal_code' country_code: - type: string - example: FR + allOf: + - $ref: '#/components/schemas/country_code' phone_number: type: string example: 555-555-5555 + description: Phone number associated lat: - format: double - type: number - example: 48.842608 + allOf: + - $ref: '#/components/schemas/lat' long: - format: double - type: number - example: 0.032875 + allOf: + - $ref: '#/components/schemas/long' hours_of_operation: type: object + description: Hours of operation properties: monday: type: array @@ -11520,9 +11570,11 @@ components: open: type: string example: '09:15' + description: Opening time close: type: string example: '12:00' + description: Closing time tuesday: type: array items: @@ -11531,9 +11583,11 @@ components: open: type: string example: '09:15' + description: Opening time close: type: string example: '12:00' + description: Closing time wednesday: type: array items: @@ -11542,9 +11596,11 @@ components: open: type: string example: '09:15' + description: Opening time close: type: string example: '12:00' + description: Closing time thursday: type: array items: @@ -11553,9 +11609,11 @@ components: open: type: string example: '09:15' + description: Opening time close: type: string example: '12:00' + description: Closing time friday: type: array items: @@ -11564,9 +11622,11 @@ components: open: type: string example: '09:15' + description: Opening time close: type: string example: '12:00' + description: Closing time saturday: type: array items: @@ -11575,9 +11635,11 @@ components: open: type: string example: '09:15' + description: Opening time close: type: string example: '12:00' + description: Closing time sunday: type: array items: @@ -11586,11 +11648,14 @@ components: open: type: string example: '09:15' + description: Opening time close: type: string example: '12:00' + description: Closing time features: type: array + description: Service point features items: type: string enum: @@ -11601,6 +11666,7 @@ components: - after_hours_dropbox type: type: string + description: Service point type default: pudo enum: - pudo @@ -11646,11 +11712,13 @@ components: readOnly: true minimum: 1 example: '????' + description: Page number pages: type: integer format: int32 readOnly: true minimum: 1 + description: Total number of pages links: readOnly: true allOf: