Schema changes for #3617 on Shipping Details representation. #3682

pascalfleury · 2024-10-10T11:31:28Z

This changes the representation of shipping information according to issue #3617, with some properties moved to the attic.

See details in the design doc.

The new structure can be navigated at: https://1-dot-schemadotorg1.ew.r.appspot.com/ShippingConditions

pascalfleury · 2024-10-15T14:54:31Z

The design doc and the proposed change went through the ShippingService -> ShippingConditions renaming.

the link to the new Type is now: https://1-dot-schemadotorg1.ew.r.appspot.com/ShippingConditions

github-actions · 2025-01-27T02:32:57Z

This pull request is being nudged due to inactivity.

pascalfleury · 2025-02-13T09:08:46Z

Newly deployed here now: https://1-dot-schemadotorg1.ew.r.appspot.com/ShippingService

alex-jansen · 2025-02-13T13:33:08Z

data/ext/pending/issue-3617.ttl

+# ║ FulfillmentType enumeration                            ║
+# ╚════════════════════════════════════════════════════════╝
+
+:FulfillmentType a rdfs:Class ;


change to FulfillmentTypeEnumeration for consistency with other enumeration types

alex-jansen · 2025-02-13T13:41:48Z

data/ext/pending/issue-3617.ttl

+
+:FulfillmentType a rdfs:Class ;
+    rdfs:label "FulfillmentType" ;
+    rdfs:comment "A type of product shipping fulfillment." ;


"shipping" seems superfluous, maybe just "A fulfillment method" ?

alex-jansen · 2025-02-13T13:43:57Z

data/ext/pending/issue-3617.ttl

+    rdfs:label "Delivery" ;
+    :isPartOf <https://pending.schema.org> ;
+    :source <https://github.com/schemaorg/schemaorg/issues/3617> ;
+    rdfs:comment "Shipping service fulfilling items to a customer selected address." .


"Fulfillment to a customer's selected address." ? (same prefix for the other enum value below) That way we make it more generic

alex-jansen · 2025-02-13T13:48:17Z

data/ext/pending/issue-3617.ttl

+    :isPartOf <https://pending.schema.org> ;
+    :source <https://github.com/schemaorg/schemaorg/issues/3617> .
+
+:validForMemberTier a rdf:Property ;


need to update the description for this existing property, it refers to OfferShippingDetails but should now refer also to ShippingService. Maybe edit this entire property in the other .ttl file where the property was originally defined (for issue 3563).

I think this should be renamed deliveryTime so it is consistent with the rest of the vocabulary.

alex-jansen · 2025-02-13T13:57:54Z

data/ext/pending/issue-3617.ttl

+    rdfs:subClassOf :StructuredValue ;
+    :isPartOf <https://pending.schema.org> ;
+    :source <https://github.com/schemaorg/schemaorg/issues/3617> ;
+    rdfs:comment "ShippingConditions represent a set of constraints and information about the conditions of shipping a product. Such conditions may apply to only a subset of the products being shipped, depending on aspects of the product like weight, size, price, destination, and others." .


I would add something that makes explicit that these conditions together specify a resulting shipping cost and/or handling and transit time. For example heavy or bulky items will be more expensive to ship that small items.

added some clarification.

alex-jansen

Ideally we also need some examples (in a separate issue-3617-examples.txt file)

alex-jansen · 2025-02-19T10:10:46Z

data/ext/pending/issue-3617.ttl

+    :domainIncludes :OfferShippingDetails ;
+    :rangeIncludes :Mass .
+
+:shippingService a rdf:Property ;


do we need this since we also add :hasShippingService below? We can have the same property used on both :OfferShipping details and :Organization

done. Even though the 'has' prefix is confusing users out there...

alex-jansen · 2025-02-19T10:13:22Z

data/ext/pending/issue-3617.ttl

+# ╔════════════════════════════════════════════════════════╗
+# ║  Delete DeliveryTimeSettings                           ║
+# ╚════════════════════════════════════════════════════════╝
+:DeliveryTimeSettings a rdfs:Class ;


should this also go to the attic then?

alex-jansen · 2025-02-19T10:15:12Z

data/ext/pending/issue-3617.ttl

+# ╔════════════════════════════════════════════════════════╗
+# ║  Adding ShippingCondition                              ║
+# ╚════════════════════════════════════════════════════════╝
+:ShippingConditions a rdfs:Class ;


should this be singular instead of plural since it is a single condition? (comment above is also singular)

corrected the comment. There are actually multiple conditions in that target Type.

alex-jansen · 2025-02-19T10:16:00Z

data/ext/pending/issue-3617.ttl

+    :rangeIncludes :QuantitativeValue ;
+    :isPartOf <https://pending.schema.org> ;
+    :source <htps://github.com/schemaorg/schemaorg/issues/3617> ;
+    rdfs:comment "Limits in the number of items being shipped for which these conditions apply." .


Limits the number (no "in" ?)

alex-jansen · 2025-02-19T10:19:36Z

