Jump to

• Request
• Response

Bill to Contacts associated with the subscription

get

/ccstore/v1/selfservice/subscriptions/{subscriptionNumber}/billToContacts

Retrieves all bill to contacts associated with the subscription of logged in profile in the currently authenticated session. If the profile is not logged in or is anonymous then the endpoint will fail. The endpoint will responds with same data what is received from corresponding subscription endpoint

Request

Supported Media Types

• application/json

Path Parameters

• subscriptionNumber(required): string
  The subscription number

Query Parameters

• finder: array
  Filter response fields
• limit: integer
  Specifies the number of bill to contacts to be retrieved starting from offset. Default value for the limit is 25 and max value is also 25.
• offset: integer
  Starting index when paging through contacts.
• orderBy: string
  The sort order
• q: string
  The query to use
• totalResults: boolean
  Calculate total results count

  Default Value: false

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response containing the list of bill to contacts associated with the subscription

Body ()

Root Schema : getSubscriptionBillToContacts_Response

Type: object

Show Source

• count: integer
  The number of resource instances returned in the current range.
• hasMore: boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If true, additional resources can be requested; default is false.
• items: array Items
  Title: Items

  The contact persons in the collection.
• limit: integer
  The actual paging size used by the server.
• offset: integer
  The offset value used in the current page.

{
    "type":"object",
    "properties":{
        "offset":{
            "description":"The offset value used in the current page.",
            "type":"integer"
        },
        "count":{
            "description":"The number of resource instances returned in the current range.",
            "type":"integer"
        },
        "hasMore":{
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If true, additional resources can be requested; default is false.",
            "type":"boolean"
        },
        "limit":{
            "description":"The actual paging size used by the server.",
            "type":"integer"
        },
        "items":{
            "description":"The contact persons in the collection.",
            "title":"Items",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PrimaryFlag":{
                        "description":"Indicates whether this contact is the primary contact.",
                        "title":"Primary Flag",
                        "type":"boolean"
                    },
                    "ContactPersonId":{
                        "description":"The unique party person identifier related to the contact.",
                        "title":"Contact Person Identifier",
                        "type":"integer"
                    },
                    "ContactNumber":{
                        "description":"The system-generated contact number.",
                        "title":"Contact Number",
                        "type":"string"
                    },
                    "ContactId":{
                        "description":"The unique identifier of the contact record.",
                        "title":"Contact Identifier",
                        "type":"integer"
                    },
                    "JobTitle":{
                        "description":"The job title of the contact person.",
                        "title":"Job Title",
                        "type":"string"
                    },
                    "EmailAddress":{
                        "description":"The contact???s email address.",
                        "title":"Email Address",
                        "type":[
                            "string",
                            "null"
                        ]
                    },
                    "Ordercol":{
                        "description":"The ordering or ranking column used for display.",
                        "title":"Order",
                        "type":"integer"
                    },
                    "Name":{
                        "description":"The full name of the contact person.",
                        "title":"Contact Name",
                        "type":"string"
                    }
                }
            }
        }
    },
    "example":{
        "offset":0,
        "count":4,
        "hasMore":false,
        "limit":25,
        "items":[
            {
                "PrimaryFlag":false,
                "ContactPersonId":2474,
                "ContactNumber":"CONTACT-1106",
                "ContactId":"300100656564641",
                "JobTitle":"CFO",
                "EmailAddress":null,
                "Ordercol":2,
                "Name":"Arnold Smithfield"
            },
            {
                "PrimaryFlag":false,
                "ContactPersonId":2485,
                "ContactNumber":"CONTACT-1012",
                "ContactId":"300100656559589",
                "JobTitle":"Accounts Payable Supervisor",
                "EmailAddress":null,
                "Ordercol":2,
                "Name":"Doug Weilem"
            },
            {
                "PrimaryFlag":true,
                "ContactPersonId":2450,
                "ContactNumber":"CONTACT-1013",
                "ContactId":"300100656559292",
                "JobTitle":"Buyer/Purchasing Agent",
                "EmailAddress":null,
                "Ordercol":1,
                "Name":"Gerry Brown"
            },
            {
                "PrimaryFlag":false,
                "ContactPersonId":2451,
                "ContactNumber":"CONTACT-1014",
                "ContactId":"300100656559381",
                "JobTitle":"Accounts Payable Supervisor",
                "EmailAddress":null,
                "Ordercol":1,
                "Name":"Michelle Sunrolley"
            }
        ]
    }
}

Example:

