XM
Members
Retrieve Billing by Bill-to ID
This documentation is now outdated, please find the latest docs for this endpoint here
Path:
1
GET https://{baseurl}/api-cart/bill-to/{billTo-ID}
Copied!
Through this endpoint, your customer's can retrieve their billing details, easily, based on the specified BilltoID.

Headers

Content-Type : application/json
x-site-context : { "date": "2020-08-28T02:35:27.787Z", "channel": 12, "account": 5f493c9f30ec2a0007a94fc8", "stage": "sandbox" }

Parameters

Type : path
Name : The 24 character system-generated bill-to ID (from the Add Billing API).
Required: true

Sample Request

1
GET https://{baseurl}/api-cart/bill-to/60803ab6880a2e0009bc5250
Copied!

Sampple Response

Response Code: 200
Message: OK
Description: You will see this message when the billing details are successfully retrieved for the specified bill-to ID.
1
{
2
"_id": "60803ab6880a2e0009bc5250",
3
"address": {
4
"phone": {
5
"number": "123-992-9404",
6
"kind": "Mobile"
7
},
8
"name": {
9
"first": "John",
10
"last": "Demo"
11
},
12
"street1": "10400 NE 4th St ",
13
"city": "Bellevue",
14
"state": "WA",
15
"country": "United States",
16
"zipCode": "98004",
17
"kind": "shipping",
18
"email": "[email protected]"
19
},
20
"paymentMethod": "VISA",
21
"cardIdentifier": "4242",
22
"amount": 24,
23
"billToId": 345,
24
"cart": "5f8f0da2d4cc8e00084b9e8e",
25
"createdAt": "2021-04-21T14:46:14.676Z",
26
"updatedAt": "2021-04-21T14:46:14.676Z",
27
"__v": 0
28
}
Copied!
Error Code: 404
Message: Not found
Description: You will see this error when the specified bill-to ID is not found or doesn't exist in the system.
1
{
2
"code": "BILLTO_NOT_FOUND",
3
"message": "Bill-to not found."
4
}
Copied!
Error Code: 500
Message: Internal Server Error
Description: You will see this error when the account number is incorrect in the x-site-context (for a multi-tenent client).

Change Log

  • June - 2021
  • July - 2020 First updated
Last modified 1mo ago
Copy link
Contents
Change Log