Jump to

• Request
• Response

Ship to Contacts associated with the subscription

get

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

Retrieves all ship 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 ship 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 ship to contacts associated with the subscription

Body ()

Root Schema : getSubscriptionShipToContacts_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 external contacts in the collection.
• limit: integer
  The actual paging size used by the server.
• links: array links
  HATEOAS-style links related to the current resource.
• offset: integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "type":"object",
    "properties":{
        "totalResults":{
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included.",
            "type":"integer"
        },
        "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"
        },
        "links":{
            "description":"HATEOAS-style links related to the current resource.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "kind":{
                        "description":"The kind of resource (for example, collection or item).",
                        "type":"string"
                    },
                    "rel":{
                        "description":"The relation type of the link.",
                        "type":"string"
                    },
                    "name":{
                        "description":"The name of the linked resource.",
                        "type":"string"
                    },
                    "href":{
                        "description":"The target URL of the link.",
                        "type":"string"
                    }
                }
            }
        },
        "items":{
            "description":"The external contacts in the collection.",
            "title":"Items",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "Status":{
                        "description":"The status of the contact (for example, A=Active, I=Inactive).",
                        "title":"Status",
                        "type":"string"
                    },
                    "PartyId1_1":{
                        "description":"Additional party identifier.",
                        "title":"Party Identifier 1_1",
                        "type":"integer"
                    },
                    "RelationshipRecId":{
                        "description":"The identifier of the relationship record.",
                        "title":"Relationship Record Id",
                        "type":"integer"
                    },
                    "ContactId":{
                        "description":"The unique identifier of the contact.",
                        "title":"Contact Identifier",
                        "type":"integer"
                    },
                    "PartyId2":{
                        "description":"The related party identifier.",
                        "title":"Party Identifier 2",
                        "type":"integer"
                    },
                    "PartyName1":{
                        "description":"The name of the related party.",
                        "title":"Party Name",
                        "type":"string"
                    },
                    "PartyId1":{
                        "description":"The primary party identifier.",
                        "title":"Party Identifier 1",
                        "type":"integer"
                    },
                    "JobTitle":{
                        "description":"The contact???s job title.",
                        "title":"Job Title",
                        "type":[
                            "string",
                            "null"
                        ]
                    },
                    "EmailAddress":{
                        "description":"The contact???s email address.",
                        "title":"Email Address",
                        "type":[
                            "string",
                            "null"
                        ]
                    },
                    "OrgContactId":{
                        "description":"The identifier of the organizational contact.",
                        "title":"Organization Contact Id",
                        "type":"integer"
                    },
                    "Department":{
                        "description":"The department of the contact.",
                        "title":"Department",
                        "type":[
                            "string",
                            "null"
                        ]
                    },
                    "DirectionalFlag":{
                        "description":"Indicates whether the relationship is directional.",
                        "title":"Directional Flag",
                        "type":"boolean"
                    },
                    "ContactPointId":{
                        "description":"The identifier of the contact point record.",
                        "title":"Contact Point Id",
                        "type":[
                            "integer",
                            "null"
                        ]
                    },
                    "ContactNumber":{
                        "description":"The system-generated contact number or identifier.",
                        "title":"Contact Number",
                        "type":"string"
                    },
                    "ContactPointType":{
                        "description":"The type of contact point (for example, EMAIL).",
                        "title":"Contact Point Type",
                        "type":[
                            "string",
                            "null"
                        ]
                    },
                    "ContactName":{
                        "description":"The full name of the contact.",
                        "title":"Contact Name",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The external contacts in the collection.

Show Source

• Array of: object items

{
    "description":"The external contacts in the collection.",
    "title":"Items",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "Status":{
                "description":"The status of the contact (for example, A=Active, I=Inactive).",
                "title":"Status",
                "type":"string"
            },
            "PartyId1_1":{
                "description":"Additional party identifier.",
                "title":"Party Identifier 1_1",
                "type":"integer"
            },
            "RelationshipRecId":{
                "description":"The identifier of the relationship record.",
                "title":"Relationship Record Id",
                "type":"integer"
            },
            "ContactId":{
                "description":"The unique identifier of the contact.",
                "title":"Contact Identifier",
                "type":"integer"
            },
            "PartyId2":{
                "description":"The related party identifier.",
                "title":"Party Identifier 2",
                "type":"integer"
            },
            "PartyName1":{
                "description":"The name of the related party.",
                "title":"Party Name",
                "type":"string"
            },
            "PartyId1":{
                "description":"The primary party identifier.",
                "title":"Party Identifier 1",
                "type":"integer"
            },
            "JobTitle":{
                "description":"The contact???s job title.",
                "title":"Job Title",
                "type":[
                    "string",
                    "null"
                ]
            },
            "EmailAddress":{
                "description":"The contact???s email address.",
                "title":"Email Address",
                "type":[
                    "string",
                    "null"
                ]
            },
            "OrgContactId":{
                "description":"The identifier of the organizational contact.",
                "title":"Organization Contact Id",
                "type":"integer"
            },
            "Department":{
                "description":"The department of the contact.",
                "title":"Department",
                "type":[
                    "string",
                    "null"
                ]
            },
            "DirectionalFlag":{
                "description":"Indicates whether the relationship is directional.",
                "title":"Directional Flag",
                "type":"boolean"
            },
            "ContactPointId":{
                "description":"The identifier of the contact point record.",
                "title":"Contact Point Id",
                "type":[
                    "integer",
                    "null"
                ]
            },
            "ContactNumber":{
                "description":"The system-generated contact number or identifier.",
                "title":"Contact Number",
                "type":"string"
            },
            "ContactPointType":{
                "description":"The type of contact point (for example, EMAIL).",
                "title":"Contact Point Type",
                "type":[
                    "string",
                    "null"
                ]
            },
            "ContactName":{
                "description":"The full name of the contact.",
                "title":"Contact Name",
                "type":"string"
            }
        }
    }
}