{
    "offset":0,
    "count":4,
    "hasMore":false,
    "limit":25,
    "items":[
        {
            "PrimaryFlag":false,
            "ContactPersonId":2474,
            "ContactNumber":"CONTACT-1106",
            "ContactId":"300100656564641",
            "JobTitle":"CFO",
            "EmailAddress":null,
            "Ordercol":2,
            "Name":"Arnold Smithfield"
        },
        {
            "PrimaryFlag":false,
            "ContactPersonId":2485,
            "ContactNumber":"CONTACT-1012",
            "ContactId":"300100656559589",
            "JobTitle":"Accounts Payable Supervisor",
            "EmailAddress":null,
            "Ordercol":2,
            "Name":"Doug Weilem"
        },
        {
            "PrimaryFlag":true,
            "ContactPersonId":2450,
            "ContactNumber":"CONTACT-1013",
            "ContactId":"300100656559292",
            "JobTitle":"Buyer/Purchasing Agent",
            "EmailAddress":null,
            "Ordercol":1,
            "Name":"Gerry Brown"
        },
        {
            "PrimaryFlag":false,
            "ContactPersonId":2451,
            "ContactNumber":"CONTACT-1014",
            "ContactId":"300100656559381",
            "JobTitle":"Accounts Payable Supervisor",
            "EmailAddress":null,
            "Ordercol":1,
            "Name":"Michelle Sunrolley"
        }
    ]
}

Nested Schema : Items

Type: array

Title: Items

The contact persons in the collection.

Show Source

• Array of: object items

{
    "description":"The contact persons in the collection.",
    "title":"Items",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PrimaryFlag":{
                "description":"Indicates whether this contact is the primary contact.",
                "title":"Primary Flag",
                "type":"boolean"
            },
            "ContactPersonId":{
                "description":"The unique party person identifier related to the contact.",
                "title":"Contact Person Identifier",
                "type":"integer"
            },
            "ContactNumber":{
                "description":"The system-generated contact number.",
                "title":"Contact Number",
                "type":"string"
            },
            "ContactId":{
                "description":"The unique identifier of the contact record.",
                "title":"Contact Identifier",
                "type":"integer"
            },
            "JobTitle":{
                "description":"The job title of the contact person.",
                "title":"Job Title",
                "type":"string"
            },
            "EmailAddress":{
                "description":"The contact???s email address.",
                "title":"Email Address",
                "type":[
                    "string",
                    "null"
                ]
            },
            "Ordercol":{
                "description":"The ordering or ranking column used for display.",
                "title":"Order",
                "type":"integer"
            },
            "Name":{
                "description":"The full name of the contact person.",
                "title":"Contact Name",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• ContactId: integer
  Title: Contact Identifier

  The unique identifier of the contact record.
• ContactNumber: string
  Title: Contact Number

  The system-generated contact number.
• ContactPersonId: integer
  Title: Contact Person Identifier

  The unique party person identifier related to the contact.
• EmailAddress: [ "string", "null" ]
  Title: Email Address

  The contact???s email address.
• JobTitle: string
  Title: Job Title

  The job title of the contact person.
• Name: string
  Title: Contact Name

  The full name of the contact person.
• Ordercol: integer
  Title: Order

  The ordering or ranking column used for display.
• PrimaryFlag: boolean
  Title: Primary Flag

  Indicates whether this contact is the primary contact.

{
    "type":"object",
    "properties":{
        "PrimaryFlag":{
            "description":"Indicates whether this contact is the primary contact.",
            "title":"Primary Flag",
            "type":"boolean"
        },
        "ContactPersonId":{
            "description":"The unique party person identifier related to the contact.",
            "title":"Contact Person Identifier",
            "type":"integer"
        },
        "ContactNumber":{
            "description":"The system-generated contact number.",
            "title":"Contact Number",
            "type":"string"
        },
        "ContactId":{
            "description":"The unique identifier of the contact record.",
            "title":"Contact Identifier",
            "type":"integer"
        },
        "JobTitle":{
            "description":"The job title of the contact person.",
            "title":"Job Title",
            "type":"string"
        },
        "EmailAddress":{
            "description":"The contact???s email address.",
            "title":"Email Address",
            "type":[
                "string",
                "null"
            ]
        },
        "Ordercol":{
            "description":"The ordering or ranking column used for display.",
            "title":"Order",
            "type":"integer"
        },
        "Name":{
            "description":"The full name of the contact person.",
            "title":"Contact Name",
            "type":"string"
        }
    }
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |59000|If there is a missing required property.| |59002|If request can't be processed currently.| |59003|If there is any invalid path parameter| |59004|If resource is not found| |59005|If error occurred while processing input.| |59008|If any issue occurred while triggering the fusion.| |59010|If self service is not enabled|

Body ()

Root Schema : Error

Type: object

Show Source

• errorCode: string
  The numerical code identifying the error
• message: string
• moreInfo: string
  An optional non-localized message with more information
• status: string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top