AuctionRegistrationUpdated

v0.0.1

{
	"$id": "https://example.com/ClientAuctionRegistrationUpdated.json",
	"$schema": "https://json-schema.org/draft/2020-12/schema",
	"title": "ClientAuctionRegistrationUpdated",
	"description": "An event raised to publish updates to a client's online auction registration information.",
	"type": "object",
	"properties": {
		"metadata": {
			"type": "object",
			"properties": {
				"occurredAtUtc": {
					"type": "string",
					"description": "The date and time when event occurred in UTC. Date should be represented in ISO 8601 format e.g 2023-09-08T12:00:00Z"
				},
				"typeName": {
					"type": "string",
					"description": "The name of the event. E.g ClientAuctionRegistrationUpdated"
				},
				"source": {
					"type": "string",
					"description": "The source channel of client auction registration updated event."
				},
				"sourceTimeZone": {
					"type": "string",
					"description": "Source timezone of the client when auction registration updated was published."
				},
				"version": {
					"type": "string",
					"description": "Version number in format of V{n} for e.g V1, V2"
				},
				"sentAtUtc": {
					"type": "string",
					"description": "When event was sent by the publishers in ISO 8601."
				}
			},
			"required": [
				"occurredAtUtc",
				"typeName",
				"sentAtUtc",
				"version"
			]
		},
		"data": {
			"type": "object",
			"properties": {
				"auctionNumber": {
					"type": "string",
					"description": "The JDE Sale number of the auction."
				},
				"registrationId": {
					"type": "string",
					"description": "The registrationId for the auction registration."
				},
				"paddleNumber": {
					"type": "string",
					"description": "The unique paddle number for the auction."
				},
				"clientNumber": {
					"type": "string",
					"description": "COS number of the client for which registration has been made."
				},
				"submittedByClientNumber": {
					"type": "string",
					"description": "COS number of the logged-in client from which registration has been made."
				},
				"accountNumber": {
					"type": "string",
					"description": "The account number for which registration has been made."
				},
				"shippingType": {
					"type": "object",
                    "properties" : {
                    "shippingTypeId" : {
                      "type" : "string"
                    },
                    "shippingTypeDescription" : {
                      "type" : "string"
                    } 
                  },
					"description": "The shipping type which can be one of: 1 - CustomerCollection, 2- Standard, 3- WarehouseTransfer, 4- BondedWarehouseTransfer, 5- BondedShipping, 6- ArrangeBondedShipper"
				},
				"billingAddressNumber": {
					"type": "number",
					"description": "The billing / invoice address number selected for the registration."
				},
				"shippingAddressNumber": {
					"type": "number",
					"description": "The shipping address number selected for the registration."
				},
				"collect": {
					"type": "bool",
					"description": "True if shipping type is customer collection, warehouse transfer or arranged bonded shipper"
				},
				"inBond": {
					"type": "bool",
					"description": "The purchase option is in bond or not e.g true or false"
				},
				"registrationModifiedTimeUtc": {
					"type": "string",
					"description": "Date and time registration was modified e.g. 2022-02-10T14:30:00Z. (ISO8601 format in Zulu/UTC time)"
				},
				"registrationStatus": {
					"type": "string",
					"description": "The registration status e.g Active, Cancelled, Rejected, Denied, etc."
				},
				"collectionSiteAddressNumber": {
					"type": "number",
					"description": "Site address number for shipping types customer collection, warehouse transfer. This is not same as standard shipping, will be null if it's standard shipping."
				},
				"isWineAuction": {
					"type": "bool",
					"description": "Is wine auction e.g true or false."
				},
				"saleRoomCode": {
					"type": "string",
					"description": "The sale room code of the auction e.g NYC, CKS, PAR etc."
				}
			}
		}
	}
}