Upgrade to ChromeUpgrade to FirefoxUpgrade to Internet ExplorerUpgrade to Safari

Order Issues

Create an order issue

Description

Create an order issue

URL

https://api.pwinty.com/v2.2/Orders/{orderId}/Issues

Method

POST

Parameters

  • orderId the id of the order
  • issue the type of issue. One of:
    • DamagedOrder
    • WrongFrameColour
    • IncompleteOrder
    • LostInPost
    • IncorrectOrientation
    • IncorrectPrints
    • PrintDefects
    • SlowArrival
    • SlowDispatch
    • SubmissionErrors
    • WrongAddress
    • Unspecified
  • issueDetail (optional) a textual description of the issue providing additional information where necessary
  • action the required action. One of:
    • Refund
    • Reprint
    • NoAction
    • Other
  • actionDetail (optional) a textual description of the required action providing additional information where necessary
  • affectedImages (optional) a comma separated list or JSON array of the ids of the images affected, where relevant

Returns

{
    "id":"5",
    "issue":"WrongFrameColour",
    "issueDetail":"It wasn't pink!",
    "action":"Reprint",
    "actionDetail":"Needs to be PINK!",
    "orderId":"23",
    "affectedImages":["1","2","3","4","5","6","7"],
    "issueState":"ClosedResolved",
    "commentary":"[13/11/2014 @ 15:09 : Pink I tell you!],[13/11/2014 @ 15:10 : OK, OK, Pink it is then!],[13/11/2014 @ 15:10 : [State change from Open to InProgress]],[13/11/2014 @ 15:11 : [State change from InProgress to ClosedResolved]]"
}

Errors

  • 400 - see the message details for more information
  • 404 - usually an invalid orderId. See the message detail for more information

Gets all the issues for a given order

Description

Gets all the issues for a given order

URL

https://api.pwinty.com/v2.2/Orders/{orderId}/Issues

Method

GET

Parameters

  • orderId the id of the order

Returns

    {
        "Issues":
            [
                {
                    "id":"7",
                    "issue":"DamagedOrder",
                    "issueDescription":"Damaged Order",
                    "issueDetail":"Broken! Noes!",
                    "action":"Reprint",
                    "actionDescription":"Reprint",
                    "actionDetail":"Today!",
                    "orderId":"23",
                    "affectedImages":[],
                    "issueState":"ClosedResolved",
                    "commentary":"[13/11/2014 @ 15:10 - Issue Opened]"
                },
                {
                    "id":"5",
                    "issue":"WrongFrameColour",
                    "issueDetail":"It wasn't pink!",
                    "action":"Reprint",
                    "actionDetail":"Needs to be PINK!",
                    "orderId":"23",
                    "affectedImages":["1","2","3","4","5","6","7"],
                    "issueState":"ClosedResolved",
                    "commentary":"[13/11/2014 @ 15:09 : Pink I tell you!],[13/11/2014 @ 15:10 : OK, OK, Pink it is then!],[13/11/2014 @ 15:10 : [State change from Open to InProgress]],[13/11/2014 @ 15:11 : [State change from InProgress to ClosedResolved]]"
                } 
            ]
    }

Errors

  • 404 - the order with the specified orderId was not found

Gets issue details for a given order issue

Description

Gets issue details for a given order issue

URL

https://api.pwinty.com/v2.2/Orders/{orderId}/Issues/{issueId}

Method

GET

Parameters

  • orderId the id of the order to which the issue relates
  • issueId the id of the issue

Returns

{
    "id":"5",
    "issue":"WrongFrameColour",
    "issueDetail":"It wasn't pink!",
    "action":"Reprint",
    "actionDetail":"Needs to be PINK!",
    "orderId":"23",
    "affectedImages":["1","2","3","4","5","6","7"],
    "issueState":"ClosedResolved",
    "commentary":"[13/11/2014 @ 15:09 : Pink I tell you!],[13/11/2014 @ 15:10 : OK, OK, Pink it is then!],[13/11/2014 @ 15:10 : [State change from Open to InProgress]],[13/11/2014 @ 15:11 : [State change from InProgress to ClosedResolved]]"
}

Errors

  • 400 - The issue isn't related to the order with the supplied orderId
  • 404 - The issue with the specified issueId was not found

Update an issue against an order

Description

Allows comments to be appended to an issue and allows a merchant to cancel an issue

URL

https://api.pwinty.com/v2.2/Orders/{orderId}/Issues/{issueId}

Method

PUT

Parameters

  • issueId the id of the issue
  • newState (optional) the new state for the issue. Only cancelled is supported at this time. Cancelled
  • comment (optional) an comment. This will be appended to the issue's comments

Returns

{
    "id":"5",
    "issue":"WrongFrameColour",
    "issueDetail":"It wasn't pink!",
    "action":"Reprint",
    "actionDetail":"Needs to be PINK!",
    "orderId":"23",
    "affectedImages":["1","2","3","4","5","6","7"],
    "issueState":"ClosedResolved",
    "commentary":"[13/11/2014 @ 15:09 : Pink I tell you!],[13/11/2014 @ 15:10 : OK, OK, Pink it is then!],[13/11/2014 @ 15:10 : [State change from Open to InProgress]],[13/11/2014 @ 15:11 : [State change from InProgress to ClosedResolved]]"
} 

Errors

  • 400 - attempting to set the issue state to be the same as the current state
  • 404 - the issue with the specified issueId was not found