Jump to

• Request
• Response

Get ship methods

post

/fscmRestApi/msp/latest/globalOrderPromises/getShipMethods

Get ship methods

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CallingInstance: string
  Value that identifies the source application from which the order promising service request originated.
• CallingModule: string
  Value that identifies the module from which the order promising service request originated.
• CustomerInfoList: array CustomerInfoList
  Values that identify the customer details.
• RequestCreationDate: string (date-time)
  Date and time when the shipping method request was created.
• RequestTimeZone: string
  Time zone from which the ship method request originated.

{
    "type":"object",
    "properties":{
        "CallingModule":{
            "type":"string",
            "description":"Value that identifies the module from which the order promising service request originated."
        },
        "CallingInstance":{
            "type":"string",
            "description":"Value that identifies the source application from which the order promising service request originated."
        },
        "RequestCreationDate":{
            "type":"string",
            "description":"Date and time when the shipping method request was created.",
            "format":"date-time"
        },
        "RequestTimeZone":{
            "type":"string",
            "description":"Time zone from which the ship method request originated."
        },
        "CustomerInfoList":{
            "type":"array",
            "description":"Values that identify the customer details.",
            "items":{
                "$ref":"#/components/schemas/CustomerInfo"
            }
        }
    }
}

Nested Schema : CustomerInfoList

Type: array

Values that identify the customer details.

Show Source

• Array of: object CustomerInfo

{
    "type":"array",
    "description":"Values that identify the customer details.",
    "items":{
        "$ref":"#/components/schemas/CustomerInfo"
    }
}

Nested Schema : CustomerInfo

Type: object

Show Source

• CustomerIdentifier: string
  Value that uniquely identifies the customer.
• CustomerSiteIdentifier: string
  Value that uniquely identifies the customer ship-to site.
• InternalSalesOrderDestOrg: object OrgInfo
• OrgInfoList: array OrgInfoList
  Values that represent the attributes of the organization.
• PartyIdentifier: string
  Value that uniquely identifies the customer name.
• PartySiteIdentifier: string
  Value that uniquely identifies the party site corresponding to the customer ship-to site.
• Region: string
  Code of the region the customer ship-to site belongs to.
• SupplierInfoList: array SupplierInfoList
  Values that indicate the details of the drop ship supplier.

{
    "type":"object",
    "properties":{
        "CustomerIdentifier":{
            "type":"string",
            "description":"Value that uniquely identifies the customer."
        },
        "CustomerSiteIdentifier":{
            "type":"string",
            "description":"Value that uniquely identifies the customer ship-to site."
        },
        "Region":{
            "type":"string",
            "description":"Code of the region the customer ship-to site belongs to."
        },
        "PartyIdentifier":{
            "type":"string",
            "description":"Value that uniquely identifies the customer name."
        },
        "PartySiteIdentifier":{
            "type":"string",
            "description":"Value that uniquely identifies the party site corresponding to the customer ship-to site."
        },
        "OrgInfoList":{
            "type":"array",
            "description":"Values that represent the attributes of the organization.",
            "items":{
                "$ref":"#/components/schemas/OrgInfo"
            }
        },
        "SupplierInfoList":{
            "type":"array",
            "description":"Values that indicate the details of the drop ship supplier.",
            "items":{
                "$ref":"#/components/schemas/SupplierInfo"
            }
        },
        "InternalSalesOrderDestOrg":{
            "$ref":"#/components/schemas/OrgInfo"
        }
    }
}

Nested Schema : OrgInfo

Type: object

Show Source

• InstanceNumber: string
  Number that identifies the source application from which the order promising service request originated.
• OrgIdentifier: string
  Value that uniquely identifies the organization associated with the item.

{
    "type":"object",
    "properties":{
        "InstanceNumber":{
            "type":"string",
            "description":"Number that identifies the source application from which the order promising service request originated."
        },
        "OrgIdentifier":{
            "type":"string",
            "description":"Value that uniquely identifies the organization associated with the item."
        }
    }
}

Nested Schema : OrgInfoList

Type: array

Values that represent the attributes of the organization.

Show Source

• Array of: object OrgInfo

