Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 3 Next »

This endpoint is used to create new address by passing JSON request payload.

Resource URL

https://api.bbamastro.com.au/address 🔗

Parameters

Type

Name

Description

Schema

Body

address

optional

Address request payload

AddressPayload

Responses

HTTP Code

Description

Schema

200

OK

AddressPublicProjection

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content


Definitions

mykey

Type: apiKey

Name: Authorization

In: HEADER

AddressPayload

Name

Description

Schema

addressLine1

optional

Address line 1

string

addressLine2

optional

Address line 2

string

company

optional

Address company name

string

customerCarrierAccountCode

optional

Customer carrier account code

string

email

optional

Address email

string

firstName

optional

Address first name

string

lastName

optional

Address last name

string

location

optional

Location identifier

integer (int64)

notes

optional

Address notes

string

phone

optional

Address phone number

string

senderCode

optional

Sender code

string

AddressPublicProjection

Name

Description

Schema

addressLine1

optional

Address line 1

string

addressLine2

optional

Address line 2

string

company

optional

Address company name

string

customerCarrierAccountCode

optional

Customer carrier account code

string

email

optional

Address email

string

firstName

optional

Address first name

string

id

optional

Address identifier

integer (int64)

lastName

optional

Address last name

string

latitude

optional

Address latitude

number (double)

location

optional

Location identifier

Location

longitude

optional

Address longitude

number (double)

notes

optional

Address notes

string

phone

optional

Address phone number

string

Please refer to the Additional Reference section for more information on BBA Integration API objects.

  • No labels