Skip to content

Update SwagDigitalSalesRooms store API schema #358

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

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update SwagDigitalSalesRooms store API schema #358

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
215 changes: 215 additions & 0 deletions SwagDigitalSalesRooms-storeapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2668,6 +2668,213 @@
}
]
},
"CustomerAddressJsonApi": {
"description": "Added since version: 6.0.0.0",
"allOf": [
{
"$ref": "#/components/schemas/resource"
},
{
"required": [
"id",
"customerId",
"countryId",
"firstName",
"lastName",
"city",
"street"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[0-9a-f]{32}$"
},
"customerId": {
"description": "Unique identity of customer.",
"type": "string",
"pattern": "^[0-9a-f]{32}$"
},
"countryId": {
"description": "Unique identity of country.",
"type": "string",
"pattern": "^[0-9a-f]{32}$"
},
"countryStateId": {
"description": "Unique identity of country's state.",
"type": "string",
"pattern": "^[0-9a-f]{32}$"
},
"salutationId": {
"description": "Unique identity of salutation.",
"type": "string",
"pattern": "^[0-9a-f]{32}$"
},
"firstName": {
"description": "First name of the customer.",
"type": "string"
},
"lastName": {
"description": "Last name of the customer.",
"type": "string"
},
"zipcode": {
"description": "Postal or zip code of customer's address.",
"type": "string"
},
"city": {
"description": "Name of customer's city.",
"type": "string"
},
"company": {
"description": "Name of customer's company.",
"type": "string"
},
"street": {
"description": "Name of customer's street.",
"type": "string"
},
"department": {
"description": "Name of customer's department.",
"type": "string"
},
"title": {
"description": "Titles given to customer like Dr. , Prof., etc",
"type": "string"
},
"phoneNumber": {
"description": "Customer's phone number.",
"type": "string"
},
"additionalAddressLine1": {
"description": "Additional customer's address information.",
"type": "string"
},
"additionalAddressLine2": {
"description": "Additional customer's address information.",
"type": "string"
},
"hash": {
"description": "Runtime field, cannot be used as part of the criteria.",
"type": "string"
},
"customFields": {
"type": "object"
},
"isDefaultBillingAddress": {
"description": "Added since version: 6.7.7.0. Runtime field, cannot be used as part of the criteria.",
"type": "boolean"
},
"isDefaultShippingAddress": {
"description": "Added since version: 6.7.7.0. Runtime field, cannot be used as part of the criteria.",
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"relationships": {
"properties": {
"country": {
"properties": {
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri-reference",
"example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/country"
}
}
},
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "country"
},
"id": {
"type": "string",
"pattern": "^[0-9a-f]{32}$",
"example": "e909c2d7067ea37437cf97fe11d91bd0"
}
}
}
},
"type": "object"
},
"countryState": {
"properties": {
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri-reference",
"example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/countryState"
}
}
},
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "country_state"
},
"id": {
"type": "string",
"pattern": "^[0-9a-f]{32}$",
"example": "cb6a9764567191fb74fe28d8d6a4819d"
}
}
}
},
"type": "object"
},
"salutation": {
"properties": {
"links": {
"type": "object",
"properties": {
"related": {
"type": "string",
"format": "uri-reference",
"example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/salutation"
}
}
},
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "salutation"
},
"id": {
"type": "string",
"pattern": "^[0-9a-f]{32}$",
"example": "7a6efb02514153b5aa9a8f40c6f8bcc3"
}
}
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
"CustomerAddress": {
"description": "Added since version: 6.0.0.0",
"required": [
Expand Down Expand Up @@ -2755,6 +2962,14 @@
"customFields": {
"type": "object"
},
"isDefaultBillingAddress": {
"description": "Added since version: 6.7.7.0. Runtime field, cannot be used as part of the criteria.",
"type": "boolean"
},
"isDefaultShippingAddress": {
"description": "Added since version: 6.7.7.0. Runtime field, cannot be used as part of the criteria.",
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
Expand Down
1 change: 1 addition & 0 deletions SwagDigitalSalesRooms-storeapi.summary.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@
"Customer",
"CustomerAddress",
"CustomerAddressBody",
"CustomerAddressJsonApi",
"CustomerAddressRead",
"CustomerGroup",
"CustomerRecovery",
Expand Down