{
    "type":"array",
    "description":"Values that represent the attributes of the organization.",
    "items":{
        "$ref":"#/components/schemas/OrgInfo"
    }
}

Nested Schema : SupplierInfoList

Type: array

Values that indicate the details of the drop ship supplier.

Show Source

• Array of: object SupplierInfo

{
    "type":"array",
    "description":"Values that indicate the details of the drop ship supplier.",
    "items":{
        "$ref":"#/components/schemas/SupplierInfo"
    }
}

Nested Schema : SupplierInfo

Type: object

Show Source

• Supplier: string
  Name of the drop ship supplier that ships items directly to the customer.
• SupplierSite: string
  Name of the drop ship supplier site that ships items directly to the customer.

{
    "type":"object",
    "properties":{
        "Supplier":{
            "type":"string",
            "description":"Name of the drop ship supplier that ships items directly to the customer."
        },
        "SupplierSite":{
            "type":"string",
            "description":"Name of the drop ship supplier site that ships items directly to the customer."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Result of processing the request, which includes the expected ship date, expected arrival date, expected ship from warehouse, and expected ship method.

Body ()

Root Schema : GetShipMethodsOutput

Type: object

Show Source

• ErrorCode: string
  Abbreviation that identifies the error, if any, returned by Oracle Global Order Promising Cloud for the GetShipMethods request.
• PromiseDateTime: string (date-time)
  Date and time when the promise is generated by the order promising application.
• PromisingInstance: string
  Value that uniquely identifies the source application in which order promising is performed.
• PromisingSystem: string
  Value that identifies the order promising application that generated the list of ship methods available between a pair of origin and destination.
• ShipMethodList: array ShipMethodList
  Values that identify the shipping method between the ship-from organization to the customer ship-to site or destination organization. This is a concatenation of carrier, transport mode, and service level.

{
    "type":"object",
    "properties":{
        "PromisingSystem":{
            "type":"string",
            "description":"Value that identifies the order promising application that generated the list of ship methods available between a pair of origin and destination."
        },
        "PromisingInstance":{
            "type":"string",
            "description":"Value that uniquely identifies the source application in which order promising is performed."
        },
        "PromiseDateTime":{
            "type":"string",
            "description":"Date and time when the promise is generated by the order promising application.",
            "format":"date-time"
        },
        "ErrorCode":{
            "type":"string",
            "description":"Abbreviation that identifies the error, if any, returned by Oracle Global Order Promising Cloud for the GetShipMethods request."
        },
        "ShipMethodList":{
            "type":"array",
            "description":"Values that identify the shipping method between the ship-from organization to the customer ship-to site or destination organization. This is a concatenation of carrier, transport mode, and service level.",
            "items":{
                "$ref":"#/components/schemas/ShipMethod"
            }
        }
    }
}

Nested Schema : ShipMethodList

Type: array

Values that identify the shipping method between the ship-from organization to the customer ship-to site or destination organization. This is a concatenation of carrier, transport mode, and service level.

Show Source

• Array of: object ShipMethod

{
    "type":"array",
    "description":"Values that identify the shipping method between the ship-from organization to the customer ship-to site or destination organization. This is a concatenation of carrier, transport mode, and service level.",
    "items":{
        "$ref":"#/components/schemas/ShipMethod"
    }
}

Nested Schema : ShipMethod

Type: object

Show Source

• Carrier: string
  Code that identifies the carrier between the ship-from organization to the customer ship-to site.
• Mode: string
  Requested mode of transport to be used for shipping from the origin to the destination.
• ServiceLevel: string
  Code that identifies the desired service level from the ship-from organization to the customer ship-to site.

{
    "type":"object",
    "properties":{
        "Carrier":{
            "type":"string",
            "description":"Code that identifies the carrier between the ship-from organization to the customer ship-to site."
        },
        "ServiceLevel":{
            "type":"string",
            "description":"Code that identifies the desired service level from the ship-from organization to the customer ship-to site."
        },
        "Mode":{
            "type":"string",
            "description":"Requested mode of transport to be used for shipping from the origin to the destination."
        }
    }
}

Back to Top