Nested Schema : links

Type: array

HATEOAS-style links related to the current resource.

Show Source

• Array of: object items

{
    "description":"HATEOAS-style links related to the current resource.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "kind":{
                "description":"The kind of resource (for example, collection or item).",
                "type":"string"
            },
            "rel":{
                "description":"The relation type of the link.",
                "type":"string"
            },
            "name":{
                "description":"The name of the linked resource.",
                "type":"string"
            },
            "href":{
                "description":"The target URL of the link.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• ContactId: integer
  Title: Contact Identifier

  The unique identifier of the contact.
• ContactName: string
  Title: Contact Name

  The full name of the contact.
• ContactNumber: string
  Title: Contact Number

  The system-generated contact number or identifier.
• ContactPointId: [ "integer", "null" ]
  Title: Contact Point Id

  The identifier of the contact point record.
• ContactPointType: [ "string", "null" ]
  Title: Contact Point Type

  The type of contact point (for example, EMAIL).
• Department: [ "string", "null" ]
  Title: Department

  The department of the contact.
• DirectionalFlag: boolean
  Title: Directional Flag

  Indicates whether the relationship is directional.
• EmailAddress: [ "string", "null" ]
  Title: Email Address

  The contact???s email address.
• JobTitle: [ "string", "null" ]
  Title: Job Title

  The contact???s job title.
• OrgContactId: integer
  Title: Organization Contact Id

  The identifier of the organizational contact.
• PartyId1: integer
  Title: Party Identifier 1

  The primary party identifier.
• PartyId1_1: integer
  Title: Party Identifier 1_1

  Additional party identifier.
• PartyId2: integer
  Title: Party Identifier 2

  The related party identifier.
• PartyName1: string
  Title: Party Name

  The name of the related party.
• RelationshipRecId: integer
  Title: Relationship Record Id

  The identifier of the relationship record.
• Status: string
  Title: Status

  The status of the contact (for example, A=Active, I=Inactive).

{
    "type":"object",
    "properties":{
        "Status":{
            "description":"The status of the contact (for example, A=Active, I=Inactive).",
            "title":"Status",
            "type":"string"
        },
        "PartyId1_1":{
            "description":"Additional party identifier.",
            "title":"Party Identifier 1_1",
            "type":"integer"
        },
        "RelationshipRecId":{
            "description":"The identifier of the relationship record.",
            "title":"Relationship Record Id",
            "type":"integer"
        },
        "ContactId":{
            "description":"The unique identifier of the contact.",
            "title":"Contact Identifier",
            "type":"integer"
        },
        "PartyId2":{
            "description":"The related party identifier.",
            "title":"Party Identifier 2",
            "type":"integer"
        },
        "PartyName1":{
            "description":"The name of the related party.",
            "title":"Party Name",
            "type":"string"
        },
        "PartyId1":{
            "description":"The primary party identifier.",
            "title":"Party Identifier 1",
            "type":"integer"
        },
        "JobTitle":{
            "description":"The contact???s job title.",
            "title":"Job Title",
            "type":[
                "string",
                "null"
            ]
        },
        "EmailAddress":{
            "description":"The contact???s email address.",
            "title":"Email Address",
            "type":[
                "string",
                "null"
            ]
        },
        "OrgContactId":{
            "description":"The identifier of the organizational contact.",
            "title":"Organization Contact Id",
            "type":"integer"
        },
        "Department":{
            "description":"The department of the contact.",
            "title":"Department",
            "type":[
                "string",
                "null"
            ]
        },
        "DirectionalFlag":{
            "description":"Indicates whether the relationship is directional.",
            "title":"Directional Flag",
            "type":"boolean"
        },
        "ContactPointId":{
            "description":"The identifier of the contact point record.",
            "title":"Contact Point Id",
            "type":[
                "integer",
                "null"
            ]
        },
        "ContactNumber":{
            "description":"The system-generated contact number or identifier.",
            "title":"Contact Number",
            "type":"string"
        },
        "ContactPointType":{
            "description":"The type of contact point (for example, EMAIL).",
            "title":"Contact Point Type",
            "type":[
                "string",
                "null"
            ]
        },
        "ContactName":{
            "description":"The full name of the contact.",
            "title":"Contact Name",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• href: string
  The target URL of the link.
• kind: string
  The kind of resource (for example, collection or item).
• name: string
  The name of the linked resource.
• rel: string
  The relation type of the link.

{
    "type":"object",
    "properties":{
        "kind":{
            "description":"The kind of resource (for example, collection or item).",
            "type":"string"
        },
        "rel":{
            "description":"The relation type of the link.",
            "type":"string"
        },
        "name":{
            "description":"The name of the linked resource.",
            "type":"string"
        },
        "href":{
            "description":"The target URL of the link.",
            "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