Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add vendor id definition for purchases #125

Merged
merged 2 commits into from
Jun 19, 2024
Merged

docs: add vendor id definition for purchases #125

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef89456
docs: add vendor id definition for purchases
jasanchez1 Jun 19, 2024
49a0e59
better explain the use of the field
jasanchez1 Jun 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions topsort-api-v2.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -957,6 +957,7 @@ components:
- productId: p_SA0238
unitPrice: 12.95
quantity: 2
vendorId: v_8fj2D
- productId: p_oajf2D
unitPrice: 1.49
occurredAt: '2019-01-01T12:59:59-05:00'
Expand Down Expand Up @@ -1141,6 +1142,13 @@ components:
exclusiveMinimum: true
description: The price of a single item in the marketplace currency.
example: 12.95
vendorId:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we also need to explain when to add vendorId.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, we probably should mention that this is generally optional and it is required in case they have multiple providers or when they want to use halo attribution.

Copy link
Contributor Author

@jasanchez1 jasanchez1 Jun 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed just added that

type: string
description: >
The vendor ID of the product being purchased. This field is optional
and should be filled in if a product is sold by multiple vendors.
minLength: 1
example: v_8fj2D

securitySchemes:
BearerAuth:
Expand Down
Loading