POST api/pickupOrder/ChangePickorderStatus

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PickUpID	integer	None.
newStatusID	integer	None.
UserID	integer	None.
ActionID	PickupActionEnum	None.
ReasonId	integer	None.
PackageIdentifiers	Collection of string	None.
Images	Collection of MobileImage	None.
ChangesDate	date	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "PickUpID": 1,
    "newStatusID": 1,
    "UserID": 2,
    "ActionID": 1,
    "ReasonId": 3,
    "PackageIdentifiers": [
      "sample string 1",
      "sample string 2"
    ],
    "Images": [
      {
        "DocumentRawData": "QEA=",
        "DocumentName": "sample string 1",
        "DocumentId": 1
      },
      {
        "DocumentRawData": "QEA=",
        "DocumentName": "sample string 1",
        "DocumentId": 1
      }
    ],
    "ChangesDate": "2026-03-29T22:00:45.1470515+02:00"
  },
  {
    "PickUpID": 1,
    "newStatusID": 1,
    "UserID": 2,
    "ActionID": 1,
    "ReasonId": 3,
    "PackageIdentifiers": [
      "sample string 1",
      "sample string 2"
    ],
    "Images": [
      {
        "DocumentRawData": "QEA=",
        "DocumentName": "sample string 1",
        "DocumentId": 1
      },
      {
        "DocumentRawData": "QEA=",
        "DocumentName": "sample string 1",
        "DocumentId": 1
      }
    ],
    "ChangesDate": "2026-03-29T22:00:45.1470515+02:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfChangePickupStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MYLERZ.Base.Search.Mobile">
  <ChangePickupStatusRequest>
    <ActionID>Start</ActionID>
    <ChangesDate>2026-03-29T22:00:45.1470515+02:00</ChangesDate>
    <Images xmlns:d3p1="http://schemas.datacontract.org/2004/07/MYLERZ.Base.DTO.MobileDTO">
      <d3p1:MobileImage>
        <d3p1:DocumentId>1</d3p1:DocumentId>
        <d3p1:DocumentName>sample string 1</d3p1:DocumentName>
        <d3p1:DocumentRawData>QEA=</d3p1:DocumentRawData>
      </d3p1:MobileImage>
      <d3p1:MobileImage>
        <d3p1:DocumentId>1</d3p1:DocumentId>
        <d3p1:DocumentName>sample string 1</d3p1:DocumentName>
        <d3p1:DocumentRawData>QEA=</d3p1:DocumentRawData>
      </d3p1:MobileImage>
    </Images>
    <PackageIdentifiers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </PackageIdentifiers>
    <PickUpID>1</PickUpID>
    <ReasonId>3</ReasonId>
    <UserID>2</UserID>
    <newStatusID>1</newStatusID>
  </ChangePickupStatusRequest>
  <ChangePickupStatusRequest>
    <ActionID>Start</ActionID>
    <ChangesDate>2026-03-29T22:00:45.1470515+02:00</ChangesDate>
    <Images xmlns:d3p1="http://schemas.datacontract.org/2004/07/MYLERZ.Base.DTO.MobileDTO">
      <d3p1:MobileImage>
        <d3p1:DocumentId>1</d3p1:DocumentId>
        <d3p1:DocumentName>sample string 1</d3p1:DocumentName>
        <d3p1:DocumentRawData>QEA=</d3p1:DocumentRawData>
      </d3p1:MobileImage>
      <d3p1:MobileImage>
        <d3p1:DocumentId>1</d3p1:DocumentId>
        <d3p1:DocumentName>sample string 1</d3p1:DocumentName>
        <d3p1:DocumentRawData>QEA=</d3p1:DocumentRawData>
      </d3p1:MobileImage>
    </Images>
    <PackageIdentifiers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </PackageIdentifiers>
    <PickUpID>1</PickUpID>
    <ReasonId>3</ReasonId>
    <UserID>2</UserID>
    <newStatusID>1</newStatusID>
  </ChangePickupStatusRequest>
</ArrayOfChangePickupStatusRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DescriptiveResponseOfChangeStatusResultDTO

Name	Type	Additional information
Value	ChangeStatusResultDTO	None.
CoreValue	string	None.
IsErrorState	boolean	None.
ErrorDescription	string	None.
ErrorMetadata	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Value": {
    "CurrentStatus": {
      "ISDefault": true,
      "EndOfFlow": true,
      "ColorCode": "sample string 1",
      "PhaseID": 1,
      "PhaseEnName": "sample string 2",
      "PhaseArName": "sample string 3",
      "NeedDate": true,
      "HasPODCode": true,
      "NeedReason": true,
      "NeedServiceCategory": true,
      "ReasonCategoryIds": [
        1,
        2
      ],
      "AssignMyler": true,
      "CallSMSCount": 9,
      "PickupNumber": "sample string 10",
      "Id": 11,
      "Code": "sample string 12",
      "ArName": "sample string 13",
      "EnName": "sample string 14"
    },
    "NextStatuses": [
      {
        "ISDefault": true,
        "EndOfFlow": true,
        "ColorCode": "sample string 1",
        "PhaseID": 1,
        "PhaseEnName": "sample string 2",
        "PhaseArName": "sample string 3",
        "NeedDate": true,
        "HasPODCode": true,
        "NeedReason": true,
        "NeedServiceCategory": true,
        "ReasonCategoryIds": [
          1,
          2
        ],
        "AssignMyler": true,
        "CallSMSCount": 9,
        "PickupNumber": "sample string 10",
        "Id": 11,
        "Code": "sample string 12",
        "ArName": "sample string 13",
        "EnName": "sample string 14"
      },
      {
        "ISDefault": true,
        "EndOfFlow": true,
        "ColorCode": "sample string 1",
        "PhaseID": 1,
        "PhaseEnName": "sample string 2",
        "PhaseArName": "sample string 3",
        "NeedDate": true,
        "HasPODCode": true,
        "NeedReason": true,
        "NeedServiceCategory": true,
        "ReasonCategoryIds": [
          1,
          2
        ],
        "AssignMyler": true,
        "CallSMSCount": 9,
        "PickupNumber": "sample string 10",
        "Id": 11,
        "Code": "sample string 12",
        "ArName": "sample string 13",
        "EnName": "sample string 14"
      }
    ],
    "Package": [
      {
        "CosumerName": "sample string 1",
        "Mobile": "sample string 2",
        "BuildingNo": "sample string 3",
        "Steert": "sample string 4",
        "Floor": "sample string 5",
        "Apartment": "sample string 6",
        "Latitude": 1.1,
        "Longitude": 1.1,
        "LandMark": "sample string 7",
        "CityArName": "sample string 8",
        "PickupOrderId": 9,
        "PackageCode": "sample string 10",
        "Cost": 11.0,
        "PackageDesc": "sample string 12",
        "Barcode": "sample string 13",
        "NeighborhoodCode": "sample string 14",
        "NeighborhoodEnname": "sample string 15",
        "CityCode": "sample string 16",
        "CityEnName": "sample string 17",
        "NeighborhoodArName": "sample string 18",
        "PieceCount": 19,
        "StatusName": "sample string 20",
        "StatusNameAr": "sample string 21",
        "StatusID": 22,
        "StatusColorCode": "sample string 23",
        "MasterBag": 24,
        "ReferenceNumber": "sample string 25"
      },
      {
        "CosumerName": "sample string 1",
        "Mobile": "sample string 2",
        "BuildingNo": "sample string 3",
        "Steert": "sample string 4",
        "Floor": "sample string 5",
        "Apartment": "sample string 6",
        "Latitude": 1.1,
        "Longitude": 1.1,
        "LandMark": "sample string 7",
        "CityArName": "sample string 8",
        "PickupOrderId": 9,
        "PackageCode": "sample string 10",
        "Cost": 11.0,
        "PackageDesc": "sample string 12",
        "Barcode": "sample string 13",
        "NeighborhoodCode": "sample string 14",
        "NeighborhoodEnname": "sample string 15",
        "CityCode": "sample string 16",
        "CityEnName": "sample string 17",
        "NeighborhoodArName": "sample string 18",
        "PieceCount": 19,
        "StatusName": "sample string 20",
        "StatusNameAr": "sample string 21",
        "StatusID": 22,
        "StatusColorCode": "sample string 23",
        "MasterBag": 24,
        "ReferenceNumber": "sample string 25"
      }
    ]
  },
  "CoreValue": "sample string 1",
  "IsErrorState": true,
  "ErrorDescription": "sample string 3",
  "ErrorMetadata": {}
}

