Skip to content

Commit

Permalink
B2B-1418: [update] modified quote status description (#568)
Browse files Browse the repository at this point in the history
<!-- Ticket number or summary of work -->
# [B2B-1418](https://bigcommercecloud.atlassian.net/browse/B2B-1418)


## What changed?
<!-- Provide a bulleted list in the present tense -->
Added the description for the quote status field to be consistent with
the B2B Edition App.
<img width="1319" alt="image"
src="https://github.com/user-attachments/assets/86fab149-cc78-4d81-b288-010b38767916">

The specific modifications are as follows.
* Modified **status** field in quote list query params
    * Changed the field type to integer.
    * Added the meanings of each status value in the description.
    * Added allowed values

* Modified **status** field in quote response
    * Changed the field type to integer.
    * Added the meanings of each status value in the description.

* Corrected the incorrect status value in the response example.

## Release notes draft
<!-- Provide an entry for the release notes using simple, conversational
language. Don't be too technical. Explain how the change will benefit
the merchant and link to the feature.

Examples:
* The newly-released [X feature] is now available to use. Now, you’ll be
able to [perform Y action].
* We're happy to announce [X feature], which can help you [perform Y
action].
* [X feature] helps you to create [Y response] using the [Z query
parameter]. Now, you can deliver [ex, localized shopping experiences for
your customers].
* Fixed a bug in the [X endpoint]. Now the [Y field] will appear when
you click [Z option]. -->

N/A

## Anything else?
<!-- Add related PRs, salient notes, additional ticket numbers, etc. -->



[B2B-1418]:
https://bigcommercecloud.atlassian.net/browse/B2B-1418?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
  • Loading branch information
JamessenLiu authored Oct 8, 2024
1 parent 27c98f4 commit a1f3c57
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions docs/b2b-edition/specs/api-v3/quote/quote.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ paths:
updatedAt: 1622618606
expiredAt: 1622717999
subtotal: 45.95
status: 1
status: 0
currency:
token: ¥
location: left
Expand Down Expand Up @@ -110,7 +110,8 @@ paths:
type: number
description: Total price
status:
type: number
type: integer
description: Status of quote. 0:NEW; 2:IN PROCESS; 3:UPDATED BY CUSTOMER; 4:ORDERED; 5:EXPIRED; 6:ARCHIVED; 7:DRAFT
currency:
type: object
description: Currency information
Expand Down Expand Up @@ -221,7 +222,7 @@ paths:
updatedAt: 1622618606
expiredAt: 1622717999
subtotal: 45.95
status: 1
status: 0
currency:
token: ¥
location: left
Expand Down Expand Up @@ -288,10 +289,18 @@ paths:
name: salesRep
description: Super Admin ID
- schema:
type: string
type: integer
enum:
- 0
- 2
- 3
- 4
- 5
- 6
- 7
in: query
name: status
description: Status of quote
description: Status of quote. 0:NEW; 2:IN PROCESS; 3:UPDATED BY CUSTOMER; 4:ORDERED; 5:EXPIRED; 6:ARCHIVED; 7:DRAFT
- schema:
type: string
in: query
Expand Down Expand Up @@ -816,8 +825,8 @@ paths:
type: number
description: Expired at timestamp
status:
type: number
description: The status of this quote
type: integer
description: Status of this quote. 0:NEW; 2:IN PROCESS; 3:UPDATED BY CUSTOMER; 4:ORDERED; 5:EXPIRED; 6:ARCHIVED; 7:DRAFT
contactInfo:
type: object
required:
Expand Down

0 comments on commit a1f3c57

Please sign in to comment.