data/ext/pending/issue-3617.ttl

+    :rangeIncludes :Boolean ;
+    :source <htps://github.com/schemaorg/schemaorg/issues/3617> .
+
+:deliveryTime a rdf:Property ;


does this represent transit time only and then not be named as such? (since handling time is modeled under ShippingService)? Or does it model both transit time and handling time (but in that case we need two separate properties IIUC)?

noticed it is also defined below?

I had not updated it to the new ServicePeriod.

alex-jansen

these examples result in some build errors against the schema

alex-jansen · 2025-02-19T20:24:25Z

data/ext/pending/issue-3617.ttl

+# ╔════════════════════════════════════════════════════════╗
+# ║  Amend ShippingDeliveryTime                            ║
+# ╚════════════════════════════════════════════════════════╝
+:transitDays a rdf:Property ;


do we also need to add :handlingDays ?

that is cruft thatI remove now.

alex-jansen · 2025-02-19T20:27:38Z

data/schema.ttl

+
+In the context of [[OfferShippingDetails]] and [[ShippingService]], this field is used to specify the handling time and the shipping time if the merchant does the shipping.
+
+In the context of [[ShippingConditions]], this is generally used to specify the transit time.""" ;


this is no longer under ShippingConditions? And do we still need :delivery time now we have :handling time and :transitTime?

since we have handlingTime and transitTime now, this comment clash no longer applies. Reverted to the previous message.

This changes the representation of shipping information accordoing to issue schemaorg#3617, with some properties moved to the attic.

Fixing the schema.

…nd the implementation.

pascalfleury force-pushed the issue-3617 branch from ec4272b to ecf80af Compare October 15, 2024 07:30

alex-jansen mentioned this pull request Oct 18, 2024

OfferShippingDetails does not provide for min amount/qty for shippingRate #2731

Closed

pascalfleury force-pushed the issue-3617 branch 2 times, most recently from 77c8c98 to d47e82b Compare October 22, 2024 11:56

pascalfleury requested review from MatthiasWiesmann and alex-jansen October 24, 2024 07:39

MatthiasWiesmann approved these changes Oct 24, 2024

View reviewed changes

github-actions bot added the no-pr-activity Discuss has gone quiet. Auto-tagging to encourage people to re-engage with the issue (or close it!). label Jan 27, 2025

pascalfleury force-pushed the issue-3617 branch from d47e82b to 8894764 Compare February 11, 2025 16:20

pascalfleury force-pushed the issue-3617 branch from 40236a8 to de74694 Compare February 13, 2025 09:18

alex-jansen reviewed Feb 13, 2025

View reviewed changes

pascalfleury force-pushed the issue-3617 branch 5 times, most recently from 6b201bc to 6959ef2 Compare February 17, 2025 13:47

alex-jansen reviewed Feb 19, 2025

View reviewed changes

pascalfleury force-pushed the issue-3617 branch from 6959ef2 to 1950a94 Compare February 19, 2025 17:20

alex-jansen reviewed Feb 19, 2025

View reviewed changes

Schema changes for schemaorg#3617 on Shipping Details representation.

9e4a51e

This changes the representation of shipping information accordoing to issue schemaorg#3617, with some properties moved to the attic.

pascalfleury added 4 commits February 20, 2025 16:33

Renaming of ShippingService -> ShippingConditions.

556ced3

Partial re-design of the Shipping schema.

89ff285

Fixing the schema.

Adding examples for the new shipping format.

b401972

Adressing more comments and fixing discrepancies between the design a…

dd020ce

…nd the implementation.

pascalfleury force-pushed the issue-3617 branch from 54a65a1 to 5ed2ba5 Compare February 20, 2025 15:34

Minor fixes and reworking comments on reused properties.

8c273a0

pascalfleury force-pushed the issue-3617 branch from 5ed2ba5 to 8c273a0 Compare February 20, 2025 16:49

fix typo in description for :handlingTime

a98e8c3

alex-jansen approved these changes Feb 21, 2025

View reviewed changes

alex-jansen merged commit 6a4dfba into schemaorg:main Feb 21, 2025
1 check passed

pascalfleury deleted the issue-3617 branch March 5, 2025 14:11

nickevansuk mentioned this pull request Apr 17, 2025

Merged PR #3682 has had unintended consequences #4425

Closed


		In the context of [[OfferShippingDetails]] and [[ShippingService]], this field is used to specify the handling time and the shipping time if the merchant does the shipping.

		In the context of [[ShippingConditions]], this is generally used to specify the transit time.""" ;

Schema changes for #3617 on Shipping Details representation. #3682

Schema changes for #3617 on Shipping Details representation. #3682

Conversation

pascalfleury commented Oct 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pascalfleury commented Oct 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jan 27, 2025

Uh oh!

pascalfleury commented Feb 13, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alex-jansen left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alex-jansen left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

pascalfleury commented Oct 10, 2024 •

edited

Loading

pascalfleury commented Oct 15, 2024 •

edited

Loading