application/xml, text/xml

Sample:

<DescriptiveResponseOfChangeStatusResultDTOrubKl81o xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MYLERZ.Base.Entities">
  <CoreValue>sample string 1</CoreValue>
  <ErrorDescription>sample string 3</ErrorDescription>
  <ErrorMetadata />
  <IsErrorState>true</IsErrorState>
  <Value xmlns:d2p1="http://schemas.datacontract.org/2004/07/MYLERZ.Base.DTO">
    <d2p1:CurrentStatus>
      <d2p1:ArName>sample string 13</d2p1:ArName>
      <d2p1:Code>sample string 12</d2p1:Code>
      <d2p1:EnName>sample string 14</d2p1:EnName>
      <d2p1:Id>11</d2p1:Id>
      <d2p1:AssignMyler>true</d2p1:AssignMyler>
      <d2p1:CallSMSCount>9</d2p1:CallSMSCount>
      <d2p1:ColorCode>sample string 1</d2p1:ColorCode>
      <d2p1:EndOfFlow>true</d2p1:EndOfFlow>
      <d2p1:HasPODCode>true</d2p1:HasPODCode>
      <d2p1:ISDefault>true</d2p1:ISDefault>
      <d2p1:NeedDate>true</d2p1:NeedDate>
      <d2p1:NeedReason>true</d2p1:NeedReason>
      <d2p1:NeedServiceCategory>true</d2p1:NeedServiceCategory>
      <d2p1:PhaseArName>sample string 3</d2p1:PhaseArName>
      <d2p1:PhaseEnName>sample string 2</d2p1:PhaseEnName>
      <d2p1:PhaseID>1</d2p1:PhaseID>
      <d2p1:PickupNumber>sample string 10</d2p1:PickupNumber>
      <d2p1:ReasonCategoryIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:ReasonCategoryIds>
    </d2p1:CurrentStatus>
    <d2p1:NextStatuses>
      <d2p1:StatusDTO>
        <d2p1:ArName>sample string 13</d2p1:ArName>
        <d2p1:Code>sample string 12</d2p1:Code>
        <d2p1:EnName>sample string 14</d2p1:EnName>
        <d2p1:Id>11</d2p1:Id>
        <d2p1:AssignMyler>true</d2p1:AssignMyler>
        <d2p1:CallSMSCount>9</d2p1:CallSMSCount>
        <d2p1:ColorCode>sample string 1</d2p1:ColorCode>
        <d2p1:EndOfFlow>true</d2p1:EndOfFlow>
        <d2p1:HasPODCode>true</d2p1:HasPODCode>
        <d2p1:ISDefault>true</d2p1:ISDefault>
        <d2p1:NeedDate>true</d2p1:NeedDate>
        <d2p1:NeedReason>true</d2p1:NeedReason>
        <d2p1:NeedServiceCategory>true</d2p1:NeedServiceCategory>
        <d2p1:PhaseArName>sample string 3</d2p1:PhaseArName>
        <d2p1:PhaseEnName>sample string 2</d2p1:PhaseEnName>
        <d2p1:PhaseID>1</d2p1:PhaseID>
        <d2p1:PickupNumber>sample string 10</d2p1:PickupNumber>
        <d2p1:ReasonCategoryIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </d2p1:ReasonCategoryIds>
      </d2p1:StatusDTO>
      <d2p1:StatusDTO>
        <d2p1:ArName>sample string 13</d2p1:ArName>
        <d2p1:Code>sample string 12</d2p1:Code>
        <d2p1:EnName>sample string 14</d2p1:EnName>
        <d2p1:Id>11</d2p1:Id>
        <d2p1:AssignMyler>true</d2p1:AssignMyler>
        <d2p1:CallSMSCount>9</d2p1:CallSMSCount>
        <d2p1:ColorCode>sample string 1</d2p1:ColorCode>
        <d2p1:EndOfFlow>true</d2p1:EndOfFlow>
        <d2p1:HasPODCode>true</d2p1:HasPODCode>
        <d2p1:ISDefault>true</d2p1:ISDefault>
        <d2p1:NeedDate>true</d2p1:NeedDate>
        <d2p1:NeedReason>true</d2p1:NeedReason>
        <d2p1:NeedServiceCategory>true</d2p1:NeedServiceCategory>
        <d2p1:PhaseArName>sample string 3</d2p1:PhaseArName>
        <d2p1:PhaseEnName>sample string 2</d2p1:PhaseEnName>
        <d2p1:PhaseID>1</d2p1:PhaseID>
        <d2p1:PickupNumber>sample string 10</d2p1:PickupNumber>
        <d2p1:ReasonCategoryIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </d2p1:ReasonCategoryIds>
      </d2p1:StatusDTO>
    </d2p1:NextStatuses>
    <d2p1:Package xmlns:d3p1="http://schemas.datacontract.org/2004/07/MYLERZ.Base.DTO.MobileDTO">
      <d3p1:MobilePckagesDTO>
        <d3p1:Apartment>sample string 6</d3p1:Apartment>
        <d3p1:Barcode>sample string 13</d3p1:Barcode>
        <d3p1:BuildingNo>sample string 3</d3p1:BuildingNo>
        <d3p1:CityArName>sample string 8</d3p1:CityArName>
        <d3p1:CityCode>sample string 16</d3p1:CityCode>
        <d3p1:CityEnName>sample string 17</d3p1:CityEnName>
        <d3p1:Cost>11</d3p1:Cost>
        <d3p1:CosumerName>sample string 1</d3p1:CosumerName>
        <d3p1:Floor>sample string 5</d3p1:Floor>
        <d3p1:LandMark>sample string 7</d3p1:LandMark>
        <d3p1:Latitude>1.1</d3p1:Latitude>
        <d3p1:Longitude>1.1</d3p1:Longitude>
        <d3p1:MasterBag>24</d3p1:MasterBag>
        <d3p1:Mobile>sample string 2</d3p1:Mobile>
        <d3p1:NeighborhoodArName>sample string 18</d3p1:NeighborhoodArName>
        <d3p1:NeighborhoodCode>sample string 14</d3p1:NeighborhoodCode>
        <d3p1:NeighborhoodEnname>sample string 15</d3p1:NeighborhoodEnname>
        <d3p1:PackageCode>sample string 10</d3p1:PackageCode>
        <d3p1:PackageDesc>sample string 12</d3p1:PackageDesc>
        <d3p1:PickupOrderId>9</d3p1:PickupOrderId>
        <d3p1:PieceCount>19</d3p1:PieceCount>
        <d3p1:ReferenceNumber>sample string 25</d3p1:ReferenceNumber>
        <d3p1:StatusColorCode>sample string 23</d3p1:StatusColorCode>
        <d3p1:StatusID>22</d3p1:StatusID>
        <d3p1:StatusName>sample string 20</d3p1:StatusName>
        <d3p1:StatusNameAr>sample string 21</d3p1:StatusNameAr>
        <d3p1:Steert>sample string 4</d3p1:Steert>
      </d3p1:MobilePckagesDTO>
      <d3p1:MobilePckagesDTO>
        <d3p1:Apartment>sample string 6</d3p1:Apartment>
        <d3p1:Barcode>sample string 13</d3p1:Barcode>
        <d3p1:BuildingNo>sample string 3</d3p1:BuildingNo>
        <d3p1:CityArName>sample string 8</d3p1:CityArName>
        <d3p1:CityCode>sample string 16</d3p1:CityCode>
        <d3p1:CityEnName>sample string 17</d3p1:CityEnName>
        <d3p1:Cost>11</d3p1:Cost>
        <d3p1:CosumerName>sample string 1</d3p1:CosumerName>
        <d3p1:Floor>sample string 5</d3p1:Floor>
        <d3p1:LandMark>sample string 7</d3p1:LandMark>
        <d3p1:Latitude>1.1</d3p1:Latitude>
        <d3p1:Longitude>1.1</d3p1:Longitude>
        <d3p1:MasterBag>24</d3p1:MasterBag>
        <d3p1:Mobile>sample string 2</d3p1:Mobile>
        <d3p1:NeighborhoodArName>sample string 18</d3p1:NeighborhoodArName>
        <d3p1:NeighborhoodCode>sample string 14</d3p1:NeighborhoodCode>
        <d3p1:NeighborhoodEnname>sample string 15</d3p1:NeighborhoodEnname>
        <d3p1:PackageCode>sample string 10</d3p1:PackageCode>
        <d3p1:PackageDesc>sample string 12</d3p1:PackageDesc>
        <d3p1:PickupOrderId>9</d3p1:PickupOrderId>
        <d3p1:PieceCount>19</d3p1:PieceCount>
        <d3p1:ReferenceNumber>sample string 25</d3p1:ReferenceNumber>
        <d3p1:StatusColorCode>sample string 23</d3p1:StatusColorCode>
        <d3p1:StatusID>22</d3p1:StatusID>
        <d3p1:StatusName>sample string 20</d3p1:StatusName>
        <d3p1:StatusNameAr>sample string 21</d3p1:StatusNameAr>
        <d3p1:Steert>sample string 4</d3p1:Steert>
      </d3p1:MobilePckagesDTO>
    </d2p1:Package>
  </Value>
</DescriptiveResponseOfChangeStatusResultDTOrubKl81o>