Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions docs/b2b-edition/specs/storefront/storefront.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1201,6 +1201,11 @@ paths:
example: 17316289569
format: int64
type: integer
customerEmail:
type: string
format: email
description: "The email address of the BigCommerce customer account for the Company account administrator. Must match the email on the customer account identified by `customerId`."
example: admin@example.com
customerId:
type: string
extraFields:
Expand All @@ -1223,6 +1228,7 @@ paths:
- companyName
- companyPhoneNumber
- companyEmail
- customerEmail
- addressLine1
- addressLine2
- city
Expand Down
41 changes: 41 additions & 0 deletions docs/b2b-edition/specs/storefront/storefront/company.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ paths:
- companyLastName
- companyName
- companyPhoneNumber
- customerEmail
- customerId
- state
- storeHash
Expand All @@ -122,6 +123,8 @@ paths:
customerId:
type: string
description: "The ID of the BigCommerce customer account for the Company account administrator."
customerEmail:
$ref: "#/components/schemas/customerEmail"
storeHash:
type: string
description: "The unique store hash for the BigCommerce store."
Expand All @@ -147,6 +150,39 @@ paths:
properties:
companyId:
$ref: "#/components/schemas/companyId_INT"
"400":
description: Bad Request
content:
application/json:
schema:
type: object
properties:
code:
type: number
description: "The application-level error code for the response."
data:
type: object
properties: {}
description: "Response data."
message:
type: string
description: "A message describing the error."
examples:
Missing Customer Email:
value:
code: 10013
data: {}
message: "customer email is required"
Customer Does Not Exist:
value:
code: 10012
data: {}
message: "customer does not exist"
Missing Required Fields:
value:
code: 10013
data: {}
message: "PARAMETER VALUE NOT ALLOW NULL"
/companies/extra-fields/storefront:
parameters: []
get:
Expand Down Expand Up @@ -1501,6 +1537,11 @@ components:
companyEmail:
description: "The primary email address of the company."
example: "admin@example.com"
customerEmail:
type: string
format: email
description: "The email address of the BigCommerce customer account for the Company account administrator. Must match the email on the customer account identified by `customerId`."
example: "admin@example.com"
catalogId:
type: string
description: "The ID of the price list assigned to the Company account."
Expand Down
Loading