Jump to

• Request
• Response

v1.0

put

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/tracking

Updates tracking details for an order shipment. Rights: OrsInventoryPost, OrsUnblinded.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• shipmentId(required): string(uuid)
  ID of the shipment.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

Supported Media Types

• */*

Request Body - */* ()

Root Schema : Shipment Tracking Details Request

Type: object

Title: Shipment Tracking Details Request

Shipment Tracking Details parameters.

Show Source

• shipmentId: string (uuid)
  ID of the shipment.
• trackingNumber: string
  Minimum Length: 0

  Maximum Length: 50

  Shipment tracking number.

  Example: 12345
• trackingNumberUrl: string (uri)
  Minimum Length: 0

  Maximum Length: 2048

  Pattern: ^$|^(https?)://.+$

  URL for tracking the shipment.

  Example: http://www.site.com

{
    "title":"Shipment Tracking Details Request",
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"ID of the shipment.",
            "format":"uuid"
        },
        "trackingNumber":{
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Shipment tracking number.",
            "example":"12345"
        },
        "trackingNumberUrl":{
            "maxLength":2048,
            "minLength":0,
            "pattern":"^$|^(https?)://.+$",
            "type":"string",
            "description":"URL for tracking the shipment.",
            "format":"uri",
            "example":"http://www.site.com"
        }
    },
    "description":"Shipment Tracking Details parameters."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: string(uuid)

Examples

Select an example Update Tracking Details Response

404 Response

'Invalid study ID', 'Study still in design phase' or 'Invalid shipment ID'

Body ()

Root Schema : DesignerResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Examples

Select an example Not Found

500 Response

Internal server error

Body ()

Root Schema : DesignerResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Examples

Select an example Server Error

Back to Top