Jump to

• Request
• Response

Create a Profit

post

/shippingAgentContacts/{shippingAgentContactGid}/profits

Request

Path Parameters

• shippingAgentContactGid(required): string
  Resource ID

Supported Media Types

• application/vnd.oracle.resource+json;type=singular
• application/vnd.oracle.resource+json;type=collection

Request Body - application/vnd.oracle.resource+json;type=collection ()

Root Schema : schema

Type: object

Show Source

• items(required): array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shippingAgentContacts.profits"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shippingAgentContacts.profits"
    }
}

Nested Schema : schema

Type: object

Show Source

• consigneeLocationProfileGid: string
  No description.
• consolTypeProfileGid: string
  No description.
• domainName: string
  No description.
• jobType: string
  No description.
• links: array links
  Read Only: true
• primaryLegModeProfileGid: string
  No description.
• profitSplitAmt: profitSplitAmt
  No description.
• profitSplitPercentage: number (double)
  No description.
• shipperLocationProfileGid: string
  No description.
• shippingAgentContProfitGid: string
  No description.
• shippingAgentContProfitXid: string
  No description.

{
    "properties":{
        "shippingAgentContProfitGid":{
            "description":"No description.",
            "type":"string"
        },
        "shippingAgentContProfitXid":{
            "description":"No description.",
            "type":"string"
        },
        "primaryLegModeProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "jobType":{
            "description":"No description.",
            "type":"string"
        },
        "shipperLocationProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "consigneeLocationProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "profitSplitPercentage":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "profitSplitAmt":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "consolTypeProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : profitSplitAmt

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : currencyType

Type: object

Show Source

• currency: string
  ISO 4217 currency code
• value: number
  Numeric value that specifies a currency

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies a currency",
            "type":"number"
        },
        "currency":{
            "description":"ISO 4217 currency code",
            "type":"string"
        }
    }
}

Request Body - application/vnd.oracle.resource+json;type=singular ()

Root Schema : schema

Type: object

Show Source

• consigneeLocationProfileGid: string
  No description.
• consolTypeProfileGid: string
  No description.
• domainName: string
  No description.
• jobType: string
  No description.
• links: array links
  Read Only: true
• primaryLegModeProfileGid: string
  No description.
• profitSplitAmt: profitSplitAmt
  No description.
• profitSplitPercentage: number (double)
  No description.
• shipperLocationProfileGid: string
  No description.
• shippingAgentContProfitGid: string
  No description.
• shippingAgentContProfitXid: string
  No description.

{
    "properties":{
        "shippingAgentContProfitGid":{
            "description":"No description.",
            "type":"string"
        },
        "shippingAgentContProfitXid":{
            "description":"No description.",
            "type":"string"
        },
        "primaryLegModeProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "jobType":{
            "description":"No description.",
            "type":"string"
        },
        "shipperLocationProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "consigneeLocationProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "profitSplitPercentage":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "profitSplitAmt":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "consolTypeProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : profitSplitAmt

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : currencyType

Type: object

Show Source

• currency: string
  ISO 4217 currency code
• value: number
  Numeric value that specifies a currency

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies a currency",
            "type":"number"
        },
        "currency":{
            "description":"ISO 4217 currency code",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=singular
• application/vnd.oracle.resource+json;type=collection

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• consigneeLocationProfileGid: string
  No description.
• consolTypeProfileGid: string
  No description.
• domainName: string
  No description.
• jobType: string
  No description.
• links: array links
  Read Only: true
• primaryLegModeProfileGid: string
  No description.
• profitSplitAmt: profitSplitAmt
  No description.
• profitSplitPercentage: number (double)
  No description.
• shipperLocationProfileGid: string
  No description.
• shippingAgentContProfitGid: string
  No description.
• shippingAgentContProfitXid: string
  No description.

{
    "properties":{
        "shippingAgentContProfitGid":{
            "description":"No description.",
            "type":"string"
        },
        "shippingAgentContProfitXid":{
            "description":"No description.",
            "type":"string"
        },
        "primaryLegModeProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "jobType":{
            "description":"No description.",
            "type":"string"
        },
        "shipperLocationProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "consigneeLocationProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "profitSplitPercentage":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "profitSplitAmt":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "consolTypeProfileGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : profitSplitAmt

No description.

Match All

No description.

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : currencyType

Type: object

Show Source

• currency: string
  ISO 4217 currency code
• value: number
  Numeric value that specifies a currency

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies a currency",
            "type":"number"
        },
        "currency":{
            "description":"ISO 4217 currency code",
            "type":"string"
        }
    }
}

Back to Top